kerio::jsonapi::admin::Server Interface Reference

Public Member Functions
void	createPath (out DirectoryAccessResult result, in string path, in Credentials credentials)
void	findEntityByEmail (out EntityDuplicateList entities, in kerio::web::StringList addresses, in EntityDetail updatedEntity, in kerio::web::KId domainId)
void	generateSupportInfo (out kerio::web::Download fileDownload)
void	getAboutInfo (out AboutInfo aboutInformation)
void	getAlertList (out AlertList alerts)
void	getBrowserLanguages (out kerio::web::StringList calculatedLanguage)
void	getClientStatistics (out boolean isEnabled)
void	getColumnList (out kerio::web::StringList columns, in string objectName, in string methodName)
void	getConnections (out ConnectionList list, out long totalItems, in kerio::web::SearchQuery query)
void	getDirs (out DirectoryList dirList, in string fullPath)
void	getLicenseExtensionsList (out kerio::web::StringList extensions)
void	getNamedConstantList (out NamedConstantList constants)
void	getOpenedFoldersInfo (out FolderInfoList list, out long totalItems, in kerio::web::SearchQuery query)
void	getProductInfo (out ProductInfo info)
void	getRemoteAdministration (out Administration setting)
void	getServerHash (out string serverHash)
void	getServerIpAddresses (out kerio::web::StringList addresses)
void	getServerTime (out ServerTimeInfo info)
void	getVersion (out string product, out string version, out long major, out long minor, out long revision, out long build)
void	getWebSessions (out WebSessionList list, out long totalItems, in kerio::web::SearchQuery query)
void	killWebSessions (in kerio::web::KIdList ids)
void	pathExists (out DirectoryAccessResult result, in string path, in Credentials credentials)
void	reboot ()
void	restart ()
void	upgrade ()
void	getDownloadProgress (out long progress)
void	sendBugReport (in string name, in string email, in string language, in string subject, in string description)
void	setClientStatistics (in boolean isEnabled)
void	setRemoteAdministration (in Administration setting)
void	uploadLicense (in string fileId)
void	validateRemoteAdministration (in Administration setting)
void	isBritishPreferred (out boolean preferred)

Member Function Documentation

void kerio::jsonapi::admin::Server::createPath	(	out DirectoryAccessResult	result,
		in string	path,
		in Credentials	credentials
	)

Server creates an archive/backup path. If credentials aren't specified, values from current configuration of backup are used.

Parameters

result	- result of create action
path	- new directory to create
credentials	- (optional) user name and password required to access network disk

void kerio::jsonapi::admin::Server::findEntityByEmail	(	out EntityDuplicateList	entities,
		in kerio::web::StringList	addresses,
		in EntityDetail	updatedEntity,
		in kerio::web::KId	domainId
	)

Find emails duplicate among entities in this order: resources, aliases, mailing lists, groups, users; caller must be authenticated; Note: creating duplicates is often allowed but may cause unwanted effects.

Parameters

entities	- list of found entities with e-mail address duplicate 'updatedEntity' is included in list and marked, if none duplicate is found list is empty
addresses	- list of email addresses (without domain) to be checked
updatedEntity	- identification of the current entity (to avoid self duplicity)
domainId	- domain identification

void kerio::jsonapi::admin::Server::generateSupportInfo

(

out kerio::web::Download

fileDownload

)

Generate a file with information for the support.

Parameters

fileDownload

- description of output file

void kerio::jsonapi::admin::Server::getAboutInfo

(

out AboutInfo

aboutInformation

)

Obtain information about server, caller must be authenticated.

Parameters

aboutInformation

- information about server

void kerio::jsonapi::admin::Server::getAlertList

(

out AlertList

alerts

)

Obtain a list of alerts.

Parameters

alerts

- list of alerts

void kerio::jsonapi::admin::Server::getBrowserLanguages

(

out kerio::web::StringList

calculatedLanguage

)

Returns a list of user-preferred languages set in browser.

Parameters

calculatedLanguage

- a list of 2-character language codes

void kerio::jsonapi::admin::Server::getClientStatistics

(

out boolean

isEnabled

)

Obtain client statistics settings.

Parameters

setting

- new settings

void kerio::jsonapi::admin::Server::getColumnList	(	out kerio::web::StringList	columns,
		in string	objectName,
		in string	methodName
	)

Obtain a list of columns dependent on callee role.

Parameters

columns	- list of available columns
objectName	- name of the API object
methodName	- name of the method of appropriate object

void kerio::jsonapi::admin::Server::getConnections	(	out ConnectionList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query
	)

Obtain information about active connections.

Parameters

