package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Source : sig ... end
module Reminders : sig ... end
module Organizer : sig ... end
module Gadget : sig ... end
module ExtendedProperties : sig ... end
module Creator : sig ... end
type t = {
  1. anyoneCanAddSelf : bool;
    (*

    Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

    *)
  2. attachments : EventAttachment.t list;
    (*

    File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,

    *)
  3. attendees : EventAttendee.t list;
    (*

    The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

    *)
  4. attendeesOmitted : bool;
    (*

    Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.

    *)
  5. colorId : string;
    (*

    The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.

    *)
  6. created : GapiDate.t;
    (*

    Creation time of the event (as a RFC3339 timestamp). Read-only.

    *)
  7. creator : Creator.t;
    (*

    The creator of the event. Read-only.

    *)
  8. description : string;
    (*

    Description of the event. Optional.

    *)
  9. _end : EventDateTime.t;
    (*

    The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

    *)
  10. endTimeUnspecified : bool;
    (*

    Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.

    *)
  11. etag : string;
    (*

    ETag of the resource.

    *)
  12. extendedProperties : ExtendedProperties.t;
    (*

    Extended properties of the event.

    *)
  13. gadget : Gadget.t;
    (*

    A gadget that extends this event.

    *)
  14. guestsCanInviteOthers : bool;
    (*

    Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

    *)
  15. guestsCanModify : bool;
    (*

    Whether attendees other than the organizer can modify the event. Optional. The default is False.

    *)
  16. guestsCanSeeOtherGuests : bool;
    (*

    Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

    *)
  17. iCalUID : string;
    (*

    Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

    *)
  18. id : string;
    (*

    Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:

    • characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
    • the length of the ID must be between 5 and 1024 characters
    • the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.
    *)
  19. kind : string;
    (*

    Type of the resource ("calendar#event").

    *)
  20. location : string;
    (*

    Geographic location of the event as free-form text. Optional.

    *)
  21. locked : bool;
    (*

    Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.

    *)
  22. organizer : Organizer.t;
    (*

    The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.

    *)
  23. originalStartTime : EventDateTime.t;
    (*

    For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.

    *)
  24. privateCopy : bool;
    (*

    Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.

    *)
  25. recurrence : string list;
    (*

    List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.

    *)
  26. recurringEventId : string;
    (*

    For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

    *)
  27. reminders : Reminders.t;
    (*

    Information about the event's reminders for the authenticated user.

    *)
  28. sequence : int;
    (*

    Sequence number as per iCalendar.

    *)
  29. source : Source.t;
    (*

    Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.

    *)
  30. start : EventDateTime.t;
    (*

    The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

    *)
  31. status : string;
    (*

    Status of the event. Optional. Possible values are:

    • "confirmed" - The event is confirmed. This is the default status.
    • "tentative" - The event is tentatively confirmed.
    • "cancelled" - The event is cancelled.
    *)
  32. summary : string;
    (*

    Title of the event.

    *)
  33. transparency : string;
    (*

    Whether the event blocks time on the calendar. Optional. Possible values are:

    • "opaque" - The event blocks time on the calendar. This is the default value.
    • "transparent" - The event does not block time on the calendar.
    *)
  34. updated : GapiDate.t;
    (*

    Last modification time of the event (as a RFC3339 timestamp). Read-only.

    *)
  35. visibility : string;
    (*

    Visibility of the event. Optional. Possible values are:

    • "default" - Uses the default visibility for events on the calendar. This is the default value.
    • "public" - The event is public and event details are visible to all readers of the calendar.
    • "private" - The event is private and only event attendees may view event details.
    • "confidential" - The event is private. This value is provided for compatibility reasons.
    *)
}
val anyoneCanAddSelf : (t, bool) GapiLens.t
val attachments : (t, EventAttachment.t list) GapiLens.t
val attendees : (t, EventAttendee.t list) GapiLens.t
val attendeesOmitted : (t, bool) GapiLens.t
val colorId : (t, string) GapiLens.t
val created : (t, GapiDate.t) GapiLens.t
val creator : (t, Creator.t) GapiLens.t
val description : (t, string) GapiLens.t
val _end : (t, EventDateTime.t) GapiLens.t
val endTimeUnspecified : (t, bool) GapiLens.t
val etag : (t, string) GapiLens.t
val extendedProperties : (t, ExtendedProperties.t) GapiLens.t
val gadget : (t, Gadget.t) GapiLens.t
val guestsCanInviteOthers : (t, bool) GapiLens.t
val guestsCanModify : (t, bool) GapiLens.t
val guestsCanSeeOtherGuests : (t, bool) GapiLens.t
val iCalUID : (t, string) GapiLens.t
val id : (t, string) GapiLens.t
val kind : (t, string) GapiLens.t
val location : (t, string) GapiLens.t
val locked : (t, bool) GapiLens.t
val organizer : (t, Organizer.t) GapiLens.t
val originalStartTime : (t, EventDateTime.t) GapiLens.t
val privateCopy : (t, bool) GapiLens.t
val recurrence : (t, string list) GapiLens.t
val recurringEventId : (t, string) GapiLens.t
val reminders : (t, Reminders.t) GapiLens.t
val sequence : (t, int) GapiLens.t
val source : (t, Source.t) GapiLens.t
val status : (t, string) GapiLens.t
val summary : (t, string) GapiLens.t
val transparency : (t, string) GapiLens.t
val updated : (t, GapiDate.t) GapiLens.t
val visibility : (t, string) GapiLens.t
val empty : t
val render : t -> GapiJson.json_data_model list
val parse : t -> GapiJson.json_data_model -> t
val to_data_model : t -> GapiJson.json_data_model
val of_data_model : GapiJson.json_data_model -> t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct