Storage.idl

Go to the documentation of this file.

/**
 * @file     Storage.idl
 * @brief    API for Storage
 * @version  2
 */

#import <kerio/web/idl/SharedStructures.idl>

module webadmin {

enum StorageDataType {
   StorageDataStar
   , StorageDataLogs
   , StorageDataCrash
   , StorageDataPktdump
   , StorageDataUpdate
   , StorageDataQuarantine
   , StorageDataHttpCache
};

struct StorageData {
   StorageDataType type;
   double size;
};

typedef sequence<StorageData> StorageDataList;

interface Storage {

   /**
    * @param data - Returns list of data present on storage.
    * @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 StorageDataList data);
   
   /**
    * @param type - Delete data specified by type from storage.
    * @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
    *          1000  Operation failed. - "Some files cannot be deleted, they may be currently in use." 
    */
   void remove(in StorageDataType type);

};

}; //webadmin