Class: Google::Apis::CalendarV3::CalendarService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/calendar_v3/service.rb

Overview

Calendar API

Manipulates events and other calendar data.

Examples:

require 'google/apis/calendar_v3'

Calendar = Google::Apis::CalendarV3 # Alias the module
service = Calendar::CalendarService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initializeCalendarService

Returns a new instance of CalendarService


49
50
51
52
# File 'generated/google/apis/calendar_v3/service.rb', line 49

def initialize
  super('https://www.googleapis.com/', 'calendar/v3/')
  @batch_path = 'batch/calendar/v3'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


38
39
40
# File 'generated/google/apis/calendar_v3/service.rb', line 38

def key
  @key
end

#quota_userString

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.


43
44
45
# File 'generated/google/apis/calendar_v3/service.rb', line 43

def quota_user
  @quota_user
end

#user_ipString

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String)

    Deprecated. Please use quotaUser instead.


47
48
49
# File 'generated/google/apis/calendar_v3/service.rb', line 47

def user_ip
  @user_ip
end

Instance Method Details

#clear_calendar(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


733
734
735
736
737
738
739
740
# File 'generated/google/apis/calendar_v3/service.rb', line 733

def clear_calendar(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'calendars/{calendarId}/clear', options)
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_acl(calendar_id, rule_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an access control rule.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • rule_id (String)

    ACL rule identifier.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


80
81
82
83
84
85
86
87
88
# File 'generated/google/apis/calendar_v3/service.rb', line 80

def delete_acl(calendar_id, rule_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'calendars/{calendarId}/acl/{ruleId}', options)
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.params['ruleId'] = rule_id unless rule_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_calendar(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


767
768
769
770
771
772
773
774
# File 'generated/google/apis/calendar_v3/service.rb', line 767

def delete_calendar(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'calendars/{calendarId}', options)
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_calendar_list(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Removes a calendar from the user's calendar list.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


405
406
407
408
409
410
411
412
# File 'generated/google/apis/calendar_v3/service.rb', line 405

def delete_calendar_list(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'users/me/calendarList/{calendarId}', options)
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_event(calendar_id, event_id, send_notifications: nil, send_updates: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an event.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • event_id (String)

    Event identifier.

  • send_notifications (Boolean)

    Deprecated. Please use sendUpdates instead. Whether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false.

  • send_updates (String)

    Guests who should receive notifications about the deletion of the event.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
# File 'generated/google/apis/calendar_v3/service.rb', line 1014

def delete_event(calendar_id, event_id, send_notifications: nil, send_updates: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'calendars/{calendarId}/events/{eventId}', options)
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.params['eventId'] = event_id unless event_id.nil?
  command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
  command.query['sendUpdates'] = send_updates unless send_updates.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_acl(calendar_id, rule_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::AclRule

Returns an access control rule.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • rule_id (String)

    ACL rule identifier.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


116
117
118
119
120
121
122
123
124
125
126
# File 'generated/google/apis/calendar_v3/service.rb', line 116

def get_acl(calendar_id, rule_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'calendars/{calendarId}/acl/{ruleId}', options)
  command.response_representation = Google::Apis::CalendarV3::AclRule::Representation
  command.response_class = Google::Apis::CalendarV3::AclRule
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.params['ruleId'] = rule_id unless rule_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_calendar(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Calendar

Returns metadata for a calendar.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


800
801
802
803
804
805
806
807
808
809
# File 'generated/google/apis/calendar_v3/service.rb', line 800

def get_calendar(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'calendars/{calendarId}', options)
  command.response_representation = Google::Apis::CalendarV3::Calendar::Representation
  command.response_class = Google::Apis::CalendarV3::Calendar
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_calendar_list(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::CalendarListEntry

Returns a calendar from the user's calendar list.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


438
439
440
441
442
443
444
445
446
447
# File 'generated/google/apis/calendar_v3/service.rb', line 438

def get_calendar_list(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'users/me/calendarList/{calendarId}', options)
  command.response_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
  command.response_class = Google::Apis::CalendarV3::CalendarListEntry
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_color(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Colors

Returns the color definitions for calendars and events.

Parameters:

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


971
972
973
974
975
976
977
978
979
# File 'generated/google/apis/calendar_v3/service.rb', line 971

def get_color(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'colors', options)
  command.response_representation = Google::Apis::CalendarV3::Colors::Representation
  command.response_class = Google::Apis::CalendarV3::Colors
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_event(calendar_id, event_id, always_include_email: nil, max_attendees: nil, time_zone: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Event

Returns an event.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • event_id (String)

    Event identifier.

  • always_include_email (Boolean)

    Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

  • max_attendees (Fixnum)

    The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

  • time_zone (String)

    Time zone used in the response. Optional. The default is the time zone of the calendar.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'generated/google/apis/calendar_v3/service.rb', line 1065

def get_event(calendar_id, event_id, always_include_email: nil, max_attendees: nil, time_zone: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'calendars/{calendarId}/events/{eventId}', options)
  command.response_representation = Google::Apis::CalendarV3::Event::Representation
  command.response_class = Google::Apis::CalendarV3::Event
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.params['eventId'] = event_id unless event_id.nil?
  command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
  command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
  command.query['timeZone'] = time_zone unless time_zone.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_setting(setting, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Setting

Returns a single user setting.

Parameters:

  • setting (String)

    The id of the user setting.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
# File 'generated/google/apis/calendar_v3/service.rb', line 1859

def get_setting(setting, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'users/me/settings/{setting}', options)
  command.response_representation = Google::Apis::CalendarV3::Setting::Representation
  command.response_class = Google::Apis::CalendarV3::Setting
  command.params['setting'] = setting unless setting.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#import_event(calendar_id, event_object = nil, conference_data_version: nil, supports_attachments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Event

Imports an event. This operation is used to add a private copy of an existing event to a calendar.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • event_object (Google::Apis::CalendarV3::Event) (defaults to: nil)
  • conference_data_version (Fixnum)

    Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.

  • supports_attachments (Boolean)

    Whether API client performing operation supports event attachments. Optional. The default is False.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
# File 'generated/google/apis/calendar_v3/service.rb', line 1115

def import_event(calendar_id, event_object = nil, conference_data_version: nil, supports_attachments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'calendars/{calendarId}/events/import', options)
  command.request_representation = Google::Apis::CalendarV3::Event::Representation
  command.request_object = event_object
  command.response_representation = Google::Apis::CalendarV3::Event::Representation
  command.response_class = Google::Apis::CalendarV3::Event
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['conferenceDataVersion'] = conference_data_version unless conference_data_version.nil?
  command.query['supportsAttachments'] = supports_attachments unless supports_attachments.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_acl(calendar_id, acl_rule_object = nil, send_notifications: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::AclRule

Creates an access control rule.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • acl_rule_object (Google::Apis::CalendarV3::AclRule) (defaults to: nil)
  • send_notifications (Boolean)

    Whether to send notifications about the calendar sharing change. Optional. The default is True.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'generated/google/apis/calendar_v3/service.rb', line 156

def insert_acl(calendar_id, acl_rule_object = nil, send_notifications: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'calendars/{calendarId}/acl', options)
  command.request_representation = Google::Apis::CalendarV3::AclRule::Representation
  command.request_object = acl_rule_object
  command.response_representation = Google::Apis::CalendarV3::AclRule::Representation
  command.response_class = Google::Apis::CalendarV3::AclRule
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_calendar(calendar_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Calendar

Creates a secondary calendar.

Parameters:

  • calendar_object (Google::Apis::CalendarV3::Calendar) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


832
833
834
835
836
837
838
839
840
841
842
# File 'generated/google/apis/calendar_v3/service.rb', line 832

def insert_calendar(calendar_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'calendars', options)
  command.request_representation = Google::Apis::CalendarV3::Calendar::Representation
  command.request_object = calendar_object
  command.response_representation = Google::Apis::CalendarV3::Calendar::Representation
  command.response_class = Google::Apis::CalendarV3::Calendar
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_calendar_list(calendar_list_entry_object = nil, color_rgb_format: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::CalendarListEntry

Inserts an existing calendar into the user's calendar list.

Parameters:

  • calendar_list_entry_object (Google::Apis::CalendarV3::CalendarListEntry) (defaults to: nil)
  • color_rgb_format (Boolean)

    Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


475
476
477
478
479
480
481
482
483
484
485
486
# File 'generated/google/apis/calendar_v3/service.rb', line 475

def insert_calendar_list(calendar_list_entry_object = nil, color_rgb_format: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'users/me/calendarList', options)
  command.request_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
  command.request_object = calendar_list_entry_object
  command.response_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
  command.response_class = Google::Apis::CalendarV3::CalendarListEntry
  command.query['colorRgbFormat'] = color_rgb_format unless color_rgb_format.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_event(calendar_id, event_object = nil, conference_data_version: nil, max_attendees: nil, send_notifications: nil, send_updates: nil, supports_attachments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Event

Creates an event.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • event_object (Google::Apis::CalendarV3::Event) (defaults to: nil)
  • conference_data_version (Fixnum)

    Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.

  • max_attendees (Fixnum)

    The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

  • send_notifications (Boolean)

    Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false.

  • send_updates (String)

    Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.

  • supports_attachments (Boolean)

    Whether API client performing operation supports event attachments. Optional. The default is False.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
# File 'generated/google/apis/calendar_v3/service.rb', line 1176

def insert_event(calendar_id, event_object = nil, conference_data_version: nil, max_attendees: nil, send_notifications: nil, send_updates: nil, supports_attachments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'calendars/{calendarId}/events', options)
  command.request_representation = Google::Apis::CalendarV3::Event::Representation
  command.request_object = event_object
  command.response_representation = Google::Apis::CalendarV3::Event::Representation
  command.response_class = Google::Apis::CalendarV3::Event
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['conferenceDataVersion'] = conference_data_version unless conference_data_version.nil?
  command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
  command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
  command.query['sendUpdates'] = send_updates unless send_updates.nil?
  command.query['supportsAttachments'] = supports_attachments unless supports_attachments.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_acls(calendar_id, max_results: nil, page_token: nil, show_deleted: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Acl

Returns the rules in the access control list for the calendar.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • max_results (Fixnum)

    Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

  • page_token (String)

    Token specifying which result page to return. Optional.

  • show_deleted (Boolean)

    Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.

  • sync_token (String)

    Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


214
215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'generated/google/apis/calendar_v3/service.rb', line 214

def list_acls(calendar_id, max_results: nil, page_token: nil, show_deleted: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'calendars/{calendarId}/acl', options)
  command.response_representation = Google::Apis::CalendarV3::Acl::Representation
  command.response_class = Google::Apis::CalendarV3::Acl
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['showDeleted'] = show_deleted unless show_deleted.nil?
  command.query['syncToken'] = sync_token unless sync_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_calendar_lists(max_results: nil, min_access_role: nil, page_token: nil, show_deleted: nil, show_hidden: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::CalendarList

Returns the calendars on the user's calendar list.

Parameters:

  • max_results (Fixnum)

    Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

  • min_access_role (String)

    The minimum access role for the user in the returned entries. Optional. The default is no restriction.

  • page_token (String)

    Token specifying which result page to return. Optional.

  • show_deleted (Boolean)

    Whether to include deleted calendar list entries in the result. Optional. The default is False.

  • show_hidden (Boolean)

    Whether to show hidden entries. Optional. The default is False.

  • sync_token (String)

    Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
# File 'generated/google/apis/calendar_v3/service.rb', line 536

def list_calendar_lists(max_results: nil, min_access_role: nil, page_token: nil, show_deleted: nil, show_hidden: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'users/me/calendarList', options)
  command.response_representation = Google::Apis::CalendarV3::CalendarList::Representation
  command.response_class = Google::Apis::CalendarV3::CalendarList
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['minAccessRole'] = min_access_role unless min_access_role.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['showDeleted'] = show_deleted unless show_deleted.nil?
  command.query['showHidden'] = show_hidden unless show_hidden.nil?
  command.query['syncToken'] = sync_token unless sync_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_event_instances(calendar_id, event_id, always_include_email: nil, max_attendees: nil, max_results: nil, original_start: nil, page_token: nil, show_deleted: nil, time_max: nil, time_min: nil, time_zone: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Events

Returns instances of the specified recurring event.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • event_id (String)

    Recurring event identifier.

  • always_include_email (Boolean)

    Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

  • max_attendees (Fixnum)

    The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

  • max_results (Fixnum)

    Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

  • original_start (String)

    The original start time of the instance in the result. Optional.

  • page_token (String)

    Token specifying which result page to return. Optional.

  • show_deleted (Boolean)

    Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.

  • time_max (DateTime)

    Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.

  • time_min (DateTime)

    Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.

  • time_zone (String)

    Time zone used in the response. Optional. The default is the time zone of the calendar.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
# File 'generated/google/apis/calendar_v3/service.rb', line 1252

def list_event_instances(calendar_id, event_id, always_include_email: nil, max_attendees: nil, max_results: nil, original_start: nil, page_token: nil, show_deleted: nil, time_max: nil, time_min: nil, time_zone: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'calendars/{calendarId}/events/{eventId}/instances', options)
  command.response_representation = Google::Apis::CalendarV3::Events::Representation
  command.response_class = Google::Apis::CalendarV3::Events
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.params['eventId'] = event_id unless event_id.nil?
  command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
  command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['originalStart'] = original_start unless original_start.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['showDeleted'] = show_deleted unless show_deleted.nil?
  command.query['timeMax'] = time_max unless time_max.nil?
  command.query['timeMin'] = time_min unless time_min.nil?
  command.query['timeZone'] = time_zone unless time_zone.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_events(calendar_id, always_include_email: nil, i_cal_uid: nil, max_attendees: nil, max_results: nil, order_by: nil, page_token: nil, private_extended_property: nil, q: nil, shared_extended_property: nil, show_deleted: nil, show_hidden_invitations: nil, single_events: nil, sync_token: nil, time_max: nil, time_min: nil, time_zone: nil, updated_min: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Events

Returns events on the specified calendar.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • always_include_email (Boolean)

    Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

  • i_cal_uid (String)

    Specifies event ID in the iCalendar format to be included in the response. Optional.

  • max_attendees (Fixnum)

    The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

  • max_results (Fixnum)

    Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non- empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

  • order_by (String)

    The order of the events returned in the result. Optional. The default is an unspecified, stable order.

  • page_token (String)

    Token specifying which result page to return. Optional.

  • private_extended_property (Array<String>, String)

    Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.

  • q (String)

    Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

  • shared_extended_property (Array<String>, String)

    Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.

  • show_deleted (Boolean)

    Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.

  • show_hidden_invitations (Boolean)

    Whether to include hidden invitations in the result. Optional. The default is False.

  • single_events (Boolean)

    Whether to expand recurring events into instances and only return single one- off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.

  • sync_token (String)

    Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are:

    • iCalUID
    • orderBy
    • privateExtendedProperty
    • q
    • sharedExtendedProperty
    • timeMin
    • timeMax
    • updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
  • time_max (DateTime)

    Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00: 00Z. Milliseconds may be provided but will be ignored. If timeMin is set, timeMax must be greater than timeMin.

  • time_min (DateTime)

    Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00: 00Z. Milliseconds may be provided but will be ignored. If timeMax is set, timeMin must be smaller than timeMax.

  • time_zone (String)

    Time zone used in the response. Optional. The default is the time zone of the calendar.

  • updated_min (DateTime)

    Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
# File 'generated/google/apis/calendar_v3/service.rb', line 1387

def list_events(calendar_id, always_include_email: nil, i_cal_uid: nil, max_attendees: nil, max_results: nil, order_by: nil, page_token: nil, private_extended_property: nil, q: nil, shared_extended_property: nil, show_deleted: nil, show_hidden_invitations: nil, single_events: nil, sync_token: nil, time_max: nil, time_min: nil, time_zone: nil, updated_min: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'calendars/{calendarId}/events', options)
  command.response_representation = Google::Apis::CalendarV3::Events::Representation
  command.response_class = Google::Apis::CalendarV3::Events
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
  command.query['iCalUID'] = i_cal_uid unless i_cal_uid.nil?
  command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['privateExtendedProperty'] = private_extended_property unless private_extended_property.nil?
  command.query['q'] = q unless q.nil?
  command.query['sharedExtendedProperty'] = shared_extended_property unless shared_extended_property.nil?
  command.query['showDeleted'] = show_deleted unless show_deleted.nil?
  command.query['showHiddenInvitations'] = show_hidden_invitations unless show_hidden_invitations.nil?
  command.query['singleEvents'] = single_events unless single_events.nil?
  command.query['syncToken'] = sync_token unless sync_token.nil?
  command.query['timeMax'] = time_max unless time_max.nil?
  command.query['timeMin'] = time_min unless time_min.nil?
  command.query['timeZone'] = time_zone unless time_zone.nil?
  command.query['updatedMin'] = updated_min unless updated_min.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_settings(max_results: nil, page_token: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Settings

Returns all user settings for the authenticated user.

Parameters:

  • max_results (Fixnum)

    Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

  • page_token (String)

    Token specifying which result page to return. Optional.

  • sync_token (String)

    Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
# File 'generated/google/apis/calendar_v3/service.rb', line 1904

def list_settings(max_results: nil, page_token: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'users/me/settings', options)
  command.response_representation = Google::Apis::CalendarV3::Settings::Representation
  command.response_class = Google::Apis::CalendarV3::Settings
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['syncToken'] = sync_token unless sync_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#move_event(calendar_id, event_id, destination, send_notifications: nil, send_updates: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Event

Moves an event to another calendar, i.e. changes an event's organizer.

Parameters:

  • calendar_id (String)

    Calendar identifier of the source calendar where the event currently is on.

  • event_id (String)

    Event identifier.

  • destination (String)

    Calendar identifier of the target calendar where the event is to be moved to.

  • send_notifications (Boolean)

    Deprecated. Please use sendUpdates instead. Whether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false.

  • send_updates (String)

    Guests who should receive notifications about the change of the event's organizer.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
# File 'generated/google/apis/calendar_v3/service.rb', line 1449

def move_event(calendar_id, event_id, destination, send_notifications: nil, send_updates: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'calendars/{calendarId}/events/{eventId}/move', options)
  command.response_representation = Google::Apis::CalendarV3::Event::Representation
  command.response_class = Google::Apis::CalendarV3::Event
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.params['eventId'] = event_id unless event_id.nil?
  command.query['destination'] = destination unless destination.nil?
  command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
  command.query['sendUpdates'] = send_updates unless send_updates.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_acl(calendar_id, rule_id, acl_rule_object = nil, send_notifications: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::AclRule

Updates an access control rule. This method supports patch semantics.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • rule_id (String)

    ACL rule identifier.

  • acl_rule_object (Google::Apis::CalendarV3::AclRule) (defaults to: nil)
  • send_notifications (Boolean)

    Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'generated/google/apis/calendar_v3/service.rb', line 259

def patch_acl(calendar_id, rule_id, acl_rule_object = nil, send_notifications: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'calendars/{calendarId}/acl/{ruleId}', options)
  command.request_representation = Google::Apis::CalendarV3::AclRule::Representation
  command.request_object = acl_rule_object
  command.response_representation = Google::Apis::CalendarV3::AclRule::Representation
  command.response_class = Google::Apis::CalendarV3::AclRule
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.params['ruleId'] = rule_id unless rule_id.nil?
  command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_calendar(calendar_id, calendar_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Calendar

Updates metadata for a calendar. This method supports patch semantics.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • calendar_object (Google::Apis::CalendarV3::Calendar) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


869
870
871
872
873
874
875
876
877
878
879
880
# File 'generated/google/apis/calendar_v3/service.rb', line 869

def patch_calendar(calendar_id, calendar_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'calendars/{calendarId}', options)
  command.request_representation = Google::Apis::CalendarV3::Calendar::Representation
  command.request_object = calendar_object
  command.response_representation = Google::Apis::CalendarV3::Calendar::Representation
  command.response_class = Google::Apis::CalendarV3::Calendar
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_calendar_list(calendar_id, calendar_list_entry_object = nil, color_rgb_format: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::CalendarListEntry

Updates an existing calendar on the user's calendar list. This method supports patch semantics.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • calendar_list_entry_object (Google::Apis::CalendarV3::CalendarListEntry) (defaults to: nil)
  • color_rgb_format (Boolean)

    Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


583
584
585
586
587
588
589
590
591
592
593
594
595
# File 'generated/google/apis/calendar_v3/service.rb', line 583

def patch_calendar_list(calendar_id, calendar_list_entry_object = nil, color_rgb_format: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'users/me/calendarList/{calendarId}', options)
  command.request_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
  command.request_object = calendar_list_entry_object
  command.response_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
  command.response_class = Google::Apis::CalendarV3::CalendarListEntry
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['colorRgbFormat'] = color_rgb_format unless color_rgb_format.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_event(calendar_id, event_id, event_object = nil, always_include_email: nil, conference_data_version: nil, max_attendees: nil, send_notifications: nil, send_updates: nil, supports_attachments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Event

Updates an event. This method supports patch semantics.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • event_id (String)

    Event identifier.

  • event_object (Google::Apis::CalendarV3::Event) (defaults to: nil)
  • always_include_email (Boolean)

    Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

  • conference_data_version (Fixnum)

    Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.

  • max_attendees (Fixnum)

    The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

  • send_notifications (Boolean)

    Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.

  • send_updates (String)

    Guests who should receive notifications about the event update (for example, title changes, etc.).

  • supports_attachments (Boolean)

    Whether API client performing operation supports event attachments. Optional. The default is False.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'generated/google/apis/calendar_v3/service.rb', line 1518

def patch_event(calendar_id, event_id, event_object = nil, always_include_email: nil, conference_data_version: nil, max_attendees: nil, send_notifications: nil, send_updates: nil, supports_attachments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'calendars/{calendarId}/events/{eventId}', options)
  command.request_representation = Google::Apis::CalendarV3::Event::Representation
  command.request_object = event_object
  command.response_representation = Google::Apis::CalendarV3::Event::Representation
  command.response_class = Google::Apis::CalendarV3::Event
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.params['eventId'] = event_id unless event_id.nil?
  command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
  command.query['conferenceDataVersion'] = conference_data_version unless conference_data_version.nil?
  command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
  command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
  command.query['sendUpdates'] = send_updates unless send_updates.nil?
  command.query['supportsAttachments'] = supports_attachments unless supports_attachments.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#query_freebusy(free_busy_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::FreeBusyResponse

Returns free/busy information for a set of calendars.

Parameters:

  • free_busy_request_object (Google::Apis::CalendarV3::FreeBusyRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
# File 'generated/google/apis/calendar_v3/service.rb', line 1825

def query_freebusy(free_busy_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'freeBusy', options)
  command.request_representation = Google::Apis::CalendarV3::FreeBusyRequest::Representation
  command.request_object = free_busy_request_object
  command.response_representation = Google::Apis::CalendarV3::FreeBusyResponse::Representation
  command.response_class = Google::Apis::CalendarV3::FreeBusyResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#quick_add_event(calendar_id, text, send_notifications: nil, send_updates: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Event

Creates an event based on a simple text string.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • text (String)

    The text describing the event to be created.

  • send_notifications (Boolean)

    Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false.

  • send_updates (String)

    Guests who should receive notifications about the creation of the new event.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
# File 'generated/google/apis/calendar_v3/service.rb', line 1571

def quick_add_event(calendar_id, text, send_notifications: nil, send_updates: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'calendars/{calendarId}/events/quickAdd', options)
  command.response_representation = Google::Apis::CalendarV3::Event::Representation
  command.response_class = Google::Apis::CalendarV3::Event
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
  command.query['sendUpdates'] = send_updates unless send_updates.nil?
  command.query['text'] = text unless text.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Stop watching resources through this channel

Parameters:

  • channel_object (Google::Apis::CalendarV3::Channel) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


941
942
943
944
945
946
947
948
949
# File 'generated/google/apis/calendar_v3/service.rb', line 941

def stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'channels/stop', options)
  command.request_representation = Google::Apis::CalendarV3::Channel::Representation
  command.request_object = channel_object
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_acl(calendar_id, rule_id, acl_rule_object = nil, send_notifications: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::AclRule

Updates an access control rule.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • rule_id (String)

    ACL rule identifier.

  • acl_rule_object (Google::Apis::CalendarV3::AclRule) (defaults to: nil)
  • send_notifications (Boolean)

    Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


304
305
306
307
308
309
310
311
312
313
314
315
316
317
# File 'generated/google/apis/calendar_v3/service.rb', line 304

def update_acl(calendar_id, rule_id, acl_rule_object = nil, send_notifications: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'calendars/{calendarId}/acl/{ruleId}', options)
  command.request_representation = Google::Apis::CalendarV3::AclRule::Representation
  command.request_object = acl_rule_object
  command.response_representation = Google::Apis::CalendarV3::AclRule::Representation
  command.response_class = Google::Apis::CalendarV3::AclRule
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.params['ruleId'] = rule_id unless rule_id.nil?
  command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_calendar(calendar_id, calendar_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Calendar

Updates metadata for a calendar.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • calendar_object (Google::Apis::CalendarV3::Calendar) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


907
908
909
910
911
912
913
914
915
916
917
918
# File 'generated/google/apis/calendar_v3/service.rb', line 907

def update_calendar(calendar_id, calendar_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'calendars/{calendarId}', options)
  command.request_representation = Google::Apis::CalendarV3::Calendar::Representation
  command.request_object = calendar_object
  command.response_representation = Google::Apis::CalendarV3::Calendar::Representation
  command.response_class = Google::Apis::CalendarV3::Calendar
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_calendar_list(calendar_id, calendar_list_entry_object = nil, color_rgb_format: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::CalendarListEntry

Updates an existing calendar on the user's calendar list.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • calendar_list_entry_object (Google::Apis::CalendarV3::CalendarListEntry) (defaults to: nil)
  • color_rgb_format (Boolean)

    Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


627
628
629
630
631
632
633
634
635
636
637
638
639
# File 'generated/google/apis/calendar_v3/service.rb', line 627

def update_calendar_list(calendar_id, calendar_list_entry_object = nil, color_rgb_format: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'users/me/calendarList/{calendarId}', options)
  command.request_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
  command.request_object = calendar_list_entry_object
  command.response_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
  command.response_class = Google::Apis::CalendarV3::CalendarListEntry
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['colorRgbFormat'] = color_rgb_format unless color_rgb_format.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_event(calendar_id, event_id, event_object = nil, always_include_email: nil, conference_data_version: nil, max_attendees: nil, send_notifications: nil, send_updates: nil, supports_attachments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Event

Updates an event.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • event_id (String)

    Event identifier.

  • event_object (Google::Apis::CalendarV3::Event) (defaults to: nil)
  • always_include_email (Boolean)

    Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

  • conference_data_version (Fixnum)

    Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.

  • max_attendees (Fixnum)

    The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

  • send_notifications (Boolean)

    Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.

  • send_updates (String)

    Guests who should receive notifications about the event update (for example, title changes, etc.).

  • supports_attachments (Boolean)

    Whether API client performing operation supports event attachments. Optional. The default is False.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
# File 'generated/google/apis/calendar_v3/service.rb', line 1639

def update_event(calendar_id, event_id, event_object = nil, always_include_email: nil, conference_data_version: nil, max_attendees: nil, send_notifications: nil, send_updates: nil, supports_attachments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'calendars/{calendarId}/events/{eventId}', options)
  command.request_representation = Google::Apis::CalendarV3::Event::Representation
  command.request_object = event_object
  command.response_representation = Google::Apis::CalendarV3::Event::Representation
  command.response_class = Google::Apis::CalendarV3::Event
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.params['eventId'] = event_id unless event_id.nil?
  command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
  command.query['conferenceDataVersion'] = conference_data_version unless conference_data_version.nil?
  command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
  command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
  command.query['sendUpdates'] = send_updates unless send_updates.nil?
  command.query['supportsAttachments'] = supports_attachments unless supports_attachments.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#watch_acl(calendar_id, channel_object = nil, max_results: nil, page_token: nil, show_deleted: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Channel

Watch for changes to ACL resources.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • channel_object (Google::Apis::CalendarV3::Channel) (defaults to: nil)
  • max_results (Fixnum)

    Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

  • page_token (String)

    Token specifying which result page to return. Optional.

  • show_deleted (Boolean)

    Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.

  • sync_token (String)

    Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
# File 'generated/google/apis/calendar_v3/service.rb', line 364

def watch_acl(calendar_id, channel_object = nil, max_results: nil, page_token: nil, show_deleted: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'calendars/{calendarId}/acl/watch', options)
  command.request_representation = Google::Apis::CalendarV3::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::CalendarV3::Channel::Representation
  command.response_class = Google::Apis::CalendarV3::Channel
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['showDeleted'] = show_deleted unless show_deleted.nil?
  command.query['syncToken'] = sync_token unless sync_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#watch_calendar_list(channel_object = nil, max_results: nil, min_access_role: nil, page_token: nil, show_deleted: nil, show_hidden: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Channel

Watch for changes to CalendarList resources.

Parameters:

  • channel_object (Google::Apis::CalendarV3::Channel) (defaults to: nil)
  • max_results (Fixnum)

    Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

  • min_access_role (String)

    The minimum access role for the user in the returned entries. Optional. The default is no restriction.

  • page_token (String)

    Token specifying which result page to return. Optional.

  • show_deleted (Boolean)

    Whether to include deleted calendar list entries in the result. Optional. The default is False.

  • show_hidden (Boolean)

    Whether to show hidden entries. Optional. The default is False.

  • sync_token (String)

    Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
# File 'generated/google/apis/calendar_v3/service.rb', line 690

def watch_calendar_list(channel_object = nil, max_results: nil, min_access_role: nil, page_token: nil, show_deleted: nil, show_hidden: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'users/me/calendarList/watch', options)
  command.request_representation = Google::Apis::CalendarV3::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::CalendarV3::Channel::Representation
  command.response_class = Google::Apis::CalendarV3::Channel
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['minAccessRole'] = min_access_role unless min_access_role.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['showDeleted'] = show_deleted unless show_deleted.nil?
  command.query['showHidden'] = show_hidden unless show_hidden.nil?
  command.query['syncToken'] = sync_token unless sync_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#watch_event(calendar_id, channel_object = nil, always_include_email: nil, i_cal_uid: nil, max_attendees: nil, max_results: nil, order_by: nil, page_token: nil, private_extended_property: nil, q: nil, shared_extended_property: nil, show_deleted: nil, show_hidden_invitations: nil, single_events: nil, sync_token: nil, time_max: nil, time_min: nil, time_zone: nil, updated_min: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Channel

Watch for changes to Events resources.

Parameters:

  • calendar_id (String)

    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • channel_object (Google::Apis::CalendarV3::Channel) (defaults to: nil)
  • always_include_email (Boolean)

    Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

  • i_cal_uid (String)

    Specifies event ID in the iCalendar format to be included in the response. Optional.

  • max_attendees (Fixnum)

    The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

  • max_results (Fixnum)

    Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non- empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

  • order_by (String)

    The order of the events returned in the result. Optional. The default is an unspecified, stable order.

  • page_token (String)

    Token specifying which result page to return. Optional.

  • private_extended_property (Array<String>, String)

    Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.

  • q (String)

    Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

  • shared_extended_property (Array<String>, String)

    Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.

  • show_deleted (Boolean)

    Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.

  • show_hidden_invitations (Boolean)

    Whether to include hidden invitations in the result. Optional. The default is False.

  • single_events (Boolean)

    Whether to expand recurring events into instances and only return single one- off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.

  • sync_token (String)

    Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are:

    • iCalUID
    • orderBy
    • privateExtendedProperty
    • q
    • sharedExtendedProperty
    • timeMin
    • timeMax
    • updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
  • time_max (DateTime)

    Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00: 00Z. Milliseconds may be provided but will be ignored. If timeMin is set, timeMax must be greater than timeMin.

  • time_min (DateTime)

    Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00: 00Z. Milliseconds may be provided but will be ignored. If timeMax is set, timeMin must be smaller than timeMax.

  • time_zone (String)

    Time zone used in the response. Optional. The default is the time zone of the calendar.

  • updated_min (DateTime)

    Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
# File 'generated/google/apis/calendar_v3/service.rb', line 1774

def watch_event(calendar_id, channel_object = nil, always_include_email: nil, i_cal_uid: nil, max_attendees: nil, max_results: nil, order_by: nil, page_token: nil, private_extended_property: nil, q: nil, shared_extended_property: nil, show_deleted: nil, show_hidden_invitations: nil, single_events: nil, sync_token: nil, time_max: nil, time_min: nil, time_zone: nil, updated_min: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'calendars/{calendarId}/events/watch', options)
  command.request_representation = Google::Apis::CalendarV3::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::CalendarV3::Channel::Representation
  command.response_class = Google::Apis::CalendarV3::Channel
  command.params['calendarId'] = calendar_id unless calendar_id.nil?
  command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
  command.query['iCalUID'] = i_cal_uid unless i_cal_uid.nil?
  command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['privateExtendedProperty'] = private_extended_property unless private_extended_property.nil?
  command.query['q'] = q unless q.nil?
  command.query['sharedExtendedProperty'] = shared_extended_property unless shared_extended_property.nil?
  command.query['showDeleted'] = show_deleted unless show_deleted.nil?
  command.query['showHiddenInvitations'] = show_hidden_invitations unless show_hidden_invitations.nil?
  command.query['singleEvents'] = single_events unless single_events.nil?
  command.query['syncToken'] = sync_token unless sync_token.nil?
  command.query['timeMax'] = time_max unless time_max.nil?
  command.query['timeMin'] = time_min unless time_min.nil?
  command.query['timeZone'] = time_zone unless time_zone.nil?
  command.query['updatedMin'] = updated_min unless updated_min.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#watch_setting(channel_object = nil, max_results: nil, page_token: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CalendarV3::Channel

Watch for changes to Settings resources.

Parameters:

  • channel_object (Google::Apis::CalendarV3::Channel) (defaults to: nil)
  • max_results (Fixnum)

    Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

  • page_token (String)

    Token specifying which result page to return. Optional.

  • sync_token (String)

    Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
# File 'generated/google/apis/calendar_v3/service.rb', line 1952

def watch_setting(channel_object = nil, max_results: nil, page_token: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'users/me/settings/watch', options)
  command.request_representation = Google::Apis::CalendarV3::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::CalendarV3::Channel::Representation
  command.response_class = Google::Apis::CalendarV3::Channel
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['syncToken'] = sync_token unless sync_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end