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

Public Member Functions

void get (out ContentRuleList list)
 
void set (out kerio::web::ErrorList errors, in ContentRuleList rules)
 
void getCollisions (out CollisionList list)
 
void getContentApplicationList (out ContentApplicationList categories)
 
void getFilenameGroups (out FilenameGroupList groups)
 
void getUrlFilterConfig (out UrlFilterConfig config)
 
void setUrlFilterConfig (in UrlFilterConfig config)
 
void reportMiscategorizedUrl (in string url, in kerio::web::IntegerList categoryIds)
 
void getUrlCategories (out kerio::web::IntegerList categoryIds, in string url)
 
void getHttpsConfig (out HttpsConfig config)
 
void setHttpsConfig (in HttpsConfig config)
 
void getSafeSearchConfig (out SafeSearchConfig config)
 
void setSafeSearchConfig (in SafeSearchConfig config)
 
void clearHttpsCertCache ()
 

Member Function Documentation

void webadmin::ContentFilter::clearHttpsCertCache ( )

Clears cache of generated certificates for HTTPS inspection.

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::ContentFilter::get ( out ContentRuleList  list)
Parameters
list- list of rule and it's details
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::ContentFilter::getCollisions ( out CollisionList  list)

Return list of overlappped rules

Parameters
collisions- list of collisions
Exceptions
kerio::web::ApiExceptionon error: -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."
void webadmin::ContentFilter::getContentApplicationList ( out ContentApplicationList  categories)

Returns the list of webfilter/application categories and applications

Parameters
categories- list of webfilter/application categories and applications
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
8000 Internal error. - "Internal error." - unable to get page list of webfilter/application categories and applications
void webadmin::ContentFilter::getFilenameGroups ( out FilenameGroupList  groups)

Returns the list of filename groups

Parameters
groups- list of filename groups
Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation."
Deprecated:
use FilenameGroups::get() instead
void webadmin::ContentFilter::getHttpsConfig ( out HttpsConfig  config)

Returns configuration of HTTPS Filtering

Parameters
config- configuration values
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::ContentFilter::getSafeSearchConfig ( out SafeSearchConfig  config)

Returns configuration of SafeSearch

Parameters
config- configuration values
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::ContentFilter::getUrlCategories ( out kerio::web::IntegerList  categoryIds,
in string  url 
)

Returns current categorization of given url

Parameters
url- checked URL
categoryIds- list of categories, to which given URL belongs
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::ContentFilter::getUrlFilterConfig ( out UrlFilterConfig  config)

Returns configuration of WebFilter

Parameters
config- configuration values
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::ContentFilter::reportMiscategorizedUrl ( in string  url,
in kerio::web::IntegerList  categoryIds 
)

Reports miscategorized url

Parameters
url- URL, that is miscategorized
categoryIds- up to 3 suggested categories. Can be empty, if new category is not known
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::ContentFilter::set ( out kerio::web::ErrorList  errors,
in ContentRuleList  rules 
)

Stores the list of Content rules

Parameters
errors- list of errors occured during method call
rules- list of rules and it's details
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::ContentFilter::setHttpsConfig ( in HttpsConfig  config)

Stores configuration of HTTPS Filtering

Parameters
config- configuration values
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::ContentFilter::setSafeSearchConfig ( in SafeSearchConfig  config)

Stores configuration of SafeSearch

Parameters
config- configuration values
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::ContentFilter::setUrlFilterConfig ( in UrlFilterConfig  config)

Stores configuration of WebFilter

Parameters
config- configuration values
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: