kerio::jsonapi::admin::Resources Interface Reference

import "Resources.idl";

Public Member Functions
void	create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in ResourceList resources)
void	get (out ResourceList list, out long totalItems, in kerio::web::SearchQuery query, in kerio::web::KId domainId)
void	getPrincipalList (out PrincipalList list, out long totalItems, in kerio::web::SearchQuery query, in kerio::web::KId domainId)
void	remove (out kerio::web::ErrorList errors, in kerio::web::KIdList resourceIds)
void	set (out kerio::web::ErrorList errors, in kerio::web::KIdList resourceIds, in Resource pattern)

Detailed Description

Resource management

Member Function Documentation

void kerio::jsonapi::admin::Resources::create	(	out kerio::web::ErrorList	errors,
		out kerio::web::CreateResultList	result,
		in ResourceList	resources
	)

Create new resources.

Parameters

errors	- error message list
result	- list of IDs of created resources
resources	- new resource entities

void kerio::jsonapi::admin::Resources::get	(	out ResourceList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query,
		in kerio::web::KId	domainId
	)

Obtain a list of resources.

Parameters

list	- resources
totalItems	- amount of resources for given search condition, useful when limit is defined in search query
query	- query conditions and limits
domainId	- domain identification

void kerio::jsonapi::admin::Resources::getPrincipalList	(	out PrincipalList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query,
		in kerio::web::KId	domainId
	)

Obtain a list of potential resource targets (principals).

Parameters

list	- principals
query	- query attributes and limits
domain	- domain restriction

void kerio::jsonapi::admin::Resources::remove	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	resourceIds
	)

Remove resources.

Parameters

errors	- error message list
resourceIds	- list of global identifiers of recource(s) to be deleted

void kerio::jsonapi::admin::Resources::set	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	resourceIds,
		in Resource	pattern
	)

Set existing resources.

Parameters

errors	- error message list
resourceIds	- a list resource global identifier(s)
pattern	- pattern to use for new values

---

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

• Resources.idl