common.idl

Go to the documentation of this file.

/**
 * @file common.idl
 * @brief Shared structures between WebMail and WebAdmin
 *
 * @author Dusan Juhas
 *
 * @copyright Copyright © 2017 Kerio Technologies s.r.o.
 *
 * @defgroup Server
 * @{
 */

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

module kerio {
module jsonapi {

typedef string UtcDateTime; ///< Date+Time according RFC 2445, eg. 19970714T173000Z

typedef longlong LongNumber; ///< Max. 9007199254740992, min. -9007199254740992

/**
 * Type for date/time representation
 */
typedef long DateTimeStamp;

/**
 * Type for lists of date/times
 */
typedef sequence<DateTimeStamp> DateTimeStampList;


typedef sequence<string> SettingPath;
typedef sequence<SettingPath> SettingQuery;


struct IdEntity {
   kerio::web::KId id;     ///< global identifier of entity
   string name;         ///< [READ-ONLY] name or description of entity
};

struct LangDescription {
   string name;         ///< name of language (national form)
   string code;         ///< code of language; E.g.: "en-gb"
   string shortCode;    ///< short code of language which is used to identify language file; e.g. "en"
};

typedef sequence<LangDescription> LangDescriptionList;

}; };



/**
 * @}
 */