All Classes Files Functions Variables Pages
webadmin::ProductInfo Interface Reference

Public Member Functions

void getAcknowledgmentsUrl (out string url)
 
void get (out ProductInformation productInfo)
 
void getWarnings (out WarningInfoList warnings)
 
void disableWarning (in WarningType type)
 
void getSystemHostname (out string hostname)
 
void configUpdate ()
 
void uploadLicense (in string fileId)
 
void acceptUnregisteredTrial ()
 
void getSupportInfo (out kerio::web::Download fileDownload)
 
void getClientStatistics (out boolean setting)
 
void setClientStatistics (in boolean setting)
 
void setStatisticsData (in StatisticsData data)
 
void getUptime (out long uptime)
 
void getUsedDevicesCount (out long devices, out long accounts)
 
void accountUsage (in ApiEntity apiEntity)
 

Member Function Documentation

void webadmin::ProductInfo::acceptUnregisteredTrial ( )

Accepts unregistered trial license in engine and causes,
that engine will not launch activation wizard in case of unregistered trial anymore

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::ProductInfo::accountUsage ( in ApiEntity  apiEntity)

Accounts usage of ApiEntity for voluntary statistics

Parameters
apiEntity- which entity was used
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::ProductInfo::configUpdate ( )

performs configuration update

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::ProductInfo::disableWarning ( in WarningType  type)

disables given warning

Parameters
type- type of warning to disable
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1000 Operation failed. - "Unable to disable the warning!"
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::ProductInfo::get ( out ProductInformation  productInfo)

Returns information about product

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::ProductInfo::getAcknowledgmentsUrl ( out string  url)

gets url of Acknowledgments file

Parameters
url- requested url
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::ProductInfo::getClientStatistics ( out boolean  setting)

Returns settings of Client statistics (Enabled/Disabled)

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::ProductInfo::getSupportInfo ( out kerio::web::Download  fileDownload)

Generates support info file and returns url for download

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1000 Operation failed. - "Unable to create the file with information for technical support."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::ProductInfo::getSystemHostname ( out string  hostname)

returns WinRoute server name

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::ProductInfo::getUptime ( out long  uptime)

Returns engine uptime in seconds

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::ProductInfo::getUsedDevicesCount ( out long  devices,
out long  accounts 
)

Returns number of used devices and accounts

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::ProductInfo::getWarnings ( out WarningInfoList  warnings)

gets warning list

Parameters
warnings- list of warnings
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::ProductInfo::setClientStatistics ( in boolean  setting)

Stores settings of Client statistics (Enabled/Disabled) and sets ProductInformation::clientStatisticsSet to true (returned by get)

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::ProductInfo::setStatisticsData ( in StatisticsData  data)

Stores voluntary statistics obtained on clinet side by javascript.

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::ProductInfo::uploadLicense ( in string  fileId)

Handles license import

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1000 Operation failed. - errors during license parsing
1002 No such entity. - "Uploaded file does not exist."
1004 Access denied. - "Insufficient rights to perform the requested operation."

The documentation for this interface was generated from the following file: