webadmin::WebInterface Interface Reference

Public Member Functions
void	get (out WebInterfaceConfig config)
void	set (in WebInterfaceConfig config, in long revertTimeout)
void	uploadImage (in string fileId, in boolean isFavicon)
void	reset ()

Member Function Documentation

void webadmin::WebInterface::get

(

out WebInterfaceConfig

config

)

Returns actual values for Web Interface and Kerio Clientless SSL-VPN 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::WebInterface::reset

(

)

discard uploaded images

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::WebInterface::set	(	in WebInterfaceConfig	config,
		in long	revertTimeout
	)

Stores configuration

Parameters

config	- structure with settings for webinterface module
revertTimeout	- If client doesn't confirm config to this timeout, configuration is reverted (0 - revert disabled)

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::WebInterface::uploadImage	(	in string	fileId,
		in boolean	isFavicon
	)

Uploaded image which will need to be apply/reset

Parameters

fileId	- according to spec 390.
isFavicon	- true = the image is favicon, false = the image is product logo

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:

• WebInterface.idl