All Classes Files Functions Variables Pages
Public Member Functions | List of all members
webadmin::DynamicDns Interface Reference

Public Member Functions

void get (out DynamicDnsConfig config)
 
void set (in DynamicDnsConfig config)
 
void update ()
 
void getStatus (out kerio::web::LocalizableMessage message, out DynamicDnsStatus status)
 
void getProviders (out kerio::web::StringList providers)
 

Member Function Documentation

void webadmin::DynamicDns::get ( out DynamicDnsConfig  config)

Returns DynDNS configuration

Parameters
config- configuration values
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::DynamicDns::getProviders ( out kerio::web::StringList  providers)

Returns list of supported providers

Parameters
providers- return values
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::DynamicDns::getStatus ( out kerio::web::LocalizableMessage  message,
out DynamicDnsStatus  status 
)

Returns status of DynDNS update

Parameters
message- list of errors
1000 Operation failed. - "Dynamic DNS server reported error: %1." (DynamicDnsError)
1000 Operation failed. - "Connection to the dynamic DNS server failed." (DynamicDnsError)
1000 Operation failed. - "The update is already in progress" (DynamicDnsUpdate)
1000 Operation failed. - "Current settings have not been applied yet" (DynamicDnsUpdate)
1000 Operation failed. - "Detection of IP address failed." (DynamicDnsError)
1000 Operation failed. - "IP address cannot be loaded from the interface." (DynamicDnsError)
status- actual status of DynDNS 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::DynamicDns::set ( in DynamicDnsConfig  config)

Stores DynDNS configuration

Parameters
config- configuration values
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::DynamicDns::update ( )

Performs synchronous DynDNS update

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
The documentation for this interface was generated from the following file: