All Classes Files Functions Variables Enumerations Enumerator Groups Pages
kerio::jsonapi::admin::Migration Interface Reference

Public Member Functions

void cancel (out kerio::web::ErrorList errors, in kerio::web::KIdList taskIdList)
void get (out MigrationTaskList list, out long totalItems, in kerio::web::SearchQuery query)
void getCurrentHomeServer (out HomeServer homeServer)
void getCurrentStatus (out kerio::web::KId taskId, out MigrationStatus status)
void getStatus (out MigrationStatus status, in kerio::web::KId taskId)
void isInProgress (out boolean isInProgress)
void start (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in kerio::web::KIdList userIds)

Member Function Documentation

void kerio::jsonapi::admin::Migration::cancel ( out kerio::web::ErrorList  errors,
in kerio::web::KIdList  taskIdList 
)

Cancel planned or running migration tasks.

Parameters
errors- error message list
taskIdList- Identifiers of migration tasks which should be canceled
void kerio::jsonapi::admin::Migration::get ( out MigrationTaskList  list,
out long  totalItems,
in kerio::web::SearchQuery  query 
)

Obtain list of migration tasks.

Parameters
list- migration tasks
totalItems- total number of tasks
query- query attributes and limits
void kerio::jsonapi::admin::Migration::getCurrentHomeServer ( out HomeServer  homeServer)

Return hostname and cluster-id of current server. Server must be part of the cluster, otherwise the result is always false. Note: This method should be moved to DistributedDomain

Parameters
homeServer- homeserver attributes
void kerio::jsonapi::admin::Migration::getCurrentStatus ( out kerio::web::KId  taskId,
out MigrationStatus  status 
)

Obtain status of currently running migration task.

Parameters
taskId- migration task identifier
status- migration task status
void kerio::jsonapi::admin::Migration::getStatus ( out MigrationStatus  status,
in kerio::web::KId  taskId 
)

Obtain status of migration task specified by the task ID.

Parameters
status- migration task status
taskId- migration task identifier
void kerio::jsonapi::admin::Migration::isInProgress ( out boolean  isInProgress)

Return status of migration tasks. Note: This method may fail if caller does not have full admin rights.

Parameters
isInProgress- is there any migration task running?
void kerio::jsonapi::admin::Migration::start ( out kerio::web::ErrorList  errors,
out kerio::web::CreateResultList  result,
in kerio::web::KIdList  userIds 
)

Start a new migration task.

Parameters
errors- error message list
result
userIds- users to be migrated

The documentation for this interface was generated from the following file: