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

API calls for all endpoints tagged Colors.

Link to this section Summary

Functions

Returns the color definitions for calendars and events.

Link to this section Functions

Link to this function

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

View Source

Specs

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

Returns the color definitions for calendars and events.

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

Returns

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