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



1785
1786
1787
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1785

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) 


1728
1729
1730
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1728

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:



1735
1736
1737
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1735

def default_reminders
  @default_reminders
end

#description ⇒ String

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

Returns:

  • (String) 


1740
1741
1742
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1740

def description
  @description
end

#etag ⇒ String

ETag of the collection. Corresponds to the JSON property etag

Returns:

  • (String) 


1745
1746
1747
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1745

def etag
  @etag
end

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

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

Returns:



1750
1751
1752
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1750

def items
  @items
end

#kind ⇒ String

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

Returns:

  • (String) 


1755
1756
1757
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1755

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) 


1761
1762
1763
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1761

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) 


1768
1769
1770
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1768

def next_sync_token
  @next_sync_token
end

#summary ⇒ String

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

Returns:

  • (String) 


1773
1774
1775
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1773

def summary
  @summary
end

#time_zone ⇒ String

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

Returns:

  • (String) 


1778
1779
1780
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1778

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) 


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

def updated
  @updated
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1790

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