Integration.idl

Go to the documentation of this file.

/**
 * @file  Integration.idl
 * @brief Methods for integration with mobile devices and other supported platforms
 *
 * @author Frantisek Boranek
 *
 * @copyright Copyright © 2017 Kerio Technologies s.r.o.
 */

#import <Structures.idl>
#import <Folders.idl>

module kerio {
module jsonapi {
module webmail {
module integration {

/**
 * Class with methods for integration
 */
struct SyncFolder {
   kerio::web::KId            id;            ///< [READ-ONLY] global identification
   kerio::web::KId            parentId;      ///< [READ-ONLY] global identification
   string                     name;       ///< [READ-ONLY] folder name displayed in folder tree
   kerio::jsonapi::webmail::folders::FolderType        type;         ///< [READ-ONLY] type of the folder
   kerio::jsonapi::webmail::folders::FolderSubType     subType;         ///< [READ-ONLY] type of the folder
   kerio::jsonapi::webmail::folders::FolderPlaceType   placeType;    ///< [READ-ONLY] type of place where is folder placed
   long                       nestingLevel;  ///< [READ-ONLY] number 0 = root folder, 1 = subfolders of root folder, 2 = subfolder of subfolder, ...
   string                     ownerName;     ///< [READ-ONLY] name of owner of folder (available only for 'FPlacePeople', 'FPlaceResources' and 'FPlaceLocations')
   string                     emailAddress;  ///< [READ-ONLY] email of owner of folder (available only for 'FPlacePeople', 'FPlaceResources' and 'FPlaceLocations')

   boolean                    isSelectable;  ///< [READ-ONLY] false if a setting of this folder cannot be modified
   boolean                    synchronize;     ///< true if should be this folder synchronize
};

typedef sequence<SyncFolder> SyncFolderList;


/**
 * Class with methods for integration
 */
interface Integration {

   /**
    * Obtain list of folders of currently logged user
    *
    * @param list - list of folders
    */
   void getASyncFolderList(out SyncFolderList list);

   /**
    * Set folder properties
    *
    * @param errors - error message list
    * @param folders - properties to save
    */
   void setASyncFolderList(out kerio::web::ErrorList errors, in SyncFolderList folders);


   /**
    * Obtain list of folders of currently logged user (task and calendars only)
    *
    * @param list - list of folders
    */
   void getIPhoneSyncFolderList(out SyncFolderList list);

   /**
    * Set folder properties (task and calendars only)
    *
    * @param errors - error message list
    * @param folders - properties to save
    */
   void setIPhoneSyncFolderList(out kerio::web::ErrorList errors, in SyncFolderList folders);

};

}; }; }; }; // end of namespace