Definitions

Description

Classes
struct	kerio::web::TimeRangeGroup
struct	kerio::web::TimeRangeEntry
interface	kerio::web::TimeRanges

Typedefs
typedef sequence< Day >	kerio::web::DayList
typedef sequence< TimeRangeEntry >	kerio::web::TimeRangeEntryList
typedef sequence< TimeRangeGroup >	kerio::web::TimeRangeGroupList

Enumerations
enum	kerio::web::TimeRangeType { TimeRangeDaily, TimeRangeWeekly, TimeRangeAbsolute, kerio::web::TimeRangeChildGroup }
enum	Day {   Monday, Tuesday, Wednesday, Thursday,   Friday, Saturday, Sunday }

Functions
void	kerio::web::TimeRanges::create (out ErrorList errors, out CreateResultList result, in TimeRangeEntryList ranges)
void	kerio::web::TimeRanges::get (out TimeRangeEntryList list, out long totalItems, in SearchQuery query)
void	kerio::web::TimeRanges::getGroupList (out TimeRangeGroupList groups)
void	kerio::web::TimeRanges::remove (out ErrorList errors, in KIdList rangeIds)
void	kerio::web::TimeRanges::set (out ErrorList errors, in KIdList rangeIds, in TimeRangeEntry details)

Variables
KId	kerio::web::TimeRangeGroup::id
string	kerio::web::TimeRangeGroup::name
KId	kerio::web::TimeRangeEntry::id
KId	kerio::web::TimeRangeEntry::groupId
KId	kerio::web::TimeRangeEntry::sharedId
	read-only; filled when the item is shared in MyKerio
string	kerio::web::TimeRangeEntry::groupName
string	kerio::web::TimeRangeEntry::description
TimeRangeType	kerio::web::TimeRangeEntry::type
boolean	kerio::web::TimeRangeEntry::enabled
StoreStatus	kerio::web::TimeRangeEntry::status
Time	kerio::web::TimeRangeEntry::fromTime
	This doesn't contain seconds, so we round data created by QT admin.
Time	kerio::web::TimeRangeEntry::toTime
	This doesn't contain seconds, so we round data created by QT admin.
DayList	kerio::web::TimeRangeEntry::days
Day	kerio::web::TimeRangeEntry::fromDay
Day	kerio::web::TimeRangeEntry::toDay
Date	kerio::web::TimeRangeEntry::fromDate
	hour and min used from Time
Date	kerio::web::TimeRangeEntry::toDate
	hour and min used from Time
KId	kerio::web::TimeRangeEntry::childGroupId
string	kerio::web::TimeRangeEntry::childGroupName

Enumeration Type Documentation

enum kerio::web::TimeRangeType

Enumerator:

TimeRangeChildGroup

not supported in QT

                   {
   TimeRangeDaily,
   TimeRangeWeekly,
   TimeRangeAbsolute,
   TimeRangeChildGroup ///< not supported in QT
};

Function Documentation

void kerio::web::TimeRanges::create	(	out ErrorList	errors,
		out CreateResultList	result,
		in TimeRangeEntryList	ranges
	)

Create new ranges.

Parameters

errors	- possible errors: "This time range already exists!" duplicate name-value
result	- list of IDs of created TimeRanges
ranges	- details for new ranges. Field KiD is assigned by the manager to temporary value until apply() or reset().

void kerio::web::TimeRanges::get	(	out TimeRangeEntryList	list,
		out long	totalItems,
		in SearchQuery	query
	)

Get the list of ranges.

Parameters

ranges	- list of ranges and its details
totalItems	- count of all ranges 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 case insensitive. column alias (first operand):

void kerio::web::TimeRanges::getGroupList

(

out TimeRangeGroupList

groups

)

Get the list of groups, sorted in ascending order.

Parameters

groups

- list of all groups

void kerio::web::TimeRanges::remove	(	out ErrorList	errors,
		in KIdList	rangeIds
	)

Remove ranges.

Parameters

rangeIds	- IDs of ranges that should be removed
errors	- Errors by removing ranges

void kerio::web::TimeRanges::set	(	out ErrorList	errors,
		in KIdList	rangeIds,
		in TimeRangeEntry	details
	)

Set existing ranges.

Parameters

errors	- possible errors: "This time range already exists!" duplicate name-value
rangeIds	- IDs of ranges to be updated.
details	- details for update. Field "KId" is ignored. All other fields must be filled in and they are written to all ranges specified by rangeIds.

Variable Documentation

Date kerio::web::TimeRangeEntry::fromDate

hour and min used from Time

Time kerio::web::TimeRangeEntry::fromTime

This doesn't contain seconds, so we round data created by QT admin.

KId kerio::web::TimeRangeEntry::sharedId

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

Date kerio::web::TimeRangeEntry::toDate

hour and min used from Time

Time kerio::web::TimeRangeEntry::toTime

This doesn't contain seconds, so we round data created by QT admin.