package gapi-ocaml

You can search for identifiers within the package.

in-package search v0.2.0

gapi-ocaml
gapi-ocaml.gdata
- GdataACL
  - Entry
  - Feed
  - Rel
  - RoleWithKey
  - Scope
- GdataACLService
- GdataAtom
  - AtomData
  - Author
  - BasicEntry
  - Category
  - Content
  - Contributor
  - Feed
  - Generator
  - GenericExtensions
  - Link
  - LinkRelation
  - MakeFeed
    
    Entry
    
    Extensions
    
    Link
  - MakePersonConstruct
    
    M
  - MakeTextConstruct
    
    M
  - PersonConstruct
  - Rel
  - Rights
  - Subtitle
  - Summary
  - TextConstruct
  - Title
- GdataBatch
- GdataCalendar
  - Comments
    
    Entry
    
    Feed
  - Entry
  - ExtendedProperty
  - Feed
  - Link
  - OriginalEvent
  - Rel
  - Reminder
  - ResourceProperty
  - WebContent
  - WebContentGadgetPref
  - When
  - Where
  - Who
- GdataCalendarEvent
- GdataCalendarService
  - QueryParameters
- GdataComments
  - Comments
    
    Entry
    
    Feed
  - Make
    
    Entry
    
    Feed
    
    Link
- GdataCore
  - Metadata
- GdataDocumentsV3Model
  - AclFeedLink
  - AdditionalRoleInfo
  - AdditionalRoleSet
  - Archive
    
    Conversion
    
    Entry
  - Document
    
    DocumentFeedExtensions
    
    Entry
    
    Feed
  - DocumentFormat
  - ExportFormat
  - Feature
  - ImportFormat
  - MakeDocumentFormat
    
    M
  - MaxUploadSize
  - Metadata
    
    Entry
  - Rel
  - Revision
    
    Entry
    
    Feed
  - RevisionsFeedLink
- GdataDocumentsV3Service
  - QueryParameters
- GdataExtensions
  - FeedLink
  - LastModifiedBy
  - MakeFeedLink
    
    Feed
  - Rel
- GdataService
- GdataUtils

Legend:
Library
Module
Module type
Parameter
Class
Class type

module OrderBy : sig ... end

val delete : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?sendNotifications:bool ->
  calendarId:string ->
  eventId:string ->
  GapiConversation.Session.t ->
  unit * GapiConversation.Session.t

Deletes an event.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter sendNotifications
Whether to send notifications about the deletion of the event. Optional. The default is False.

parameter calendarId
Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

parameter eventId
Event identifier.

val get : 
  ?base_url:string ->
  ?etag:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?alwaysIncludeEmail:bool ->
  ?maxAttendees:int ->
  ?timeZone:string ->
  calendarId:string ->
  eventId:string ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Event.t * GapiConversation.Session.t

Returns an event.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter etag
Optional ETag.

parameter std_params
Optional standard parameters.

parameter alwaysIncludeEmail
Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

parameter maxAttendees
The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

parameter timeZone
Time zone used in the response. Optional. The default is the time zone of the calendar.

parameter calendarId
Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

parameter eventId
Event identifier.

val import : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?supportsAttachments:bool ->
  calendarId:string ->
  GapiCalendarV3Model.Event.t ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Event.t * GapiConversation.Session.t

Imports an event. This operation is used to add a private copy of an existing event to a calendar.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter supportsAttachments
Whether API client performing operation supports event attachments. Optional. The default is False.

parameter calendarId
Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

val insert : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?maxAttendees:int ->
  ?sendNotifications:bool ->
  ?supportsAttachments:bool ->
  calendarId:string ->
  GapiCalendarV3Model.Event.t ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Event.t * GapiConversation.Session.t

Creates an event.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter maxAttendees
The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

parameter sendNotifications
Whether to send notifications about the creation of the new event. Optional. The default is False.

parameter supportsAttachments
Whether API client performing operation supports event attachments. Optional. The default is False.

parameter calendarId
Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

val instances : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?alwaysIncludeEmail:bool ->
  ?maxAttendees:int ->
  ?maxResults:int ->
  ?originalStart:string ->
  ?pageToken:string ->
  ?showDeleted:bool ->
  ?timeMax:GapiDate.t ->
  ?timeMin:GapiDate.t ->
  ?timeZone:string ->
  calendarId:string ->
  eventId:string ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Events.t * GapiConversation.Session.t

Returns instances of the specified recurring event.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter alwaysIncludeEmail
Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

parameter maxAttendees
The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

parameter maxResults
Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

parameter originalStart
The original start time of the instance in the result. Optional.

parameter pageToken
Token specifying which result page to return. Optional.

parameter showDeleted
Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.

parameter timeMax
Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.

parameter timeMin
Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.

parameter timeZone
Time zone used in the response. Optional. The default is the time zone of the calendar.

parameter calendarId
Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

parameter eventId
Recurring event identifier.

val list : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?alwaysIncludeEmail:bool ->
  ?iCalUID:string ->
  ?maxAttendees:int ->
  ?maxResults:int ->
  ?orderBy:OrderBy.t ->
  ?pageToken:string ->
  ?privateExtendedProperty:string list ->
  ?q:string ->
  ?sharedExtendedProperty:string list ->
  ?showDeleted:bool ->
  ?showHiddenInvitations:bool ->
  ?singleEvents:bool ->
  ?syncToken:string ->
  ?timeMax:GapiDate.t ->
  ?timeMin:GapiDate.t ->
  ?timeZone:string ->
  ?updatedMin:GapiDate.t ->
  calendarId:string ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Events.t * GapiConversation.Session.t

