All Classes Files Functions Variables Pages
webadmin::Antivirus Interface Reference

Public Member Functions

void get (out AntivirusConfig config)
 
void set (out kerio::web::ErrorList errors, in AntivirusConfig config)
 
void update ()
 
void getUpdateStatus (out InternalUpdateStatus status)
 

Member Function Documentation

void webadmin::Antivirus::get ( out AntivirusConfig  config)

Get Antivirus Settings

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::Antivirus::getUpdateStatus ( out InternalUpdateStatus  status)

Get progres of antivirus updating

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::Antivirus::set ( out kerio::web::ErrorList  errors,
in AntivirusConfig  config 
)

Set Antivirus

Parameters
errors- list of errors
1000 Operation failed. - various errors from antivirus plugins
8002 Database error. - "Unable to modify scanning rule '%1'."
8002 Database error. - "Unable to modify antivirus option '%1'."
8002 Database error. - "Unable to create scanning rule '%1'."
8002 Database error. - "Unable to create antivirus option '%1'."
8002 Database error. - "Unable to delete scanning rule '%1'."
8002 Database error. - "Unable to delete antivirus option '%1'."
config- structure with complete antivirus settings
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::Antivirus::update ( )

Force update of integrated antivirus

Exceptions
kerio::web::ApiException
-32001 Session expired. - "The user is not logged in."
1000 Operation failed. - "Failed to run antivirus update."
1004 Access denied. - "Insufficient rights to perform the requested operation."

The documentation for this interface was generated from the following file: