SharedDefinitions.idl

Go to the documentation of this file.

/**
 * @file     SharedDefinitions.idl
 * @brief    API for definitions shared with MyKerio
 * @version  1
 */
module webadmin {

/**
 * @brief enumerate types of definitions shared between MyKerio and your appliance
 */
enum SharedDefinitionType {
   SharedDefinitionIpAddrGroup,
   SharedDefinitionUrlGroup,
   SharedDefinitionTimeRange
};

/**
 * @brief bind shared definition type with version
 */
struct SharedDefinitionInfo {
   SharedDefinitionType type;
   long version;
};

typedef sequence<SharedDefinitionInfo> SharedDefinitionInfoList;  ///< list of shared definition info

/**
 * @brief MyKerio-appliance interface to handle shared definitions
 */
interface SharedDefinitions {

   /**
    * @return appliance report to MyKerio what shared definitions it support and what versions of shared definitions are stored in appliance
    */
   void getVersions(out SharedDefinitionInfoList list);
   
   /**
    * @param list MyKerio recently updated shared definitions and here it provide new versions. Please, remember that versions in your appliance for further use
    */
   void setVersions(in SharedDefinitionInfoList list);
};

};