import "CompanyContacts.idl";
Public Member Functions |
void | create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in CompanyContactList companyContacts) |
void | get (out CompanyContactList list, out long totalItems, in kerio::web::SearchQuery query) |
void | getAvailable (out CompanyContactList companyContactList, in kerio::web::KId domainId) |
void | remove (out kerio::web::ErrorList errors, in kerio::web::KIdList companyContactsIds) |
void | set (out kerio::web::ErrorList errors, in kerio::web::KIdList companyContactsIds, in CompanyContact pattern) |
Detailed Description
Company contacts management
Member Function Documentation
void kerio::jsonapi::admin::CompanyContacts::create |
( |
out kerio::web::ErrorList |
errors, |
|
|
out kerio::web::CreateResultList |
result, |
|
|
in CompanyContactList |
companyContacts |
|
) |
| |
Create new company contacts.
- Parameters
-
errors | - error message list |
result | - particular results for all items |
domains | - new company contacts entities |
void kerio::jsonapi::admin::CompanyContacts::get |
( |
out CompanyContactList |
list, |
|
|
out long |
totalItems, |
|
|
in kerio::web::SearchQuery |
query |
|
) |
| |
Obtain a list of company contacts.
- Parameters
-
list | - list of company contacts |
totalItems | - amount of company contacts for given search condition, useful when limit is defined in kerio::web::SearchQuery |
query | - query conditions and limits |
void kerio::jsonapi::admin::CompanyContacts::getAvailable |
( |
out CompanyContactList |
companyContactList, |
|
|
in kerio::web::KId |
domainId |
|
) |
| |
Obtain a list of company contacts capable to be used for user editor to specified domain (domainId). This method is valid for an account admin and full admin.
- Parameter "domainId" is optional for account admin.
- Only company contacts for given domain and global company contacts are listed.
- Parameters
-
companyContactList | - list of user templates |
domainId | - Only company contacts for given domain and global company contacts are listed. |
void kerio::jsonapi::admin::CompanyContacts::remove |
( |
out kerio::web::ErrorList |
errors, |
|
|
in kerio::web::KIdList |
companyContactsIds |
|
) |
| |
Remove company contacts.
- Parameters
-
errors | - error message list |
domainIds | - list of global identifiers of company contacts to be deleted |
void kerio::jsonapi::admin::CompanyContacts::set |
( |
out kerio::web::ErrorList |
errors, |
|
|
in kerio::web::KIdList |
companyContactsIds, |
|
|
in CompanyContact |
pattern |
|
) |
| |
Set existing company contacts to given pattern.
- Parameters
-
errors | - error message list |
companyContactsIds | - list of the company contacts's global identifier(s) |
pattern | - pattern to use for new values |
The documentation for this interface was generated from the following file: