All Classes Files Functions Variables Pages
Notifications.idl
Go to the documentation of this file.
1 /**
2  * @file Notifications.idl
3  * @brief Pending Messages API
4  * @version 1
5  */
6 
7 module webadmin {
8 
9 enum NotificationType {
10  NotificationUpdate,
11  NotificationDump,
12  NotificationLowMemory,
13  NotificationDomains,
14  NotificationSubWillExpire,
15  NotificationSubExpired,
16  NotificationLicWillExpire,
17  NotificationLicExpired,
18  NotificationBackupLine,
19  NotificationInterfaceSpeed,
20  NotificationSmtp,
21  NotificationLlbLine,
22  NotificationLlb,
23  NotificationConnectionOnDemand,
24  NotificationConnectionFailover,
25  NotificationConnectionBalancing,
26  NotificationConnectionPersistent,
27  NotificationCertificateError,
28  NotificationCertificateWillExpire,
29  NotificationCertificateExpired,
30  NotificationCaWillExpire,
31  NotificationCaExpired,
32  NotificationBackupFailed,
33  NotificationPacketDump,
34  NotificationDataEncryption,
35  NotificationDataEncryptionFatal,
36  NotificationUnknown
37 };
38 typedef sequence<NotificationType> NotificationTypeList;
39 
40 enum NotificationSeverity {
41  NotificationWarning,
42  NotificationError
43 };
44 
45 struct Notification {
46  NotificationType type;
47  NotificationSeverity severity;
48  string value;
49  long code;
50 };
51 typedef sequence<Notification> NotificationList;
52 
53 interface Notifications {
54 
55  /**
56  * Returns list of notifications without filtered (cleared) messages
57  *
58  * When lastNotifications are the same as current notifications, method waits until timeout occurs and than returns
59  *
60  * @param notifications - list of notifications
61  * @param lastNotifications - notifications returned by last call or empty list
62  * @param timeout - how long should engine wait for notifications change (in seconds)
63  * @throws kerio::web::ApiException \n
64  * -32001 Session expired. - "The user is not logged in." \n
65  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
66  */
67  void get(out NotificationList notifications, in NotificationList lastNotifications, in long timeout);
68 
69  /**
70  * Clears defined notification for current user
71  *
72  * Notification value is significant too.
73  *
74  * @param notification - one of the notifications returned by get
75  * @throws kerio::web::ApiException \n
76  * -32001 Session expired. - "The user is not logged in." \n
77  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
78  */
79  void clear(in Notification notification);
80 
81 };
82 
83 };//webadmin
Definition: Notifications.idl:45
Definition: Accounting.idl:11
Definition: Notifications.idl:53