All Classes Files Functions Variables Enumerations Enumerator Groups Pages
UserVoice.idl
Go to the documentation of this file.
1 /**
2  * @file UserVoice.idl
3  * @brief %User Feedback settings
4  *
5  * @author Dusan Juhas, Frantisek Boranek
6  *
7  * @copyright Copyright © 2017 Kerio Technologies s.r.o.
8  */
9 
10 #import <kerio/web/idl/SharedStructures.idl>
11 
12 module kerio {
13 module jsonapi {
14 module admin {
15 
16 
17 /**
18  * Settings of UserVoice
19  */
20 struct UserVoiceSettings {
21  string name;
22  string email;
23 };
24 
25 
26 /**
27  * UserVoice accounts management
28  */
29 interface UserVoice {
30 
31  /**
32  * Obtain settings of User Voice.
33  *
34  * @param settings - structure with settings
35  */
36  void get(out UserVoiceSettings settings);
37 
38  /**
39  * Get status of registration of user voice.
40  *
41  * @param isSet - true if user voice is set
42  */
43  void getStatus(out boolean isSet);
44 
45  /**
46  * Generate token for logging into user voice web.
47  * Parameters name and email can be empty strings.
48  *
49  * @param url - URL to userVoice with single sign on token
50  * @param name - user displayname for userVoice
51  * @param email - user email address for userVoice
52  */
53  void getUrl(out string url, in string name, in string email);
54 
55  /**
56  * Set settings of User Voice.
57  *
58  * @param settings - structure with settings
59  */
60  void set(in UserVoiceSettings settings);
61 };
62 
63 }; }; };//end of namespace