GoogleApi.Calendar.V3.Model.CalendarListEntry (google_api_calendar v0.21.3) View Source

Attributes

  • accessRole (type: String.t, default: nil) - The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
    • "freeBusyReader" - Provides read access to free/busy information.
    • "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
    • "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
    • "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
  • backgroundColor (type: String.t, default: nil) - The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
  • colorId (type: String.t, default: nil) - The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.
  • conferenceProperties (type: GoogleApi.Calendar.V3.Model.ConferenceProperties.t, default: nil) - Conferencing properties for this calendar, for example what types of conferences are allowed.
  • defaultReminders (type: list(GoogleApi.Calendar.V3.Model.EventReminder.t), default: nil) - The default reminders that the authenticated user has for this calendar.
  • deleted (type: boolean(), default: false) - Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.
  • description (type: String.t, default: nil) - Description of the calendar. Optional. Read-only.
  • etag (type: String.t, default: nil) - ETag of the resource.
  • foregroundColor (type: String.t, default: nil) - The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.
  • hidden (type: boolean(), default: false) - Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true.
  • id (type: String.t, default: nil) - Identifier of the calendar.
  • kind (type: String.t, default: calendar#calendarListEntry) - Type of the resource ("calendar#calendarListEntry").
  • location (type: String.t, default: nil) - Geographic location of the calendar as free-form text. Optional. Read-only.
  • notificationSettings (type: GoogleApi.Calendar.V3.Model.CalendarListEntryNotificationSettings.t, default: nil) - The notifications that the authenticated user is receiving for this calendar.
  • primary (type: boolean(), default: false) - Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
  • selected (type: boolean(), default: false) - Whether the calendar content shows up in the calendar UI. Optional. The default is False.
  • summary (type: String.t, default: nil) - Title of the calendar. Read-only.
  • summaryOverride (type: String.t, default: nil) - The summary that the authenticated user has set for this calendar. Optional.
  • timeZone (type: String.t, default: nil) - The time zone of the calendar. Optional. Read-only.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Calendar.V3.Model.CalendarListEntry{
  accessRole: String.t() | nil,
  backgroundColor: String.t() | nil,
  colorId: String.t() | nil,
  conferenceProperties:
    GoogleApi.Calendar.V3.Model.ConferenceProperties.t() | nil,
  defaultReminders: [GoogleApi.Calendar.V3.Model.EventReminder.t()] | nil,
  deleted: boolean() | nil,
  description: String.t() | nil,
  etag: String.t() | nil,
  foregroundColor: String.t() | nil,
  hidden: boolean() | nil,
  id: String.t() | nil,
  kind: String.t() | nil,
  location: String.t() | nil,
  notificationSettings:
    GoogleApi.Calendar.V3.Model.CalendarListEntryNotificationSettings.t() | nil,
  primary: boolean() | nil,
  selected: boolean() | nil,
  summary: String.t() | nil,
  summaryOverride: String.t() | nil,
  timeZone: String.t() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.