DynamicDns.idl

Go to the documentation of this file.

/**
 * @file     DynamicDns.idl
 * @brief    API for Dynamic Dns
 * @version  5
 */

#import <common.idl>

module webadmin {

enum DynamicDnsStatus {
   DynamicDnsOk,
   DynamicDnsError,
   DynamicDnsUpdate
};

enum DynamicDnsAddressType {
   DynamicDnsAdressIface,
   DynamicDnsAdressDetect,
   DynamicDnsAdressCustom
};

struct DynamicDnsConfig {
   boolean enabled;
   string provider; /**< call getProviders for list of supported providers */
   string hostname;
   CredentialsConfig credentials;
   DynamicDnsAddressType addressType;
   IdReference customIface;   
};

interface DynamicDns {

   /**
    * Returns DynDNS configuration
    *
    * @param  config - configuration values
    * @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 DynamicDnsConfig config);

   /**
    * Stores DynDNS configuration
    *
    * @param  config - configuration values
    * @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 DynamicDnsConfig config);

   /**
    * Performs synchronous DynDNS 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 update();

   /**
    * Returns status of DynDNS update
    *
    * @param  message - list of errors \n
    *          1000  Operation failed.   - "Dynamic DNS server reported error: %1."    (DynamicDnsError) \n
    *          1000  Operation failed.   - "Connection to the dynamic DNS server failed." (DynamicDnsError) \n
    *          1000  Operation failed.   - "The update is already in progress"            (DynamicDnsUpdate) \n
    *          1000  Operation failed.   - "Current settings have not been applied yet"   (DynamicDnsUpdate) \n
    *          1000  Operation failed.   - "Detection of IP address failed."        (DynamicDnsError) \n
    *          1000  Operation failed.   - "IP address cannot be loaded from the interface." (DynamicDnsError)
    * @param  status - actual status of DynDNS 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 getStatus(out kerio::web::LocalizableMessage message, out DynamicDnsStatus status);

   /**
    * Returns list of supported providers
    *
    * @param  providers - return values
    * @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 getProviders(out kerio::web::StringList providers);
};

}; //webadmin