Returns events on the specified calendar.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter alwaysIncludeEmail
Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

parameter iCalUID
Specifies event ID in the iCalendar format to be included in the response. Optional.

parameter maxAttendees
The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

parameter maxResults
Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

parameter orderBy
The order of the events returned in the result. Optional. The default is an unspecified, stable order.

parameter pageToken
Token specifying which result page to return. Optional.

parameter privateExtendedProperty
Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.

parameter q
Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

parameter sharedExtendedProperty
Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.

parameter showDeleted
Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.

parameter showHiddenInvitations
Whether to include hidden invitations in the result. Optional. The default is False.

parameter singleEvents
Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.

parameter syncToken
Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.
These are:
- iCalUID
- orderBy
- privateExtendedProperty
- q
- sharedExtendedProperty
- timeMin
- timeMax
- updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

parameter timeMax
Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.

parameter timeMin
Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.

parameter timeZone
Time zone used in the response. Optional. The default is the time zone of the calendar.

parameter updatedMin
Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.

parameter calendarId
Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

val move : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?sendNotifications:bool ->
  calendarId:string ->
  eventId:string ->
  destination:string ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Event.t * GapiConversation.Session.t

Moves an event to another calendar, i.e. changes an event's organizer.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter sendNotifications
Whether to send notifications about the change of the event's organizer. Optional. The default is False.

parameter calendarId
Calendar identifier of the source calendar where the event currently is on.

parameter eventId
Event identifier.

parameter destination
Calendar identifier of the target calendar where the event is to be moved to.

val patch : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?alwaysIncludeEmail:bool ->
  ?maxAttendees:int ->
  ?sendNotifications:bool ->
  ?supportsAttachments:bool ->
  calendarId:string ->
  eventId:string ->
  GapiCalendarV3Model.Event.t ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Event.t * GapiConversation.Session.t

Updates an event. This method supports patch semantics.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter alwaysIncludeEmail
Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

parameter maxAttendees
The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

parameter sendNotifications
Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.

parameter supportsAttachments
Whether API client performing operation supports event attachments. Optional. The default is False.

parameter calendarId
Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

parameter eventId
Event identifier.

val quickAdd : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?sendNotifications:bool ->
  calendarId:string ->
  text:string ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Event.t * GapiConversation.Session.t

Creates an event based on a simple text string.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter sendNotifications
Whether to send notifications about the creation of the event. Optional. The default is False.

parameter calendarId
Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

parameter text
The text describing the event to be created.

val update : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?alwaysIncludeEmail:bool ->
  ?maxAttendees:int ->
  ?sendNotifications:bool ->
  ?supportsAttachments:bool ->
  calendarId:string ->
  eventId:string ->
  GapiCalendarV3Model.Event.t ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Event.t * GapiConversation.Session.t

Updates an event.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter alwaysIncludeEmail
Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

parameter maxAttendees
The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

parameter sendNotifications
Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.

parameter supportsAttachments
Whether API client performing operation supports event attachments. Optional. The default is False.

parameter calendarId
Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

parameter eventId
Event identifier.

val watch : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?alwaysIncludeEmail:bool ->
  ?iCalUID:string ->
  ?maxAttendees:int ->
  ?maxResults:int ->
  ?orderBy:OrderBy.t ->
  ?pageToken:string ->
  ?privateExtendedProperty:string list ->
  ?q:string ->
  ?sharedExtendedProperty:string list ->
  ?showDeleted:bool ->
  ?showHiddenInvitations:bool ->
  ?singleEvents:bool ->
  ?syncToken:string ->
  ?timeMax:GapiDate.t ->
  ?timeMin:GapiDate.t ->
  ?timeZone:string ->
  ?updatedMin:GapiDate.t ->
  calendarId:string ->
  GapiCalendarV3Model.Channel.t ->
  GapiConversation.Session.t ->
  GapiCalendarV3Model.Channel.t * GapiConversation.Session.t

Watch for changes to Events resources.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/calendar/v3/").

parameter std_params
Optional standard parameters.

parameter alwaysIncludeEmail
Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

parameter iCalUID
Specifies event ID in the iCalendar format to be included in the response. Optional.

parameter maxAttendees
The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

parameter maxResults
Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

parameter orderBy
The order of the events returned in the result. Optional. The default is an unspecified, stable order.

parameter pageToken
Token specifying which result page to return. Optional.

parameter privateExtendedProperty
Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.

parameter q
Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

parameter sharedExtendedProperty
Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.

parameter showDeleted
Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.

parameter showHiddenInvitations
Whether to include hidden invitations in the result. Optional. The default is False.

parameter singleEvents
Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.

parameter syncToken
Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.
These are:
- iCalUID
- orderBy
- privateExtendedProperty
- q
- sharedExtendedProperty
- timeMin
- timeMax
- updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

parameter timeMax
Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.

parameter timeMin
Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored.

parameter timeZone
Time zone used in the response. Optional. The default is the time zone of the calendar.

parameter updatedMin
Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.

parameter calendarId
Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.