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



1880
1881
1882
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1880

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) 


1823
1824
1825
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1823

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:



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

def default_reminders
  @default_reminders
end

#description ⇒ String

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

Returns:

  • (String) 


1835
1836
1837
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1835

def description
  @description
end

#etag ⇒ String

ETag of the collection. Corresponds to the JSON property etag

Returns:

  • (String) 


1840
1841
1842
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1840

def etag
  @etag
end

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

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

Returns:



1845
1846
1847
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1845

def items
  @items
end

#kind ⇒ String

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

Returns:

  • (String) 


1850
1851
1852
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1850

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) 


1856
1857
1858
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1856

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) 


1863
1864
1865
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1863

def next_sync_token
  @next_sync_token
end

#summary ⇒ String

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

Returns:

  • (String) 


1868
1869
1870
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1868

def summary
  @summary
end

#time_zone ⇒ String

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

Returns:

  • (String) 


1873
1874
1875
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1873

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) 


1878
1879
1880
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1878

def updated
  @updated
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1885

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