All Classes Files Functions Variables Pages
Public Member Functions | List of all members
webadmin::ForbiddenWords Interface Reference

Public Member Functions

void get (out ForbiddenWordList list, out long totalItems, in kerio::web::SearchQuery query)
 
void create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in ForbiddenWordList items)
 
void set (out kerio::web::ErrorList errors, in kerio::web::StringList ids, in ForbiddenWord details)
 
void remove (out kerio::web::ErrorList errors, in kerio::web::StringList ids)
 
void apply (out kerio::web::ErrorList errors)
 
void reset ()
 
void getConfig (out ForbiddenWordsConfig config)
 
void setConfig (in ForbiddenWordsConfig config)
 

Member Function Documentation

void webadmin::ForbiddenWords::apply ( out kerio::web::ErrorList  errors)

write changes cached in manager to configuration

Parameters
errors- list of errors
8001 Invalid params. - "Unable to add/modify keyword %1, wrong parameters."
8002 Database error. - "Unable to add/modify keyword %1."
8002 Database error. - "Unable to delete the keyword."
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::ForbiddenWords::create ( out kerio::web::ErrorList  errors,
out kerio::web::CreateResultList  result,
in ForbiddenWordList  items 
)

add new forbidden word

Parameters
errors- list of errors
1001 Already exists. - "The keyword already exists."
result- list of IDs assigned to each item
items- details for new words. field id is assigned by the manager to temporary value until apply() or reset().
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::ForbiddenWords::get ( out ForbiddenWordList  list,
out long  totalItems,
in kerio::web::SearchQuery  query 
)

get the list of forbidden words

Parameters
list- list of words and it's details
totalItems- count of all words on server (before the start/limit applied)
query- conditions and limits. Included from weblib.
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::ForbiddenWords::getConfig ( out ForbiddenWordsConfig  config)

Returns the Weight Limit/Enabled

Parameters
config- Complete configuration of Forbidden words module
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::ForbiddenWords::remove ( out kerio::web::ErrorList  errors,
in kerio::web::StringList  ids 
)

remove forbidden word

Parameters
errors- list of errors
ids- ids of words that should be removed
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::ForbiddenWords::reset ( )

discard changes cached in manager

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::ForbiddenWords::set ( out kerio::web::ErrorList  errors,
in kerio::web::StringList  ids,
in ForbiddenWord  details 
)

update existing forbidden word

Parameters
errors- list of errors
1001 Already exists. - "The keyword already exists."
ids- ids of words to be updated.
details- details for update. Field "kerio::web::KId" is ignored. All other fields must be filled and they are written to all words specified by ids.
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::ForbiddenWords::setConfig ( in ForbiddenWordsConfig  config)

Stores the Weight Limit/Enabled

Parameters
config- Complete configuration of Forbidden words module
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: