GoogleApi.Calendar.V3.Api.CalendarList (google_api_calendar v0.21.3) View Source

API calls for all endpoints tagged CalendarList.

Link to this section Summary

Functions

Inserts an existing calendar into the user's calendar list.

Returns the calendars on the user's calendar list.

Updates an existing calendar on the user's calendar list. This method supports patch semantics.

Updates an existing calendar on the user's calendar list.

Link to this section Functions

Link to this function

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

View Source

Specs

calendar_calendar_list_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Removes a calendar from the user's calendar list.

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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

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

Returns a calendar from the user's calendar list.

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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Calendar.V3.Model.CalendarListEntry{}} on success
  • {:error, info} on failure
Link to this function

calendar_calendar_list_insert(connection, optional_params \\ [], opts \\ [])

View Source

Specs

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

Inserts an existing calendar into the user's calendar list.

Parameters

  • connection (type: GoogleApi.Calendar.V3.Connection.t) - Connection to server
  • 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.
    • :colorRgbFormat (type: boolean()) - Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
    • :body (type: GoogleApi.Calendar.V3.Model.CalendarListEntry.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Calendar.V3.Model.CalendarListEntry{}} on success
  • {:error, info} on failure
Link to this function

calendar_calendar_list_list(connection, optional_params \\ [], opts \\ [])

View Source

Specs

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

Returns the calendars on the user's calendar list.

Parameters

  • connection (type: GoogleApi.Calendar.V3.Connection.t) - Connection to server
  • 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.
    • :minAccessRole (type: String.t) - The minimum access role for the user in the returned entries. Optional. The default is no restriction.
    • :pageToken (type: String.t) - Token specifying which result page to return. Optional.
    • :showDeleted (type: boolean()) - Whether to include deleted calendar list entries in the result. Optional. The default is False.
    • :showHidden (type: boolean()) - Whether to show hidden entries. 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. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. 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.CalendarList{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

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

Updates an existing calendar on the user's calendar list. This method supports patch semantics.

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.
    • :colorRgbFormat (type: boolean()) - Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
    • :body (type: GoogleApi.Calendar.V3.Model.CalendarListEntry.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Calendar.V3.Model.CalendarListEntry{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

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

Updates an existing calendar on the user's calendar list.

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.
    • :colorRgbFormat (type: boolean()) - Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.
    • :body (type: GoogleApi.Calendar.V3.Model.CalendarListEntry.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Calendar.V3.Model.CalendarListEntry{}} on success
  • {:error, info} on failure
Link to this function

calendar_calendar_list_watch(connection, optional_params \\ [], opts \\ [])

View Source

Specs

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

Watch for changes to CalendarList resources.

Parameters

  • connection (type: GoogleApi.Calendar.V3.Connection.t) - Connection to server
  • 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.
    • :minAccessRole (type: String.t) - The minimum access role for the user in the returned entries. Optional. The default is no restriction.
    • :pageToken (type: String.t) - Token specifying which result page to return. Optional.
    • :showDeleted (type: boolean()) - Whether to include deleted calendar list entries in the result. Optional. The default is False.
    • :showHidden (type: boolean()) - Whether to show hidden entries. 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. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. 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.
    • :resource (type: GoogleApi.Calendar.V3.Model.Channel.t) -
  • opts (type: keyword()) - Call options

Returns

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