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

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

Defined Under Namespace

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Event

Returns a new instance of Event.



1335
1336
1337
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1335

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 (deprecated). Optional. The default is False. Corresponds to the JSON property anyoneCanAddSelf

Returns:

  • (Boolean) 


1038
1039
1040
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1038

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:



1048
1049
1050
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1048

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. Service accounts need to use domain-wide delegation of authority to populate the attendee list. Corresponds to the JSON property attendees

Returns:



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

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) 


1063
1064
1065
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1063

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) 


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

def color_id
  @color_id
end

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

The conference-related information, such as details of a Google 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:



1078
1079
1080
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1078

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) 


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

def created
  @created
end

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

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

Returns:



1088
1089
1090
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1088

def creator
  @creator
end

#description ⇒ String

Description of the event. Can contain HTML. Optional. Corresponds to the JSON property description

Returns:

  • (String) 


1093
1094
1095
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1093

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:



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

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) 


1106
1107
1108
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1106

def end_time_unspecified
  @end_time_unspecified
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


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

def etag
  @etag
end

#event_type ⇒ String

Specific type of the event. Read-only. Possible values are:

  • "default" - A regular event or not further specified.
  • "outOfOffice" - An out-of-office event.
  • "focusTime" - A focus-time event. Corresponds to the JSON property eventType

Returns:

  • (String) 


1120
1121
1122
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1120

def event_type
  @event_type
end

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

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

Returns:



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

def extended_properties
  @extended_properties
end

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

A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata. Corresponds to the JSON property gadget

Returns:



1131
1132
1133
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1131

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) 


1137
1138
1139
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1137

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) 


1144
1145
1146
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1144

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) 


1151
1152
1153
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1151

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) 


1157
1158
1159
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1157

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) 


1162
1163
1164
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1162

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) 


1173
1174
1175
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1173

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) 


1191
1192
1193
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1191

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


1196
1197
1198
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1196

def kind
  @kind
end

#location ⇒ String

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

Returns:

  • (String) 


1201
1202
1203
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1201

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) 


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

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:



1217
1218
1219
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1217

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. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. Corresponds to the JSON property originalStartTime

Returns:



1225
1226
1227
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1225

def original_start_time
  @original_start_time
end

#private_copy ⇒ Boolean Also known as: private_copy?

If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False. Corresponds to the JSON property privateCopy

Returns:

  • (Boolean) 


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

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


1241
1242
1243
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1241

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) 


1247
1248
1249
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1247

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:



1252
1253
1254
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1252

def reminders
  @reminders
end

#sequence ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1257
1258
1259
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1257

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:



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

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:



1270
1271
1272
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1270

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 (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type:

  • Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

  • All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details ( summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. Corresponds to the JSON property status

Returns:

  • (String) 


1301
1302
1303
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1301

def status
  @status
end

#summary ⇒ String

Title of the event. Corresponds to the JSON property summary

Returns:

  • (String) 


1306
1307
1308
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1306

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) 


1315
1316
1317
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1315

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) 


1320
1321
1322
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1320

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) 


1333
1334
1335
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1333

def visibility
  @visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
 
# File 'lib/google/apis/calendar_v3/classes.rb', line 1340

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)
  @event_type = args[:event_type] if args.key?(:event_type)
  @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