list	- active connections
totalItems	- total number of active connections
query	- condition and fields have no effect for this method

void kerio::jsonapi::admin::Server::getDirs	(	out DirectoryList	dirList,
		in string	fullPath
	)

Obtain a list of directories in a particular path.

Parameters

dirList	- List of directories
fullPath	- directory for listing, if full path is empty logical drives will be listed

void kerio::jsonapi::admin::Server::getDownloadProgress

(

out long

progress

)

Get progress of installation package downloading

Parameters

@param

progress - download progress in percents (0-100)

void kerio::jsonapi::admin::Server::getLicenseExtensionsList

(

out kerio::web::StringList

extensions

)

Obtain list of license extensions, caller must be authenticated.

Parameters

extensions

- list of license extensions

void kerio::jsonapi::admin::Server::getNamedConstantList

(

out NamedConstantList

constants

)

Server side list of constants.

Parameters

constants

- list of constants

void kerio::jsonapi::admin::Server::getOpenedFoldersInfo	(	out FolderInfoList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query
	)

Obtain information about folders opened on server.

Parameters

list	- opened folders with info
totalItems	- total number of opened folders
query	- condition and fields have no effect for this method

void kerio::jsonapi::admin::Server::getProductInfo

(

out ProductInfo

info

)

Get basic information about product and its version.

Parameters

info	- structure with basic information about product

void kerio::jsonapi::admin::Server::getRemoteAdministration

(

out Administration

setting

)

Obtain information about remote administration settings.

Parameters

setting

- current settings

void kerio::jsonapi::admin::Server::getServerHash

(

out string

serverHash

)

Obtain a hash string created from product name, version, and installation time.

Parameters

serverHash

- server hash

void kerio::jsonapi::admin::Server::getServerIpAddresses

(

out kerio::web::StringList

addresses

)

List all server IP addresses.

Parameters

addresses

- all IP addresses of the server

void kerio::jsonapi::admin::Server::getServerTime

(

out ServerTimeInfo

info

)

Get server time information.

Parameters

info	- structure with time information

void kerio::jsonapi::admin::Server::getVersion	(	out string	product,
		out string	version,
		out long	major,
		out long	minor,
		out long	revision,
		out long	build
	)

Obtain information about server version.

Parameters

product	- name of product
version	- version in string consists of values of major, minor, revision, build a dot separated
major	- major version
minor	- minor version
revision	- revision number
build	- build number

void kerio::jsonapi::admin::Server::getWebSessions	(	out WebSessionList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query
	)

Obtain information about web component sessions.

Parameters

list	- web component sessions
totalItems	- total number of web component sessions
query	- condition and fields have no effect for this method

void kerio::jsonapi::admin::Server::isBritishPreferred

(

out boolean

preferred

)

Determine whether to use British or American flag for English.

Parameters

preferred

- use British flag

void kerio::jsonapi::admin::Server::killWebSessions

(

in kerio::web::KIdList

ids

)

Terminate actual web sessions.

Parameters

ids	- list of web sessions IDs to terminate

void kerio::jsonapi::admin::Server::pathExists	(	out DirectoryAccessResult	result,
		in string	path,
		in Credentials	credentials
	)

Check if the selected path exists and is accessible from the server.

Parameters

path	- directory name
credentials	- (optional) user name and password required to access network disk
result	- result of check

void kerio::jsonapi::admin::Server::reboot

(

)

Reboot the host system.

void kerio::jsonapi::admin::Server::restart

(

)

Restart server. The server must run as service.

void kerio::jsonapi::admin::Server::sendBugReport	(	in string	name,
		in string	email,
		in string	language,
		in string	subject,
		in string	description
	)

Send a bug report to Kerio.

Parameters

name	- name of sender
email	- email of sender
language	- language of report
subject	- summary of report
description	- description of problem

void kerio::jsonapi::admin::Server::setClientStatistics

(

in boolean

isEnabled

)

Set client statistics settings.

Parameters

setting

- new settings

void kerio::jsonapi::admin::Server::setRemoteAdministration

(

in Administration

setting

)

Set new remote administration parameters.

Parameters

setting

- new settings

void kerio::jsonapi::admin::Server::upgrade

(

)

Upgrade server to the latest version. The server must run as service.

void kerio::jsonapi::admin::Server::uploadLicense

(

in string

fileId

)

Upload license manually from a file.

Parameters

fileId

- ID of the uploaded file

void kerio::jsonapi::admin::Server::validateRemoteAdministration

(

in Administration

setting

)

Validate whether the administrator can cut off him/herself from the administration.

Parameters

setting

- new setting

---

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

• Server.idl