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

Public Member Functions

void get (out UpdateCheckerConfig config)
 
void set (in UpdateCheckerConfig config)
 
void check (in CheckVersionType type)
 
void getStatus (out UpdateCheckerInfo status)
 
void getProgressStatus (out long percentage)
 
void download (in CheckVersionType type)
 
void uploadImage (out kerio::web::KId id, in string fileId)
 
void performCustomUpgrade (in kerio::web::KId id)
 
void performUpgrade ()
 
void cancelDownload ()
 

Member Function Documentation

void webadmin::UpdateChecker::cancelDownload ( )

Stops Downloading

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
8000 Internal error. - "Internal error."
void webadmin::UpdateChecker::check ( in CheckVersionType  type)

Checks for a new version

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1000 Operation failed. - "No connection available, update disabled or already in progress."
1004 Access denied. - "Insufficient rights to perform the requested operation."
8000 Internal error. - "Internal error."
void webadmin::UpdateChecker::download ( in CheckVersionType  type)

Starts Downloading

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
8000 Internal error. - "Internal error."
void webadmin::UpdateChecker::get ( out UpdateCheckerConfig  config)

Returns configuration

Parameters
config- Contains Structure with update checker's settings.
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::UpdateChecker::getProgressStatus ( out long  percentage)

METHODS ONLY FOR LINUX VERSION

Parameters
percentage- Returns percentage progress for Status Downloading
Stop reading this, when percentage == -1 (DownloadFailed)
or percentage == 100 (DownloadOk)
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::UpdateChecker::getStatus ( out UpdateCheckerInfo  status)

Returns actual state of Update checker

Parameters
status- a phase of update process.
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
8000 Internal error. - "Internal error."
void webadmin::UpdateChecker::performCustomUpgrade ( in kerio::web::KId  id)

Processes newly uploaded image for upgrade. Ids according to spec 390. In case of return true, it reboots machine (after 2s delay)

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1000 Operation failed. - "Unable to perform update: %1"
1002 No such entity. - "Unable to open upgrade image file."
1004 Access denied. - "Insufficient rights to perform the requested operation."
8000 Internal error. - "Internal error."
void webadmin::UpdateChecker::performUpgrade ( )

Runs upgrade In case of return true, it reboots machine (after 2s delay)

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1000 Operation failed. - "Unable to perform update: %1"
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::UpdateChecker::set ( in UpdateCheckerConfig  config)

Stores configuration

Parameters
config- Contains Structure with update checker's settings to be stored &a pplied.
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::UpdateChecker::uploadImage ( out kerio::web::KId  id,
in string  fileId 
)

Converts fileId to id, that will be passed into performCustomUpgrade.

Parameters
id- an id obtained from fileId (same values);
fileId- according to spec 390.
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: