webadmin::ActiveConnections Interface Reference

Public Member Functions
void	get (out ActiveConnectionList list, out long totalItems, in kerio::web::SearchQuery query, in boolean refresh, in kerio::web::KId hostId)
void	kill (in kerio::web::KIdList ids)

Member Function Documentation

void webadmin::ActiveConnections::get	(	out ActiveConnectionList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query,
		in boolean	refresh,
		in kerio::web::KId	hostId
	)

Returns Active Connections data

Parameters

list	- output data
totalItems	- all data count
query	- filter/sort query Hide local connections is solved as: operandValue = 'direction' isColumnName = true comparator = NotEq operandValue = ConnectionDirectionLocal isColumnName = false
refresh	- true in case, that data snapshot have to be refreshed
hostId	- return data only for this host id

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::ActiveConnections::kill

(

in kerio::web::KIdList

ids

)

Kills connections specified in ids list

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:

• ActiveConnections.idl