All Classes Files Functions Variables Pages
webadmin::Notifications Interface Reference

Public Member Functions

void get (out NotificationList notifications, in NotificationList lastNotifications, in long timeout)
 
void clear (in Notification notification)
 

Member Function Documentation

void webadmin::Notifications::clear ( in Notification  notification)

Clears defined notification for current user

Notification value is significant too.

Parameters
notification- one of the notifications returned by get
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::Notifications::get ( out NotificationList  notifications,
in NotificationList  lastNotifications,
in long  timeout 
)

Returns list of notifications without filtered (cleared) messages

When lastNotifications are the same as current notifications, method waits until timeout occurs and than returns

Parameters
notifications- list of notifications
lastNotifications- notifications returned by last call or empty list
timeout- how long should engine wait for notifications change (in seconds)
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."

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