All Classes Namespaces Files Functions Variables Groups
kerio::jsonapi::webmail::alarms::Alarms Interface Reference

Public Member Functions

void dismiss (out kerio::web::ErrorList errors, in kerio::web::KIdList itemIds)
void get (out AlarmList list, in UtcTime since, in UtcTime until)
void set (out kerio::web::ErrorList errors, in UtcTime nextTime, in kerio::web::KIdList itemIds)

Member Function Documentation

void kerio::jsonapi::webmail::alarms::Alarms::dismiss ( out kerio::web::ErrorList  errors,
in kerio::web::KIdList  itemIds 
)

Dismiss alarms. Value X-NEXT-ALARM is set to the start of next occurence in case of recurrent event. If ID of ordinary event or ID of last occurrence of recurrent event is passed into the method then a reminder will be removed as well as this value.

Parameters
errors- list of errors
itemIds- list of event or occurrence IDs
void kerio::jsonapi::webmail::alarms::Alarms::get ( out AlarmList  list,
in UtcTime  since,
in UtcTime  until 
)

Get alarms. Alarms are searched in range from now to value 'until'.

Parameters
list- list of alarms
since- lower bound of time range
until- upper bound of time range
void kerio::jsonapi::webmail::alarms::Alarms::set ( out kerio::web::ErrorList  errors,
in UtcTime  nextTime,
in kerio::web::KIdList  itemIds 
)

Set alarm to a particular time. Value is placed in X-NEXT-ALARM property.

Parameters
errors- list of errors
nextTime- time
itemIds- list of event or occurrence IDs

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