Public Member Functions |
| void | create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in UserTemplateList userTemplates) |
| void | get (out UserTemplateList userTemplateList, out long totalItems, in kerio::web::SearchQuery query) |
| void | getAvailable (out UserTemplateList userTemplateList, in kerio::web::KId domainId) |
| void | remove (out kerio::web::ErrorList errors, in kerio::web::KIdList idList) |
| void | set (out kerio::web::ErrorList errors, in kerio::web::KIdList idList, in UserTemplate pattern) |
Member Function Documentation
| void kerio::jsonapi::admin::UserTemplates::create |
( |
out kerio::web::ErrorList |
errors, |
|
|
out kerio::web::CreateResultList |
result, |
|
|
in UserTemplateList |
userTemplates |
|
) |
| |
Create user templates.
- Parameters
-
| errors | - error message list |
| result | - list of IDs of created templates |
| userTemplates | - new user template entities |
| void kerio::jsonapi::admin::UserTemplates::get |
( |
out UserTemplateList |
userTemplateList, |
|
|
out long |
totalItems, |
|
|
in kerio::web::SearchQuery |
query |
|
) |
| |
Obtain a list of user templates.
- Parameters
-
| userTemplateList | - list of user templates |
| totalItems | - number of all returned templates |
| query | - query attributes and limits |
| void kerio::jsonapi::admin::UserTemplates::getAvailable |
( |
out UserTemplateList |
userTemplateList, |
|
|
in kerio::web::KId |
domainId |
|
) |
| |
Obtain a list of user templates capable to be used for AddUser to specified domain (domainId). This method is valid only for an account admin.
- DomainId must be their own domain.
- Only templates without administrative rights are listed.
- Parameters
-
| userTemplateList | - list of user templates |
| domainId | - only templates with this domain and templates without domain are listed |
| void kerio::jsonapi::admin::UserTemplates::remove |
( |
out kerio::web::ErrorList |
errors, |
|
|
in kerio::web::KIdList |
idList |
|
) |
| |
Remove list of user template records.
- Parameters
-
| errors | - error message list |
| idList | - list of identifiers of deleted user templates |
| void kerio::jsonapi::admin::UserTemplates::set |
( |
out kerio::web::ErrorList |
errors, |
|
|
in kerio::web::KIdList |
idList, |
|
|
in UserTemplate |
pattern |
|
) |
| |
Set user templates according a given pattern.
- Parameters
-
| errors | - error message list |
| idList | - list of domain global identifier(s) of items to be changed |
| pattern | - pattern to use for new values |
The documentation for this interface was generated from the following file:
