CentralManagement.idl

Go to the documentation of this file.

/**
 * @file      CentralManagement.idl 
 * @brief     Central management API
 * @version   2
 */

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

module webadmin {

struct CentralManagementConfig {
   boolean enabled;
   string appUrl;
};

struct CentralManagementStatus {
   boolean connected;
   boolean paired;
   kerio::web::OptionalString url;
};

interface CentralManagement {
   /**
    * Returns configuration
    * @param config - Contains Structure with Central management settings.
    * @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 CentralManagementConfig config);
   
   /**
    * Stores configuration
    * @param config - Contains Structure with Central management settings.
    * @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 set(in CentralManagementConfig config);

   /**
    * Returns actual state of Central management
    * @param status - actual state of Central management.
    * @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 getStatus(out CentralManagementStatus status);

   /**
    * Runs reset
    * @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 reset();
};

}; // webadmin