Class: Google::Apis::CalendarV3::CalendarListEntry

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/calendar_v3/classes.rb,
generated/google/apis/calendar_v3/representations.rb,
generated/google/apis/calendar_v3/representations.rb

Defined Under Namespace

Classes: NotificationSettings

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CalendarListEntry

Returns a new instance of CalendarListEntry.


390
391
392
# File 'generated/google/apis/calendar_v3/classes.rb', line 390

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#access_roleString

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

Returns:

  • (String)

280
281
282
# File 'generated/google/apis/calendar_v3/classes.rb', line 280

def access_role
  @access_role
end

#background_colorString

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

Returns:

  • (String)

288
289
290
# File 'generated/google/apis/calendar_v3/classes.rb', line 288

def background_color
  @background_color
end

#color_idString

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

Returns:

  • (String)

296
297
298
# File 'generated/google/apis/calendar_v3/classes.rb', line 296

def color_id
  @color_id
end

#conference_propertiesGoogle::Apis::CalendarV3::ConferenceProperties

Conferencing properties for this calendar, for example what types of conferences are allowed. Corresponds to the JSON property conferenceProperties


302
303
304
# File 'generated/google/apis/calendar_v3/classes.rb', line 302

def conference_properties
  @conference_properties
end

#default_remindersArray<Google::Apis::CalendarV3::EventReminder>

The default reminders that the authenticated user has for this calendar. Corresponds to the JSON property defaultReminders


307
308
309
# File 'generated/google/apis/calendar_v3/classes.rb', line 307

def default_reminders
  @default_reminders
end

#deletedBoolean Also known as: deleted?

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

Returns:

  • (Boolean)

313
314
315
# File 'generated/google/apis/calendar_v3/classes.rb', line 313

def deleted
  @deleted
end

#descriptionString

Description of the calendar. Optional. Read-only. Corresponds to the JSON property description

Returns:

  • (String)

319
320
321
# File 'generated/google/apis/calendar_v3/classes.rb', line 319

def description
  @description
end

#etagString

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String)

324
325
326
# File 'generated/google/apis/calendar_v3/classes.rb', line 324

def etag
  @etag
end

#foreground_colorString

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

Returns:

  • (String)

332
333
334
# File 'generated/google/apis/calendar_v3/classes.rb', line 332

def foreground_color
  @foreground_color
end

#hiddenBoolean Also known as: hidden?

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. Corresponds to the JSON property hidden

Returns:

  • (Boolean)

338
339
340
# File 'generated/google/apis/calendar_v3/classes.rb', line 338

def hidden
  @hidden
end

#idString

Identifier of the calendar. Corresponds to the JSON property id

Returns:

  • (String)

344
345
346
# File 'generated/google/apis/calendar_v3/classes.rb', line 344

def id
  @id
end

#kindString

Type of the resource ("calendar#calendarListEntry"). Corresponds to the JSON property kind

Returns:

  • (String)

349
350
351
# File 'generated/google/apis/calendar_v3/classes.rb', line 349

def kind
  @kind
end

#locationString

Geographic location of the calendar as free-form text. Optional. Read-only. Corresponds to the JSON property location

Returns:

  • (String)

354
355
356
# File 'generated/google/apis/calendar_v3/classes.rb', line 354

def location
  @location
end

#notification_settingsGoogle::Apis::CalendarV3::CalendarListEntry::NotificationSettings

The notifications that the authenticated user is receiving for this calendar. Corresponds to the JSON property notificationSettings


359
360
361
# File 'generated/google/apis/calendar_v3/classes.rb', line 359

def notification_settings
  @notification_settings
end

#primaryBoolean Also known as: primary?

Whether the calendar is the primary calendar of the authenticated user. Read- only. Optional. The default is False. Corresponds to the JSON property primary

Returns:

  • (Boolean)

365
366
367
# File 'generated/google/apis/calendar_v3/classes.rb', line 365

def primary
  @primary
end

#selectedBoolean Also known as: selected?

Whether the calendar content shows up in the calendar UI. Optional. The default is False. Corresponds to the JSON property selected

Returns:

  • (Boolean)

372
373
374
# File 'generated/google/apis/calendar_v3/classes.rb', line 372

def selected
  @selected
end

#summaryString

Title of the calendar. Read-only. Corresponds to the JSON property summary

Returns:

  • (String)

378
379
380
# File 'generated/google/apis/calendar_v3/classes.rb', line 378

def summary
  @summary
end

#summary_overrideString

The summary that the authenticated user has set for this calendar. Optional. Corresponds to the JSON property summaryOverride

Returns:

  • (String)

383
384
385
# File 'generated/google/apis/calendar_v3/classes.rb', line 383

def summary_override
  @summary_override
end

#time_zoneString

The time zone of the calendar. Optional. Read-only. Corresponds to the JSON property timeZone

Returns:

  • (String)

388
389
390
# File 'generated/google/apis/calendar_v3/classes.rb', line 388

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
# File 'generated/google/apis/calendar_v3/classes.rb', line 395

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)
  @conference_properties = args[:conference_properties] if args.key?(:conference_properties)
  @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