class Google::Apis::CalendarV3::CalendarListEntry

Attributes

access_role[RW]

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. Corresponds to the JSON property `accessRole` @return [String]

background_color[RW]

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. Corresponds to the JSON property `backgroundColor` @return [String]

color_id[RW]

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. Corresponds to the JSON property `colorId` @return [String]

default_reminders[RW]

The default reminders that the authenticated user has for this calendar. Corresponds to the JSON property `defaultReminders` @return [Array<Google::Apis::CalendarV3::EventReminder>]

deleted[RW]

Whether this calendar list entry has been deleted from the calendar list. Read- only. Optional. The default is False. Corresponds to the JSON property `deleted` @return [Boolean]

deleted?[RW]

Whether this calendar list entry has been deleted from the calendar list. Read- only. Optional. The default is False. Corresponds to the JSON property `deleted` @return [Boolean]

description[RW]

Description of the calendar. Optional. Read-only. Corresponds to the JSON property `description` @return [String]

etag[RW]

ETag of the resource. Corresponds to the JSON property `etag` @return [String]

foreground_color[RW]

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. Corresponds to the JSON property `foregroundColor` @return [String]

hidden[RW]

Whether the calendar has been hidden from the list. Optional. The default is False. Corresponds to the JSON property `hidden` @return [Boolean]

hidden?[RW]

Whether the calendar has been hidden from the list. Optional. The default is False. Corresponds to the JSON property `hidden` @return [Boolean]

id[RW]

Identifier of the calendar. Corresponds to the JSON property `id` @return [String]

kind[RW]

Type of the resource (“calendar#calendarListEntry”). Corresponds to the JSON property `kind` @return [String]

location[RW]

Geographic location of the calendar as free-form text. Optional. Read-only. Corresponds to the JSON property `location` @return [String]

notification_settings[RW]

The notifications that the authenticated user is receiving for this calendar. Corresponds to the JSON property `notificationSettings` @return [Google::Apis::CalendarV3::CalendarListEntry::NotificationSettings]

primary[RW]

Whether the calendar is the primary calendar of the authenticated user. Read- only. Optional. The default is False. Corresponds to the JSON property `primary` @return [Boolean]

primary?[RW]

Whether the calendar is the primary calendar of the authenticated user. Read- only. Optional. The default is False. Corresponds to the JSON property `primary` @return [Boolean]

selected[RW]

Whether the calendar content shows up in the calendar UI. Optional. The default is False. Corresponds to the JSON property `selected` @return [Boolean]

selected?[RW]

Whether the calendar content shows up in the calendar UI. Optional. The default is False. Corresponds to the JSON property `selected` @return [Boolean]

summary[RW]

Title of the calendar. Read-only. Corresponds to the JSON property `summary` @return [String]

summary_override[RW]

The summary that the authenticated user has set for this calendar. Optional. Corresponds to the JSON property `summaryOverride` @return [String]

time_zone[RW]

The time zone of the calendar. Optional. Read-only. Corresponds to the JSON property `timeZone` @return [String]

Public Class Methods

new(**args) click to toggle source
# File generated/google/apis/calendar_v3/classes.rb, line 377
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File generated/google/apis/calendar_v3/classes.rb, line 382
def update!(**args)
  @access_role = args[:access_role] if args.key?(:access_role)
  @background_color = args[:background_color] if args.key?(:background_color)
  @color_id = args[:color_id] if args.key?(:color_id)
  @default_reminders = args[:default_reminders] if args.key?(:default_reminders)
  @deleted = args[:deleted] if args.key?(:deleted)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @foreground_color = args[:foreground_color] if args.key?(:foreground_color)
  @hidden = args[:hidden] if args.key?(:hidden)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @location = args[:location] if args.key?(:location)
  @notification_settings = args[:notification_settings] if args.key?(:notification_settings)
  @primary = args[:primary] if args.key?(:primary)
  @selected = args[:selected] if args.key?(:selected)
  @summary = args[:summary] if args.key?(:summary)
  @summary_override = args[:summary_override] if args.key?(:summary_override)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
end