FreeBusy.idl

Go to the documentation of this file.

/**
 * @file   FreeBusy.idl
 * @brief  %FreeBusy management
 *
 * @author Dusan Juhas, Frantisek Boranek
 *
 * @copyright Copyright © 2017 Kerio Technologies s.r.o.
 */

#import <Structures.idl>
#import <Events.idl>

module kerio {
module jsonapi {
module webmail {
module freebusy {


/**
 * FreeBusy status for particular interval.
 */
struct FreeBusyInterval {
   kerio::jsonapi::webmail::calendars::FreeBusyStatus status;
   UtcDateTime start;
   UtcDateTime end;
};

/**
 * FreeBusy sequence for particular interval.
 */
typedef sequence<FreeBusyInterval> FreeBusySequence;

/**
 * List of free busy sequences.
 */
typedef sequence<FreeBusySequence> FreeBusyList;


/**
 * FreeBusy management.
 */
interface FreeBusy {
   /**
    * Retrieve freebusy data for given useres and time interval.
    * Free status is not being inserted into the result lists. Empty FreeBusySequence means the user is free for whole the interval.
    */
   void get(out FreeBusyList list, in kerio::web::StringList userAddresses, in UtcDateTime start, in UtcDateTime end);
};

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

/**
 * @}
 */