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

Public Member Functions

void get (out SystemConfiguration config)
 
void set (in SystemConfiguration config)
 
void getTimeZones (out TimeZoneConfigList timeZones, in kerio::web::Date currentDate)
 
void getDateTime (out DateTimeConfig config)
 
void setDateTime (in DateTimeConfig config)
 
void setTimeFromNtp ()
 
void getNtpStatus (out NtpUpdateStatus status)
 

Member Function Documentation

void webadmin::SystemConfig::get ( out SystemConfiguration  config)
Parameters
config- Returns actual values for System configuration in WebAdmin
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::SystemConfig::getDateTime ( out DateTimeConfig  config)
Parameters
config- Returns Date and Time for System configuration.
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::SystemConfig::getNtpStatus ( out NtpUpdateStatus  status)
Parameters
status- Returns Status of NTP client process.
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::SystemConfig::getTimeZones ( out TimeZoneConfigList  timeZones,
in kerio::web::Date  currentDate 
)
Parameters
timeZones- Returns the list of known timezones.
currentDate- Client actual time to serve as an input for timezone and DST detection.
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::SystemConfig::set ( in SystemConfiguration  config)

Stores System configuration

Parameters
config- contains system setting to be stored.
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::SystemConfig::setDateTime ( in DateTimeConfig  config)

Stores Date and Time for System configuration.

Parameters
config- structure of system date and time settings
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1000 Operation failed. - "Error occurred while changing system date and time."
1004 Access denied. - "Insufficient rights to perform the requested operation."
8000 Internal error. - "Internal error."
void webadmin::SystemConfig::setTimeFromNtp ( )

Starts NTP client based on configured values.
If status == NtpUpdateProgress, process is restarted

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: