package gapi-ocaml

  1. Overview
  2. Docs

Module GapiCalendarV3Service.AclResourceSource

Sourceval get : ?base_url:string -> ?etag:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> calendarId:string -> ruleId:string -> GapiConversation.Session.t -> GapiCalendarV3Model.AclRule.t * GapiConversation.Session.t

Returns an access control rule.

  • 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 custom_headers

    Optional HTTP custom headers.

  • 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 ruleId

    ACL rule identifier.

Sourceval list : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> ?showDeleted:bool -> ?syncToken:string -> ?pageToken:string -> ?maxResults:int -> calendarId:string -> GapiConversation.Session.t -> GapiCalendarV3Model.Acl.t * GapiConversation.Session.t

Returns the rules in the access control list for the calendar.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter custom_headers

    Optional HTTP custom headers.

  • parameter showDeleted

    Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. 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 entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. 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 pageToken

    Token specifying which result page to return. Optional.

  • parameter maxResults

    Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

  • 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.

Sourceval delete : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> calendarId:string -> ruleId:string -> GapiConversation.Session.t -> unit * GapiConversation.Session.t

Deletes an access control rule.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter custom_headers

    Optional HTTP custom headers.

  • 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 ruleId

    ACL rule identifier.

Sourceval insert : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> ?sendNotifications:bool -> calendarId:string -> GapiCalendarV3Model.AclRule.t -> GapiConversation.Session.t -> GapiCalendarV3Model.AclRule.t * GapiConversation.Session.t

Creates an access control rule.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter custom_headers

    Optional HTTP custom headers.

  • parameter sendNotifications

    Whether to send notifications about the calendar sharing change. Optional. The default is True.

  • 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.

Sourceval update : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> ?sendNotifications:bool -> calendarId:string -> ruleId:string -> GapiCalendarV3Model.AclRule.t -> GapiConversation.Session.t -> GapiCalendarV3Model.AclRule.t * GapiConversation.Session.t

Updates an access control rule.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter custom_headers

    Optional HTTP custom headers.

  • parameter sendNotifications

    Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.

  • 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 ruleId

    ACL rule identifier.

Sourceval patch : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> ?sendNotifications:bool -> calendarId:string -> ruleId:string -> GapiCalendarV3Model.AclRule.t -> GapiConversation.Session.t -> GapiCalendarV3Model.AclRule.t * GapiConversation.Session.t

Updates an access control rule. 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 custom_headers

    Optional HTTP custom headers.

  • parameter sendNotifications

    Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.

  • 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 ruleId

    ACL rule identifier.

Sourceval watch : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> ?maxResults:int -> ?showDeleted:bool -> ?syncToken:string -> ?pageToken:string -> calendarId:string -> GapiCalendarV3Model.Channel.t -> GapiConversation.Session.t -> GapiCalendarV3Model.Channel.t * GapiConversation.Session.t

Watch for changes to ACL resources.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter custom_headers

    Optional HTTP custom headers.

  • parameter maxResults

    Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

  • parameter showDeleted

    Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. 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 entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. 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 pageToken

    Token specifying which result page to return. Optional.

  • 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.