Class: Google::Apis::CalendarV3::Event

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/calendar_v3/classes.rb,
generated/google/apis/calendar_v3/representations.rb,
generated/google/apis/calendar_v3/representations.rb

Defined Under Namespace

Classes: Creator, ExtendedProperties, Gadget, Organizer, Reminders, Source

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Event

Returns a new instance of Event



1279
1280
1281
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1279

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

Instance Attribute Details

#anyone_can_add_self ⇒ Boolean Also known as: anyone_can_add_self?

Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. Corresponds to the JSON property anyoneCanAddSelf

Returns:

  • (Boolean) 


1016
1017
1018
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1016

def anyone_can_add_self
  @anyone_can_add_self
end

#attachments ⇒ Array<Google::Apis::CalendarV3::EventAttachment>

File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event, Corresponds to the JSON property attachments

Returns:



1026
1027
1028
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1026

def attachments
  @attachments
end

#attendees ⇒ Array<Google::Apis::CalendarV3::EventAttendee>

The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Corresponds to the JSON property attendees

Returns:



1032
1033
1034
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1032

def attendees
  @attendees
end

#attendees_omitted ⇒ Boolean Also known as: attendees_omitted?

Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False. Corresponds to the JSON property attendeesOmitted

Returns:

  • (Boolean) 


1040
1041
1042
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1040

def attendees_omitted
  @attendees_omitted
end

#color_id ⇒ String

The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. Corresponds to the JSON property colorId

Returns:

  • (String) 


1047
1048
1049
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1047

def color_id
  @color_id
end

#conference_data ⇒ Google::Apis::CalendarV3::ConferenceData

The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. Corresponds to the JSON property conferenceData

Returns:



1055
1056
1057
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1055

def conference_data
  @conference_data
end

#created ⇒ DateTime

Creation time of the event (as a RFC3339 timestamp). Read-only. Corresponds to the JSON property created

Returns:

  • (DateTime) 


1060
1061
1062
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1060

def created
  @created
end

#creator ⇒ Google::Apis::CalendarV3::Event::Creator

The creator of the event. Read-only. Corresponds to the JSON property creator

Returns:



1065
1066
1067
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1065

def creator
  @creator
end

#description ⇒ String

Description of the event. Optional. Corresponds to the JSON property description

Returns:

  • (String) 


1070
1071
1072
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1070

def description
  @description
end

#end ⇒ Google::Apis::CalendarV3::EventDateTime

The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. Corresponds to the JSON property end

Returns:



1076
1077
1078
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1076

def end
  @end
end

#end_time_unspecified ⇒ Boolean Also known as: end_time_unspecified?

Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. Corresponds to the JSON property endTimeUnspecified

Returns:

  • (Boolean) 


1083
1084
1085
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1083

def end_time_unspecified
  @end_time_unspecified
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


1089
1090
1091
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1089

def etag
  @etag
end

#extended_properties ⇒ Google::Apis::CalendarV3::Event::ExtendedProperties

Extended properties of the event. Corresponds to the JSON property extendedProperties

Returns:



1094
1095
1096
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1094

def extended_properties
  @extended_properties
end

#gadget ⇒ Google::Apis::CalendarV3::Event::Gadget

A gadget that extends this event. Corresponds to the JSON property gadget

Returns:



1099
1100
1101
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1099

def gadget
  @gadget
end

#guests_can_invite_others ⇒ Boolean Also known as: guests_can_invite_others?

Whether attendees other than the organizer can invite others to the event. Optional. The default is True. Corresponds to the JSON property guestsCanInviteOthers

Returns:

  • (Boolean) 


1105
1106
1107
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1105

def guests_can_invite_others
  @guests_can_invite_others
end

#guests_can_modify ⇒ Boolean Also known as: guests_can_modify?

Whether attendees other than the organizer can modify the event. Optional. The default is False. Corresponds to the JSON property guestsCanModify

Returns:

  • (Boolean) 


1112
1113
1114
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1112

def guests_can_modify
  @guests_can_modify
end

#guests_can_see_other_guests ⇒ Boolean Also known as: guests_can_see_other_guests?

Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. Corresponds to the JSON property guestsCanSeeOtherGuests

Returns:

  • (Boolean) 


1119
1120
1121
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1119

def guests_can_see_other_guests
  @guests_can_see_other_guests
end

#hangout_link ⇒ String

An absolute link to the Google+ hangout associated with this event. Read-only. Corresponds to the JSON property hangoutLink

Returns:

  • (String) 


1125
1126
1127
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1125

def hangout_link
  @hangout_link
end

#html_link ⇒ String

An absolute link to this event in the Google Calendar Web UI. Read-only. Corresponds to the JSON property htmlLink

Returns:

  • (String) 


1130
1131
1132
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1130

def html_link
  @html_link
end

#i_cal_uid ⇒ String

Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs. Corresponds to the JSON property iCalUID

Returns:

  • (String) 


1141
1142
1143
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1141

def i_cal_uid
  @i_cal_uid
end

#id ⇒ String

Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:

  • characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
  • the length of the ID must be between 5 and 1024 characters
  • the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs. Corresponds to the JSON property id

Returns:

  • (String) 


1159
1160
1161
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1159

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


1164
1165
1166
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1164

def kind
  @kind
end

#location ⇒ String

Geographic location of the event as free-form text. Optional. Corresponds to the JSON property location

Returns:

  • (String) 


1169
1170
1171
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1169

def location
  @location
end

#locked ⇒ Boolean Also known as: locked?

Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or " recurrence". The default is False. Read-Only. Corresponds to the JSON property locked

Returns:

  • (Boolean) 


1176
1177
1178
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1176

def locked
  @locked
end

#organizer ⇒ Google::Apis::CalendarV3::Event::Organizer

The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event. Corresponds to the JSON property organizer

Returns:



1185
1186
1187
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1185

def organizer
  @organizer
end

#original_start_time ⇒ Google::Apis::CalendarV3::EventDateTime

For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable. Corresponds to the JSON property originalStartTime

Returns:



1192
1193
1194
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1192

def original_start_time
  @original_start_time
end

#private_copy ⇒ Boolean Also known as: private_copy?

Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. Corresponds to the JSON property privateCopy

Returns:

  • (Boolean) 


1198
1199
1200
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1198

def private_copy
  @private_copy
end

#recurrence ⇒ Array<String>

List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events. Corresponds to the JSON property recurrence

Returns:

  • (Array<String>) 


1208
1209
1210
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1208

def recurrence
  @recurrence
end

#recurring_event_id ⇒ String

For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. Corresponds to the JSON property recurringEventId

Returns:

  • (String) 


1214
1215
1216
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1214

def recurring_event_id
  @recurring_event_id
end

#reminders ⇒ Google::Apis::CalendarV3::Event::Reminders

Information about the event's reminders for the authenticated user. Corresponds to the JSON property reminders

Returns:



1219
1220
1221
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1219

def reminders
  @reminders
end

#sequence ⇒ Fixnum

Sequence number as per iCalendar. Corresponds to the JSON property sequence

Returns:

  • (Fixnum) 


1224
1225
1226
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1224

def sequence
  @sequence
end

#source ⇒ Google::Apis::CalendarV3::Event::Source

Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. Corresponds to the JSON property source

Returns:



1231
1232
1233
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1231

def source
  @source
end

#start ⇒ Google::Apis::CalendarV3::EventDateTime

The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. Corresponds to the JSON property start

Returns:



1237
1238
1239
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1237

def start
  @start
end

#status ⇒ String

Status of the event. Optional. Possible values are:

  • "confirmed" - The event is confirmed. This is the default status.
  • "tentative" - The event is tentatively confirmed.
  • "cancelled" - The event is cancelled. Corresponds to the JSON property status

Returns:

  • (String) 


1245
1246
1247
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1245

def status
  @status
end

#summary ⇒ String

Title of the event. Corresponds to the JSON property summary

Returns:

  • (String) 


1250
1251
1252
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1250

def summary
  @summary
end

#transparency ⇒ String

Whether the event blocks time on the calendar. Optional. Possible values are:

  • "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
  • "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. Corresponds to the JSON property transparency

Returns:

  • (String) 


1259
1260
1261
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1259

def transparency
  @transparency
end

#updated ⇒ DateTime

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

Returns:

  • (DateTime) 


1264
1265
1266
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1264

def updated
  @updated
end

#visibility ⇒ String

Visibility of the event. Optional. Possible values are:

  • "default" - Uses the default visibility for events on the calendar. This is the default value.
  • "public" - The event is public and event details are visible to all readers of the calendar.
  • "private" - The event is private and only event attendees may view event details.
  • "confidential" - The event is private. This value is provided for compatibility reasons. Corresponds to the JSON property visibility

Returns:

  • (String) 


1277
1278
1279
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1277

def visibility
  @visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'generated/google/apis/calendar_v3/classes.rb', line 1284

def update!(**args)
  @anyone_can_add_self = args[:anyone_can_add_self] if args.key?(:anyone_can_add_self)
  @attachments = args[:attachments] if args.key?(:attachments)
  @attendees = args[:attendees] if args.key?(:attendees)
  @attendees_omitted = args[:attendees_omitted] if args.key?(:attendees_omitted)
  @color_id = args[:color_id] if args.key?(:color_id)
  @conference_data = args[:conference_data] if args.key?(:conference_data)
  @created = args[:created] if args.key?(:created)
  @creator = args[:creator] if args.key?(:creator)
  @description = args[:description] if args.key?(:description)
  @end = args[:end] if args.key?(:end)
  @end_time_unspecified = args[:end_time_unspecified] if args.key?(:end_time_unspecified)
  @etag = args[:etag] if args.key?(:etag)
  @extended_properties = args[:extended_properties] if args.key?(:extended_properties)
  @gadget = args[:gadget] if args.key?(:gadget)
  @guests_can_invite_others = args[:guests_can_invite_others] if args.key?(:guests_can_invite_others)
  @guests_can_modify = args[:guests_can_modify] if args.key?(:guests_can_modify)
  @guests_can_see_other_guests = args[:guests_can_see_other_guests] if args.key?(:guests_can_see_other_guests)
  @hangout_link = args[:hangout_link] if args.key?(:hangout_link)
  @html_link = args[:html_link] if args.key?(:html_link)
  @i_cal_uid = args[:i_cal_uid] if args.key?(:i_cal_uid)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @location = args[:location] if args.key?(:location)
  @locked = args[:locked] if args.key?(:locked)
  @organizer = args[:organizer] if args.key?(:organizer)
  @original_start_time = args[:original_start_time] if args.key?(:original_start_time)
  @private_copy = args[:private_copy] if args.key?(:private_copy)
  @recurrence = args[:recurrence] if args.key?(:recurrence)
  @recurring_event_id = args[:recurring_event_id] if args.key?(:recurring_event_id)
  @reminders = args[:reminders] if args.key?(:reminders)
  @sequence = args[:sequence] if args.key?(:sequence)
  @source = args[:source] if args.key?(:source)
  @start = args[:start] if args.key?(:start)
  @status = args[:status] if args.key?(:status)
  @summary = args[:summary] if args.key?(:summary)
  @transparency = args[:transparency] if args.key?(:transparency)
  @updated = args[:updated] if args.key?(:updated)
  @visibility = args[:visibility] if args.key?(:visibility)
end