Class: Google::Apis::CalendarV3::Event
- Inherits:
-
Object
- Object
- Google::Apis::CalendarV3::Event
- 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
-
#anyone_can_add_self ⇒ Boolean
(also: #anyone_can_add_self?)
Whether anyone can invite themselves to the event (currently works for Google+ events only).
-
#attachments ⇒ Array<Google::Apis::CalendarV3::EventAttachment>
File attachments for the event.
-
#attendees ⇒ Array<Google::Apis::CalendarV3::EventAttendee>
The attendees of the event.
-
#attendees_omitted ⇒ Boolean
(also: #attendees_omitted?)
Whether attendees may have been omitted from the event's representation.
-
#color_id ⇒ String
The color of the event.
-
#conference_data ⇒ Google::Apis::CalendarV3::ConferenceData
The conference-related information, such as details of a Hangouts Meet conference.
-
#created ⇒ DateTime
Creation time of the event (as a RFC3339 timestamp).
-
#creator ⇒ Google::Apis::CalendarV3::Event::Creator
The creator of the event.
-
#description ⇒ String
Description of the event.
-
#end ⇒ Google::Apis::CalendarV3::EventDateTime
The (exclusive) end time of the event.
-
#end_time_unspecified ⇒ Boolean
(also: #end_time_unspecified?)
Whether the end time is actually unspecified.
-
#etag ⇒ String
ETag of the resource.
-
#extended_properties ⇒ Google::Apis::CalendarV3::Event::ExtendedProperties
Extended properties of the event.
-
#gadget ⇒ Google::Apis::CalendarV3::Event::Gadget
A gadget that extends this event.
-
#guests_can_invite_others ⇒ Boolean
(also: #guests_can_invite_others?)
Whether attendees other than the organizer can invite others to the event.
-
#guests_can_modify ⇒ Boolean
(also: #guests_can_modify?)
Whether attendees other than the organizer can modify the event.
-
#guests_can_see_other_guests ⇒ Boolean
(also: #guests_can_see_other_guests?)
Whether attendees other than the organizer can see who the event's attendees are.
-
#hangout_link ⇒ String
An absolute link to the Google+ hangout associated with this event.
-
#html_link ⇒ String
An absolute link to this event in the Google Calendar Web UI.
-
#i_cal_uid ⇒ String
Event unique identifier as defined in RFC5545.
-
#id ⇒ String
Opaque identifier of the event.
-
#kind ⇒ String
Type of the resource ("calendar#event").
-
#location ⇒ String
Geographic location of the event as free-form text.
-
#locked ⇒ Boolean
(also: #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".
-
#organizer ⇒ Google::Apis::CalendarV3::Event::Organizer
The organizer of the event.
-
#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.
-
#private_copy ⇒ Boolean
(also: #private_copy?)
If set to True, Event propagation is disabled.
-
#recurrence ⇒ Array<String>
List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545.
-
#recurring_event_id ⇒ String
For an instance of a recurring event, this is the id of the recurring event to which this instance belongs.
-
#reminders ⇒ Google::Apis::CalendarV3::Event::Reminders
Information about the event's reminders for the authenticated user.
-
#sequence ⇒ Fixnum
Sequence number as per iCalendar.
-
#source ⇒ Google::Apis::CalendarV3::Event::Source
Source from which the event was created.
-
#start ⇒ Google::Apis::CalendarV3::EventDateTime
The (inclusive) start time of the event.
-
#status ⇒ String
Status of the event.
-
#summary ⇒ String
Title of the event.
-
#transparency ⇒ String
Whether the event blocks time on the calendar.
-
#updated ⇒ DateTime
Last modification time of the event (as a RFC3339 timestamp).
-
#visibility ⇒ String
Visibility of the event.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Event
constructor
A new instance of Event.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Event
Returns a new instance of Event.
1328 1329 1330 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1328 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
1041 1042 1043 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1041 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
1051 1052 1053 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1051 def @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
1057 1058 1059 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1057 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
1065 1066 1067 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1065 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
1072 1073 1074 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1072 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
1080 1081 1082 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1080 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
1085 1086 1087 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1085 def created @created end |
#creator ⇒ Google::Apis::CalendarV3::Event::Creator
The creator of the event. Read-only.
Corresponds to the JSON property creator
1090 1091 1092 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1090 def creator @creator end |
#description ⇒ String
Description of the event. Can contain HTML. Optional.
Corresponds to the JSON property description
1095 1096 1097 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1095 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
1101 1102 1103 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1101 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
1108 1109 1110 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1108 def end_time_unspecified @end_time_unspecified end |
#etag ⇒ String
ETag of the resource.
Corresponds to the JSON property etag
1114 1115 1116 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1114 def etag @etag end |
#extended_properties ⇒ Google::Apis::CalendarV3::Event::ExtendedProperties
Extended properties of the event.
Corresponds to the JSON property extendedProperties
1119 1120 1121 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1119 def extended_properties @extended_properties end |
#gadget ⇒ Google::Apis::CalendarV3::Event::Gadget
A gadget that extends this event.
Corresponds to the JSON property gadget
1124 1125 1126 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1124 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
1130 1131 1132 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1130 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
1137 1138 1139 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1137 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
1144 1145 1146 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1144 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
1150 1151 1152 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1150 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
1155 1156 1157 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1155 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
1166 1167 1168 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1166 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
1184 1185 1186 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1184 def id @id end |
#kind ⇒ String
Type of the resource ("calendar#event").
Corresponds to the JSON property kind
1189 1190 1191 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1189 def kind @kind end |
#location ⇒ String
Geographic location of the event as free-form text. Optional.
Corresponds to the JSON property location
1194 1195 1196 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1194 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
1201 1202 1203 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1201 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
1210 1211 1212 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1210 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
1218 1219 1220 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1218 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
1224 1225 1226 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1224 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
1234 1235 1236 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1234 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
1240 1241 1242 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1240 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
1245 1246 1247 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1245 def reminders @reminders end |
#sequence ⇒ Fixnum
Sequence number as per iCalendar.
Corresponds to the JSON property sequence
1250 1251 1252 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1250 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
1257 1258 1259 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1257 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
1263 1264 1265 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1263 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
1294 1295 1296 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1294 def status @status end |
#summary ⇒ String
Title of the event.
Corresponds to the JSON property summary
1299 1300 1301 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1299 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
1308 1309 1310 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1308 def transparency @transparency end |
#updated ⇒ DateTime
Last modification time of the event (as a RFC3339 timestamp). Read-only.
Corresponds to the JSON property updated
1313 1314 1315 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1313 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
1326 1327 1328 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1326 def visibility @visibility end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1333 1334 1335 1336 1337 1338 1339 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 |
# File 'generated/google/apis/calendar_v3/classes.rb', line 1333 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 |