Definitions

Description

Classes
struct	kerio::web::IpAddressGroup
struct	kerio::web::IpAddressEntry
interface	kerio::web::IpAddressGroups

Typedefs
typedef sequence< IpAddressEntry >	kerio::web::IpAddressEntryList
typedef sequence< IpAddressGroup >	kerio::web::IpAddressGroupList

Enumerations
enum	IpAddressGroupType {   Host, Network, Range, ChildGroup,   ThisMachine, IpPrefix }

Functions
void	kerio::web::IpAddressGroups::create (out ErrorList errors, out CreateResultList result, in IpAddressEntryList groups)
void	kerio::web::IpAddressGroups::get (out IpAddressEntryList list, out long totalItems, in SearchQuery query)
void	kerio::web::IpAddressGroups::getGroupList (out IpAddressGroupList groups)
void	kerio::web::IpAddressGroups::remove (out ErrorList errors, in KIdList groupIds)
void	kerio::web::IpAddressGroups::set (out ErrorList errors, in KIdList groupIds, in IpAddressEntry details)
void	kerio::web::IpAddressGroups::validateRemove (out ErrorList errors, in KIdList groupIds)
void	kerio::web::IpAddressGroups::validateSet (out ErrorList errors, in KIdList groupIds, in IpAddressEntry details)

Variables
KId	kerio::web::IpAddressGroup::id
string	kerio::web::IpAddressGroup::name
KId	kerio::web::IpAddressEntry::id
KId	kerio::web::IpAddressEntry::groupId
KId	kerio::web::IpAddressEntry::sharedId
	read-only; filled when the item is shared in MyKerio
string	kerio::web::IpAddressEntry::groupName
string	kerio::web::IpAddressEntry::description
IpAddressGroupType	kerio::web::IpAddressEntry::type
boolean	kerio::web::IpAddressEntry::enabled
StoreStatus	kerio::web::IpAddressEntry::status
string	kerio::web::IpAddressEntry::host
	name, IP or IP prefix
IpAddress	kerio::web::IpAddressEntry::addr1
	network/from, e.g. 192.168.0.0
IpAddress	kerio::web::IpAddressEntry::addr2
	mask/to, e.g. 255.255.0.0
KId	kerio::web::IpAddressEntry::childGroupId
string	kerio::web::IpAddressEntry::childGroupName

Function Documentation

void kerio::web::IpAddressGroups::create	(	out ErrorList	errors,
		out CreateResultList	result,
		in IpAddressEntryList	groups
	)

Create new groups.

Parameters

errors	- possible errors: "This address group already exists!" duplicate name-value
result	- list of IDs of created IpAddressGroups
groups	- details for new groups.

void kerio::web::IpAddressGroups::get	(	out IpAddressEntryList	list,
		out long	totalItems,
		in SearchQuery	query
	)

Get the list of IP groups.

Parameters

groups	- list of groups and its details
totalItems	- count of all groups on the server (before the start/limit applied)
query	- conditions and limits. Included from weblib. KWF engine implementation notes: LIKE matches substring (second argument) in a string (first argument). There are no wildcards. sort and match are not case sensitive. column alias (first operand): TODO: "QUICKSEARCH" - requested operator applied as following: (name operator secondOperand ) || (description operator secondOperand)

void kerio::web::IpAddressGroups::getGroupList

(

out IpAddressGroupList

groups

)

Get the list of groups, sorted in ascending order.

Parameters

groups

- list of IP address groups

void kerio::web::IpAddressGroups::remove	(	out ErrorList	errors,
		in KIdList	groupIds
	)

Remove groups.

Parameters

groupIds	- IDs of groups that should be removed
errors	- Errors by removing groups

void kerio::web::IpAddressGroups::set	(	out ErrorList	errors,
		in KIdList	groupIds,
		in IpAddressEntry	details
	)

Create groups.

Parameters

errors	- possible errors: "This address group already exists!" duplicate name-value
groupIds	- IDs of groups to be updated.
details	- details for update.

void kerio::web::IpAddressGroups::validateRemove	(	out ErrorList	errors,
		in KIdList	groupIds
	)

Check if groups removal can cut off the administrator from remote administration

Parameters

groupIds	- IDs of groups that should be removed
errors	- if the result is false, error argument contains additional error info; possible errors: "You will be cut off from remote administration!"

void kerio::web::IpAddressGroups::validateSet	(	out ErrorList	errors,
		in KIdList	groupIds,
		in IpAddressEntry	details
	)

Check update of existing groups to see whether this change cut off the administrator from remote administration.

Parameters

errors	- if the result is false, error argument contains additional error info; possible errors: "You will be cut off from remote administration!"
groupIds	- IDs of groups to be updated.
details	- details for update.

Variable Documentation

IpAddress kerio::web::IpAddressEntry::addr1

network/from, e.g. 192.168.0.0

IpAddress kerio::web::IpAddressEntry::addr2

mask/to, e.g. 255.255.0.0

string kerio::web::IpAddressEntry::host

name, IP or IP prefix

KId kerio::web::IpAddressEntry::sharedId

read-only; filled when the item is shared in MyKerio