All Classes Files Functions Variables Enumerations Enumerator Groups Pages
kerio::jsonapi::admin::AccessPolicy Interface Reference

import "AccessPolicy.idl";

Public Member Functions

void create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in AccessPolicyRuleList rules)
void createGroupList (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in AccessPolicyGroupList groups)
void get (out AccessPolicyRuleList list, out long totalItems, in kerio::web::SearchQuery query)
void getGroupList (out AccessPolicyGroupList groups)
void getServiceList (out ServiceTypeInfoList services)
void remove (out kerio::web::ErrorList errors, in kerio::web::KIdList ruleIds)
void removeGroupList (out kerio::web::ErrorList errors, in kerio::web::KIdList groupIds)
void set (out kerio::web::ErrorList errors, in AccessPolicyRuleList rules)
void setGroupList (out kerio::web::ErrorList errors, in AccessPolicyGroupList groups)

Detailed Description

Access policies management.

Member Function Documentation

void kerio::jsonapi::admin::AccessPolicy::create ( out kerio::web::ErrorList  errors,
out kerio::web::CreateResultList  result,
in AccessPolicyRuleList  rules 
)

Add new policies.

Parameters
errors- error message list
result- list of IDs of created rules
rules- new policies rules
void kerio::jsonapi::admin::AccessPolicy::createGroupList ( out kerio::web::ErrorList  errors,
out kerio::web::CreateResultList  result,
in AccessPolicyGroupList  groups 
)

Create the list of groups.

Parameters
errors- error message list
result- list of IDs of created groups
groups- list of groups to create
void kerio::jsonapi::admin::AccessPolicy::get ( out AccessPolicyRuleList  list,
out long  totalItems,
in kerio::web::SearchQuery  query 
)

Obtain a list of policies.

Parameters
list- policies
totalItems- number of policies found
query- query attributes and limits
void kerio::jsonapi::admin::AccessPolicy::getGroupList ( out AccessPolicyGroupList  groups)

Get the list of groups, sorted in ascending order.

Parameters
groups- list of Access policy groups
void kerio::jsonapi::admin::AccessPolicy::getServiceList ( out ServiceTypeInfoList  services)

Get the list of services.

Parameters
services- list of service info
void kerio::jsonapi::admin::AccessPolicy::remove ( out kerio::web::ErrorList  errors,
in kerio::web::KIdList  ruleIds 
)

Remove policies.

Parameters
errors- error message list
ruleIds- list of IDs of policy to be removed
void kerio::jsonapi::admin::AccessPolicy::removeGroupList ( out kerio::web::ErrorList  errors,
in kerio::web::KIdList  groupIds 
)

Remove the list of groups.

Parameters
errors- error message list
groupIds- list of IDs of group policy to be removed
void kerio::jsonapi::admin::AccessPolicy::set ( out kerio::web::ErrorList  errors,
in AccessPolicyRuleList  rules 
)

Set policy details.

Parameters
errors- error message list
rules- rules to save
void kerio::jsonapi::admin::AccessPolicy::setGroupList ( out kerio::web::ErrorList  errors,
in AccessPolicyGroupList  groups 
)

Set the list of groups.

Parameters
errors- error message list
groups- list of group to set

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