Public Member Functions | |
| void | get (out UserGroupList list, out long totalItems, in kerio::web::SearchQuery query, in kerio::web::KId domainId) |
| void | create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in UserGroupList groups, in kerio::web::KId domainId) |
| void | set (out kerio::web::ErrorList errors, in kerio::web::StringList groupIds, in UserGroup details, in kerio::web::KId domainId) |
| void | remove (out kerio::web::ErrorList errors, in kerio::web::StringList groupIds, in kerio::web::KId domainId) |
| void webadmin::UserGroups::create | ( | out kerio::web::ErrorList | errors, |
| out kerio::web::CreateResultList | result, | ||
| in UserGroupList | groups, | ||
| in kerio::web::KId | domainId | ||
| ) |
Add new group
| errors | - list of errors 1000 Operation failed. - "Unable to add item." 1001 Already exists. - "Group %1 already exists." 8001 Invalid params. - "Unable to add/modify group %1, wrong parameters." 8002 Database error. - "Unable to add/modify group %1, it may already exist." |
| 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(). |
| domainId | - id of domain - specifies domain, where groups will be created (only local is supported) |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::UserGroups::get | ( | out UserGroupList | list, |
| out long | totalItems, | ||
| in kerio::web::SearchQuery | query, | ||
| in kerio::web::KId | domainId | ||
| ) |
Obtain list of groups in given domain
| list | - list of groups and it's details |
| totalItems | - count of all groups on server (before the start/limit applied) |
| query | - conditions and limits |
| domainId | - id of domain - only groups from this domain will be listed |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1000 Operation failed. - "Directory service error: %1." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::UserGroups::remove | ( | out kerio::web::ErrorList | errors, |
| in kerio::web::StringList | groupIds, | ||
| in kerio::web::KId | domainId | ||
| ) |
Delete groups
| errors | - list of errors 1000 Operation failed. - "Unable to remove item." 8002 Database error. - "Unable to delete the group." |
| groupIds | - ids of groups that should be removed |
| domainId | - id of domain - specifies domain, where groups will be removed (only local is supported) |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::UserGroups::set | ( | out kerio::web::ErrorList | errors, |
| in kerio::web::StringList | groupIds, | ||
| in UserGroup | details, | ||
| in kerio::web::KId | domainId | ||
| ) |
Update groups' details
| errors | - list of errors 1001 Already exists. - "Group %1 already exists." 8001 Invalid params. - "Unable to add/modify group %1, wrong parameters." 8002 Database error. - "Unable to add/modify group %1, it may already exist." |
| groupIds | - ids of groups to be updated. |
| details | - details for update. Field "kerio::web::KId" is ignored. All other values have to be present |
| domainId | - id of domain - groups from this domain will be updated |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
