UserStatistics.idl

Go to the documentation of this file.

/**
 * @file     UserStatistics.idl
 * @brief    User Statistics API
 * @version  2
 */

#import <Users.idl>
#import <common.idl>

module webadmin {

enum UserStatisticType {
   UserStatisticAll,
   UserStatisticUser,
   UserStatisticOther,
   UserStatisticGuest
};

struct UserStatistic {
   kerio::web::KId   id;
   string            userName; 
   UserStatisticType type;
   string            fullName;
   long              quota;
   DataStatistic     data;
};

typedef sequence<UserStatistic> UserStatisticList;

interface UserStatistics {

   /**
    * Returns User Statistics data
    *
    * @param list - output data
    * @param totalItems - all data count
    * @param query - filter/sort query
    * @param refresh - true in case, that data snapshot have to be refreshed
    * @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." 
    */
   void get(out UserStatisticList list, out long totalItems, in kerio::web::SearchQuery query, in boolean refresh);

   /**
    * Deletes user traffic counters
    * 
    * @param ids - list of user ids returned in user member by get
    * @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." 
    */
   void remove(in kerio::web::KIdList ids);

};

}; //webadmin