Public Member Functions | |
| void | get (out AlertRowList list, out long totalItems, in kerio::web::SearchQuery query) |
| void | getContent (out string content, in kerio::web::KId id) |
| void | getAlertTypes (out AlertTypeList types) |
| void | getSettings (out AlertSettingList config) |
| void | setSettings (out kerio::web::ErrorList errors, in AlertSettingList config) |
| void | getDefaultLanguage (out string lang) |
| void | setDefaultLanguage (in string lang) |
| void webadmin::Alerts::get | ( | out AlertRowList | list, |
| out long | totalItems, | ||
| in kerio::web::SearchQuery | query | ||
| ) |
Returns Alert Messages data
| list | - output data |
| totalItems | - all data count |
| query | - paging query (sorting is not possible and it is ignored) |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::Alerts::getAlertTypes | ( | out AlertTypeList | types | ) |
Returns list of possible Alerts types
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::Alerts::getContent | ( | out string | content, |
| in kerio::web::KId | id | ||
| ) |
Returns content of given Alert Message as formatted HTML
| content | - output data |
| id | - ID of given alert |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1002 No such entity. - "The required record doesn't exist any more. The page will be reloaded." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::Alerts::getDefaultLanguage | ( | out string | lang | ) |
Returns default language for Alert emails
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::Alerts::getSettings | ( | out AlertSettingList | config | ) |
Returns list of user defined alert handling
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::Alerts::setDefaultLanguage | ( | in string | lang | ) |
Stores default language for Alert emails
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::Alerts::setSettings | ( | out kerio::web::ErrorList | errors, |
| in AlertSettingList | config | ||
| ) |
Stores list of user defined alert handling
| errors | - list of items that cannot be changed. 8002 Database error. - "Unable to modify alert '%1' for '%2'." 8002 Database error. - "Unable to create alert '%1' for '%2'." 8002 Database error. - "Unable to remove alert '%1' for '%2'." |
| config | - structure with complete alerts settings |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
