Alerts.idl

Go to the documentation of this file.

/**
 * @file     Alerts.idl
 * @brief    Alert Messages API
 * @version  3
 */

#import <kerio/web/idl/SharedStructures.idl>
#import <common.idl>
#import <Users.idl>

module webadmin {

struct AlertRow {
   kerio::web::KId id;
   string date;             /**< dd/Mon/YYYY HH:mm:ss, e.g. 15/Feb/2010 10:50:44 */
   string alert;            /**< char [128] */
   string details;          /**< char [256] */
};
typedef sequence<AlertRow> AlertRowList;

struct AlertType {
   kerio::web::KId id;
   string name;
};
typedef sequence<AlertType> AlertTypeList;

enum AlertEventRuleType {
   AlertTraffic,
   AlertContent
};

struct AlertRuleEvent { 
   AlertEventRuleType ruleType;
   IdReference rule;
};

typedef sequence<AlertRuleEvent> AlertRuleEventList;

struct AlertLogEvent { 
   kerio::web::KId log;
   string name;
   long interval;
   boolean isRegex;
   string condition;
};

typedef sequence<AlertLogEvent> AlertLogEventList;

struct AlertSetting {
   kerio::web::KId id;
   boolean enabled;
   Addressee addressee;
   kerio::web::KIdList alertList;    /**< System events */
   AlertRuleEventList ruleEventList; /**< Rule events */
   AlertLogEventList logEventList;   /**< Log events */
   IdReference validTimeRange;
};
typedef sequence<AlertSetting> AlertSettingList;

interface Alerts {

   /**
    * Returns Alert Messages data
    *
    * @param list - output data
    * @param totalItems - all data count
    * @param query - paging query (sorting is not possible and it is ignored)
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation." 
    */
   void get(out AlertRowList list, out long totalItems, in kerio::web::SearchQuery query);

   /**
    * Returns content of given Alert Message as formatted HTML
    *
    * @param content - output data
    * @param id - ID of given alert
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1002  No such entity.  - "The required record doesn't exist any more. The page will be reloaded." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation." 
    */
   void getContent(out string content, in kerio::web::KId id);

   /**
    * Returns list of possible Alerts types
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation." 
    */
   void getAlertTypes(out AlertTypeList types);

   /**
    * Returns list of user defined alert handling
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation." 
    */
   void getSettings(out AlertSettingList config);

   /**
    * Stores list of user defined alert handling
    * @param errors - list of items that cannot be changed. \n
    *          8002  Database error.   - "Unable to modify alert '%1' for '%2'." \n
    *          8002  Database error.   - "Unable to create alert '%1' for '%2'." \n
    *          8002  Database error.   - "Unable to remove alert '%1' for '%2'."
    * @param config - structure with complete alerts settings
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation." 
    */
   void setSettings(out kerio::web::ErrorList errors, in AlertSettingList config);

   /**
    * Returns default language for Alert emails
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation." 
    */
   void getDefaultLanguage(out string lang);

   /**
    * Stores default language for Alert emails
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation." 
    */
   void setDefaultLanguage(in string lang);
};

}; //webadmin