kerio::jsonapi::webmail::contacts::Contacts Interface Reference

import "Contacts.idl";

Public Member Functions
void	copy (out kerio::web::ErrorList errors, out CreateResultList result, in kerio::web::KIdList ids, in kerio::web::KId folder)
void	create (out kerio::web::ErrorList errors, out CreateResultList result, in ContactList contacts)
void	get (out ContactList list, out long totalItems, in kerio::web::KIdList folderIds, in kerio::web::SearchQuery query)
void	getFromCache (out ContactList list, out long totalItems, in kerio::web::KIdList folderIds, in kerio::web::SearchQuery query)
void	getById (out kerio::web::ErrorList errors, out ContactList result, in kerio::web::KIdList ids)
void	getByIdFromCache (out kerio::web::ErrorList errors, out ContactList result, in kerio::web::KIdList ids)
void	getFromAttachment (out Contact result, in kerio::web::KId id)
void	getResources (out ResourceList list, out long totalItems, in kerio::web::SearchQuery query)
void	getCertificate (out kerio::jsonapi::webmail::certificates::Certificate cert, in string email, in kerio::web::KId id)
void	remove (out kerio::web::ErrorList errors, in kerio::web::KIdList ids)
void	set (out kerio::web::ErrorList errors, out SetResultList result, in ContactList contacts)
void	move (out kerio::web::ErrorList errors, out CreateResultList result, in kerio::web::KIdList ids, in kerio::web::KId folder)
void	getPersonal (out kerio::jsonapi::contacts::PersonalContact contact)
void	setPersonal (in kerio::jsonapi::contacts::PersonalContact contact)

Detailed Description

Contacts management.

Member Function Documentation

void kerio::jsonapi::webmail::contacts::Contacts::copy	(	out kerio::web::ErrorList	errors,
		out CreateResultList	result,
		in kerio::web::KIdList	ids,
		in kerio::web::KId	folder
	)

Copy existing contacts to folder

Parameters

errors	- error message list
ids	- list of global identifiers of contacts to be copied
folder	- target folder

void kerio::jsonapi::webmail::contacts::Contacts::create	(	out kerio::web::ErrorList	errors,
		out CreateResultList	result,
		in ContactList	contacts
	)

Create contact in particular folder

Parameters

errors	- error message list
result	- list of ID of crated contacts
contacts	- new contacts; Field 'folderId' must be set.

void kerio::jsonapi::webmail::contacts::Contacts::get	(	out ContactList	list,
		out long	totalItems,
		in kerio::web::KIdList	folderIds,
		in kerio::web::SearchQuery	query
	)

Get a list of contacts.

Parameters

list	- all found contacts
totalItems	- number of contacts found if there is no limit
folderIds	- list of global identifiers of folders to be listed.
query	- query attributes and limits

void kerio::jsonapi::webmail::contacts::Contacts::getById	(	out kerio::web::ErrorList	errors,
		out ContactList	result,
		in kerio::web::KIdList	ids
	)

Get particular contacts. All members of struct Contact are filed in response.

Parameters

errors	- list of errors which happened
result	- contacts of given IDs. All members of struct are returned.
ids	- global identifiers of contact.

void kerio::jsonapi::webmail::contacts::Contacts::getByIdFromCache	(	out kerio::web::ErrorList	errors,
		out ContactList	result,
		in kerio::web::KIdList	ids
	)

Get particular contacts. These members of struct Contact are filed in response: id, folderId, watermark, type, commonName, titleAfter, titleBefore, firstName, middleName, surName, nickName, emailAddresses, phoneNumbers, photo

Parameters

errors	- list of errors which happened
result	- contacts of given IDs.
ids	- global identifiers of contact.

void kerio::jsonapi::webmail::contacts::Contacts::getCertificate	(	out kerio::jsonapi::webmail::certificates::Certificate	cert,
		in string	email,
		in kerio::web::KId	id
	)

Get a certificate for given email address.

Parameters

cert	- found certificate
email	- email address of requested certificate
id	- global identifier of contacts to be searched

void kerio::jsonapi::webmail::contacts::Contacts::getFromAttachment	(	out Contact	result,
		in kerio::web::KId	id
	)

Get contact from attachment.

Parameters

result	- contact of given IDs. All members of struct are returned.
id	- global identifiers of mail attachment.

void kerio::jsonapi::webmail::contacts::Contacts::getFromCache	(	out ContactList	list,
		out long	totalItems,
		in kerio::web::KIdList	folderIds,
		in kerio::web::SearchQuery	query
	)

Get a list of contacts. It works the same way as Contacts.get but retuns only this fields: id, folderId, watermark, type, commonName, titleAfter, titleBefore, firstName, middleName, surName, nickName, emailAddresses, phoneNumbers, photo

Parameters

list	- all found contacts
totalItems	- number of contacts found if there is no limit
folderIds	- list of global identifiers of folders to be listed.
query	- query attributes and limits

void kerio::jsonapi::webmail::contacts::Contacts::getPersonal

(

out kerio::jsonapi::contacts::PersonalContact

contact

)

Get personal user contact

void kerio::jsonapi::webmail::contacts::Contacts::getResources	(	out ResourceList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query
	)

Get a list of resources that an user can schedule.

Parameters

list	- all found resources
totalItems	- number of resources found if there is no limit
query	- query attributes and limits (empty query obtain all resources)

void kerio::jsonapi::webmail::contacts::Contacts::move	(	out kerio::web::ErrorList	errors,
		out CreateResultList	result,
		in kerio::web::KIdList	ids,
		in kerio::web::KId	folder
	)

Move existing contacts to folder

Parameters

errors	- error message list
ids	- list of global identifiers of contacts to be moved
folder	- target folder

void kerio::jsonapi::webmail::contacts::Contacts::remove	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	ids
	)

Remove a list of contacts.

Parameters

errors	- list of contacts that failed to remove
ids	- list of global identifiers of contacts to be removed

void kerio::jsonapi::webmail::contacts::Contacts::set	(	out kerio::web::ErrorList	errors,
		out SetResultList	result,
		in ContactList	contacts
	)

Set existing contacts.

Parameters

errors	- error message list
contacts	- modifications of contacts. Field 'folderId' must be set.

void kerio::jsonapi::webmail::contacts::Contacts::setPersonal

(

in kerio::jsonapi::contacts::PersonalContact

contact

)

Set personal user contact

---

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

• Contacts.idl