webadmin::UrlGroups Interface Reference

Public Member Functions
void	get (out UrlEntryList list, out long totalItems, in kerio::web::SearchQuery query)
void	create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in UrlEntryList groups)
void	set (out kerio::web::ErrorList errors, in kerio::web::StringList groupIds, in UrlEntry details)
void	remove (out kerio::web::ErrorList errors, in kerio::web::StringList groupIds)
void	apply (out kerio::web::ErrorList errors)
void	reset ()
void	getGroupList (out UrlGroupList groups)

Member Function Documentation

void webadmin::UrlGroups::apply

(

out kerio::web::ErrorList

errors

)

write changes cached in manager to configuration

Parameters

errors

- list of errors 8001 Invalid params. - "Unable to add/modify URL group %1, wrong parameters." 8002 Database error. - "Unable to add/modify URL group %1." 8002 Database error. - "Unable to delete URL group."

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::UrlGroups::create	(	out kerio::web::ErrorList	errors,
		out kerio::web::CreateResultList	result,
		in UrlEntryList	groups
	)

add new groups

Parameters

errors	- list of errors 1001 Already exists. - "The URL group already exists."
result	- list of IDs assigned to each item
groups	- details for new groups. field id is assigned by the manager to temporary value until apply() or reset().

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::UrlGroups::get	(	out UrlEntryList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query
	)

get the list of Url groups

Parameters

list	- list of groups and it's details
totalItems	- count of all groups on server (before the start/limit applied)
query	- conditions and limits. Included from weblib. Kerio Control engine implementation notes: LIKE matches substring (second argument) in a string (first argument). There are no wildcards. sort and match are case insensitive. column alias (first operand): TODO: "QUICKSEARCH" - requested operator applied as following: (name operator secondOperand ) || (description operator secondOperand)

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::UrlGroups::getGroupList

(

out UrlGroupList

groups

)

get the list of groups, sorted in asc order

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::UrlGroups::remove	(	out kerio::web::ErrorList	errors,
		in kerio::web::StringList	groupIds
	)

remove groups

Parameters

errors	- list of errors TODO write particular errors
groupIds	- ids of groups that should be removed

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::UrlGroups::reset

(

)

discard changes cached in manager

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::UrlGroups::set	(	out kerio::web::ErrorList	errors,
		in kerio::web::StringList	groupIds,
		in UrlEntry	details
	)

update existing groups

Parameters

errors	- list of errors 1001 Already exists. - "The URL group already exists."
groupIds	- ids of groups to be updated.
details	- details for update. Field "kerio::web::KId" is ignored. All other fields must be filled and they are written to all groups specified by groupIds.

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:

• UrlGroups.idl