Class: Google::Apis::CalendarV3::Events

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

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) ⇒ Events

Returns a new instance of Events



1832
1833
1834
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1832

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

Instance Attribute Details

#access_role ⇒ String

The user's access role for this calendar. Read-only. Possible values are:

  • "none" - The user has no access.
  • "freeBusyReader" - The user has read access to free/busy information.
  • "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
  • "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
  • "owner" - The user has 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) 


1775
1776
1777
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1775

def access_role
  @access_role
end

#default_reminders ⇒ Array<Google::Apis::CalendarV3::EventReminder>

The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True). Corresponds to the JSON property defaultReminders

Returns:



1782
1783
1784
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1782

def default_reminders
  @default_reminders
end

#description ⇒ String

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

Returns:

  • (String) 


1787
1788
1789
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1787

def description
  @description
end

#etag ⇒ String

ETag of the collection. Corresponds to the JSON property etag

Returns:

  • (String) 


1792
1793
1794
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1792

def etag
  @etag
end

#items ⇒ Array<Google::Apis::CalendarV3::Event>

List of events on the calendar. Corresponds to the JSON property items

Returns:



1797
1798
1799
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1797

def items
  @items
end

#kind ⇒ String

Type of the collection ("calendar#events"). Corresponds to the JSON property kind

Returns:

  • (String) 


1802
1803
1804
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1802

def kind
  @kind
end

#next_page_token ⇒ String

Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. Corresponds to the JSON property nextPageToken

Returns:

  • (String) 


1808
1809
1810
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1808

def next_page_token
  @next_page_token
end

#next_sync_token ⇒ String

Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. Corresponds to the JSON property nextSyncToken

Returns:

  • (String) 


1815
1816
1817
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1815

def next_sync_token
  @next_sync_token
end

#summary ⇒ String

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

Returns:

  • (String) 


1820
1821
1822
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1820

def summary
  @summary
end

#time_zone ⇒ String

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

Returns:

  • (String) 


1825
1826
1827
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1825

def time_zone
  @time_zone
end

#updated ⇒ DateTime

Last modification time of the calendar (as a RFC3339 timestamp). Read-only. Corresponds to the JSON property updated

Returns:

  • (DateTime) 


1830
1831
1832
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1830

def updated
  @updated
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1837

def update!(**args)
  @access_role = args[:access_role] if args.key?(:access_role)
  @default_reminders = args[:default_reminders] if args.key?(:default_reminders)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @items = args[:items] if args.key?(:items)
  @kind = args[:kind] if args.key?(:kind)
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
  @next_sync_token = args[:next_sync_token] if args.key?(:next_sync_token)
  @summary = args[:summary] if args.key?(:summary)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @updated = args[:updated] if args.key?(:updated)
end