ProductInfo.idl

Go to the documentation of this file.

/**
 * @file     ProductInfo.idl
 * @brief    API for obtaining information about product version, registration, etc.
 * @version  2
 */

#import <kerio/web/idl/SharedStructures.idl>
#import <common.idl>

module webadmin {
 
enum WarningType {
  WarnBetaVersion,
  WarnUpdateFailed,
  WarnConfigurationReverted
};

typedef sequence<WarningType> WarningTypeList;

struct WarningInfo {
  WarningType type;
  boolean suppressable;
  string property;
};

typedef sequence<WarningInfo> WarningInfoList;

const string tinyBox1 = "HWANG100";
const string smallBox1 = "HWA1000";
const string smallBox2 = "HWA1120";
const string smallBox3 = "HWANG300";
const string bigBox1 =   "HWA3000";
const string bigBox2 =   "HWA3120";
const string bigBox3 =   "HWA3130";
const string bigBox4 =   "HWANG500";

struct ProductInformation {
   string versionString;
   string osDescription;
   boolean finalVersion; 
   string boxEdition;
   string boxName;
   boolean wifiAvailable;
   boolean ip6Available;
   boolean licenseSet;
   boolean passwordSet;
   boolean clientStatisticsSet;
   boolean centralManagementSet;
};

struct StatisticsData {
  long screenWidth;
  long screenHeight;
  string localization;
  long loadTime;
  long initTime;
};

enum ApiEntity {
  PolicyWizard,
  AlertList
};

interface ProductInfo {
   
   /**
    * gets url of Acknowledgments file
    * @param url - requested url
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation."
    */
   void getAcknowledgmentsUrl(out string url);

   /**
    * Returns information about product
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation."
    */   
   void get(out ProductInformation productInfo);
   
   /**
    * gets warning list
    * @param warnings - list of warnings
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation."
    */
   void getWarnings(out WarningInfoList warnings);
   
   /**
    * disables given warning
    * @param type - type of warning to disable
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1000  Operation failed. - "Unable to disable the warning!" \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation."
    */
   void disableWarning(in WarningType type);
   
   /**
    * returns WinRoute server name
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation."
    */
   void getSystemHostname(out string hostname);

   /**
    * performs configuration update
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation."
    */
   void configUpdate();
   
   /**
    * Handles license import
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1000  Operation failed. - errors during license parsing \n
    *          1002  No such entity.   - "Uploaded file does not exist." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation."
    */
   void uploadLicense(in string fileId);
   
   /**
    * Accepts unregistered trial license in engine and causes, \n
    * that engine will not launch activation wizard in case of unregistered trial anymore
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation."
    */
   void acceptUnregisteredTrial();

   /**
    * Generates support info file and returns url for download
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1000  Operation failed. - "Unable to create the file with information for technical support." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation."
    */
   void getSupportInfo(out kerio::web::Download fileDownload);

   /**
    * Returns settings of Client statistics (Enabled/Disabled)
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation."
    */
   void getClientStatistics(out boolean setting);

   /**
    * Stores settings of Client statistics (Enabled/Disabled) and sets ProductInformation::clientStatisticsSet to true (returned by get)
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation."
    */
   void setClientStatistics(in boolean setting);
   
   /**
    * Stores voluntary statistics obtained on clinet side by javascript.
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation."
    */
   void setStatisticsData(in StatisticsData data);

   /**
    * Returns engine uptime in seconds
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation."
    */
   void getUptime(out long uptime);

   /**
    * Returns number of used devices and accounts
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation."
    */
   void getUsedDevicesCount(out long devices, out long accounts);

   /**
    * Accounts usage of ApiEntity for voluntary statistics
    * @param apiEntity - which entity was used
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation."
    */
   void accountUsage(in ApiEntity apiEntity);
};

}; //webadmin