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.


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

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)

273
274
275
# File 'generated/google/apis/calendar_v3/classes.rb', line 273

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)

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

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)

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

def color_id
  @color_id
end

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

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


294
295
296
# File 'generated/google/apis/calendar_v3/classes.rb', line 294

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)

300
301
302
# File 'generated/google/apis/calendar_v3/classes.rb', line 300

def deleted
  @deleted
end

#descriptionString

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

Returns:

  • (String)

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

def description
  @description
end

#etagString

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String)

311
312
313
# File 'generated/google/apis/calendar_v3/classes.rb', line 311

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)

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

def foreground_color
  @foreground_color
end

#hiddenBoolean Also known as: hidden?

Whether the calendar has been hidden from the list. Optional. The default is False. Corresponds to the JSON property hidden

Returns:

  • (Boolean)

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

def hidden
  @hidden
end

#idString

Identifier of the calendar. Corresponds to the JSON property id

Returns:

  • (String)

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

def id
  @id
end

#kindString

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

Returns:

  • (String)

336
337
338
# File 'generated/google/apis/calendar_v3/classes.rb', line 336

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)

341
342
343
# File 'generated/google/apis/calendar_v3/classes.rb', line 341

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


346
347
348
# File 'generated/google/apis/calendar_v3/classes.rb', line 346

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)

352
353
354
# File 'generated/google/apis/calendar_v3/classes.rb', line 352

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)

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

def selected
  @selected
end

#summaryString

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

Returns:

  • (String)

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

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)

370
371
372
# File 'generated/google/apis/calendar_v3/classes.rb', line 370

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)

375
376
377
# File 'generated/google/apis/calendar_v3/classes.rb', line 375

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
# 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