GoogleApi.Calendar.V3.Api.Acl.calendar_acl_list

You're seeing just the function calendar_acl_list, go back to GoogleApi.Calendar.V3.Api.Acl module for more information.
Link to this function

calendar_acl_list(connection, calendar_id, optional_params \\ [], opts \\ [])

View Source

Specs

calendar_acl_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Calendar.V3.Model.Acl.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Calendar.V3.Connection.t) - Connection to server
  • calendar_id (type: String.t) - 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.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :maxResults (type: integer()) - 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.
    • :pageToken (type: String.t) - Token specifying which result page to return. Optional.
    • :showDeleted (type: boolean()) - 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.
    • :syncToken (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Calendar.V3.Model.Acl{}} on success
  • {:error, info} on failure