All Classes Files Functions Variables Pages
WebInterface.idl
Go to the documentation of this file.
1 /**
2  * @file WebInterface.idl
3  * @brief Web Interface API
4  * @version 2
5  */
6 
7 #import <common.idl>
8 
9 module webadmin {
10 
11 /**
12  * Certificates (Secured Web Interface) will be handled by CertificateManager
13  */
14 
16  boolean enabled; /**< use custom brand on login, deny pages and in e-mail alerts */
17  string pageTitle; /**< used as page title on login, deny pages and as a brand name on deny page */
18 };
19 
21  boolean useSsl;
23  string detectedHostname;
24  string adminPath; /** "admin" */
25  long port;
26  long sslPort;
27  IdReference certificate;
28  CustomizedBrand customizedBrand;
29 };
30 
31 interface WebInterface {
32 
33  /**
34  * Returns actual values for Web Interface configuration in WebAdmin
35  * @throws kerio::web::ApiException \n
36  * -32001 Session expired. - "The user is not logged in." \n
37  * 1004 Access denied. - "Insufficient rights to perform the requested operation." \n
38  */
39  void get(out WebInterfaceConfig config);
40 
41  /**
42  * Stores configuration
43  * @param config - structure with settings for webinterface module
44  * @param revertTimeout - If client doesn't confirm config to this timeout, configuration is reverted (0 - revert disabled)
45  * @throws kerio::web::ApiException \n
46  * -32001 Session expired. - "The user is not logged in." \n
47  * 1004 Access denied. - "Insufficient rights to perform the requested operation." \n
48  */
49  void set(in WebInterfaceConfig config, in long revertTimeout);
50 
51  /**
52  * Uploaded image which will need to be apply/reset
53  * @param fileId - according to spec 390.
54  * @param isFavicon - true = the image is favicon, false = the image is product logo
55  * @throws kerio::web::ApiException \n
56  * -32001 Session expired. - "The user is not logged in." \n
57  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
58  */
59  void uploadImage(in string fileId, in boolean isFavicon);
60 
61  /**
62  * discard uploaded images
63  * @throws kerio::web::ApiException \n
64  * -32001 Session expired. - "The user is not logged in." \n
65  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
66  */
67  void reset();
68 };
69 
70 }; //webadmin
Common Kerio Control structures, enums and types.
string pageTitle
Definition: WebInterface.idl:17
Definition: WebInterface.idl:31
Definition: WebInterface.idl:20
Definition: common.idl:28
Definition: WebInterface.idl:15
long port
Definition: WebInterface.idl:25
Definition: Accounting.idl:11
boolean enabled
Definition: WebInterface.idl:16
Definition: SharedStructures.idl:289