UserVoice.idl

Go to the documentation of this file.

/**
 * @file     UserVoice.idl
 * @brief    User Feedback API
 * @version  1
 */


module webadmin {

/**
 * Settings of UserVoice
 */
struct UserVoiceSettings {
   string   name;
   string   email;
};

interface UserVoice {

   /**
    * Generate token for logging into user voice web.
    * Parameters name and email can be empty strings.
    *
    * @param url - URL to userVoice with single sign on token
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1000  Operation Failed. - "Data are not set yet." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation." \n
    *          8000  Internal error.   - "Initialization of stream for encryption failed: %1" \n
    *          8000  Internal error.   - "Encrytion of token failed: %1" \n
    *          8000  Internal error.   - "URL encoding of token failed."
    */
   void getUrl(out string url);

   /**
    * Set settings of User Voice.
    *
    * @param settings - structure with settings
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired.  - "The user is not logged in." \n
    *          1004  Access denied.    - "Insufficient rights to perform the requested operation." \n
    */
   void set(in UserVoiceSettings settings);
};

}; //webadmin