calendar  v3
Classes | Properties | List of all members
Google.Apis.Calendar.v3.Data.Event Class Reference
Inheritance diagram for Google.Apis.Calendar.v3.Data.Event:
Google::Apis::Requests::IDirectResponseSchema

Classes

class  CreatorData
 The creator of the event. Read-only. More...
 
class  ExtendedPropertiesData
 Extended properties of the event. More...
 
class  GadgetData
 A gadget that extends this event. More...
 
class  OrganizerData
 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. More...
 
class  RemindersData
 Information about the event's reminders for the authenticated user. More...
 
class  SourceData
 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. More...
 

Properties

virtual System.Nullable< bool > AnyoneCanAddSelf [get, set]
 Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. More...
 
virtual System.Collections.Generic.IList< EventAttachmentAttachments [get, set]
 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, More...
 
virtual System.Collections.Generic.IList< EventAttendeeAttendees [get, set]
 The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. More...
 
virtual System.Nullable< bool > AttendeesOmitted [get, set]
 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. More...
 
virtual string ColorId [get, set]
 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. More...
 
virtual ConferenceData ConferenceData [get, set]
 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. More...
 
virtual string CreatedRaw [get, set]
 Creation time of the event (as a RFC3339 timestamp). Read-only. More...
 
virtual System.Nullable< System.DateTime > Created [get, set]
 
See also
System.DateTime

representation of CreatedRaw. More...

 
virtual Event.CreatorData Creator [get, set]
 The creator of the event. Read-only. More...
 
virtual string Description [get, set]
 Description of the event. Optional. More...
 
virtual EventDateTime End [get, set]
 The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. More...
 
virtual System.Nullable< bool > EndTimeUnspecified [get, set]
 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. More...
 
virtual string ETag [get, set]
 ETag of the resource. More...
 
virtual Event.ExtendedPropertiesData ExtendedProperties [get, set]
 Extended properties of the event. More...
 
virtual Event.GadgetData Gadget [get, set]
 A gadget that extends this event. More...
 
virtual System.Nullable< bool > GuestsCanInviteOthers [get, set]
 Whether attendees other than the organizer can invite others to the event. Optional. The default is True. More...
 
virtual System.Nullable< bool > GuestsCanModify [get, set]
 Whether attendees other than the organizer can modify the event. Optional. The default is False. More...
 
virtual System.Nullable< bool > GuestsCanSeeOtherGuests [get, set]
 Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. More...
 
virtual string HangoutLink [get, set]
 An absolute link to the Google+ hangout associated with this event. Read-only. More...
 
virtual string HtmlLink [get, set]
 An absolute link to this event in the Google Calendar Web UI. Read-only. More...
 
virtual string ICalUID [get, set]
 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. More...
 
virtual string Id [get, set]
 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. More...
 
virtual string Kind [get, set]
 Type of the resource ("calendar#event"). More...
 
virtual string Location [get, set]
 Geographic location of the event as free-form text. Optional. More...
 
virtual System.Nullable< bool > Locked [get, set]
 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. More...
 
virtual Event.OrganizerData Organizer [get, set]
 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. More...
 
virtual EventDateTime OriginalStartTime [get, set]
 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. More...
 
virtual System.Nullable< bool > PrivateCopy [get, set]
 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. More...
 
virtual System.Collections.Generic.IList< string > Recurrence [get, set]
 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. More...
 
virtual string RecurringEventId [get, set]
 For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. More...
 
virtual Event.RemindersData Reminders [get, set]
 Information about the event's reminders for the authenticated user. More...
 
virtual System.Nullable< int > Sequence [get, set]
 Sequence number as per iCalendar. More...
 
virtual Event.SourceData Source [get, set]
 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. More...
 
virtual EventDateTime Start [get, set]
 The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. More...
 
virtual string Status [get, set]
 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. More...
 
virtual string Summary [get, set]
 Title of the event. More...
 
virtual string Transparency [get, set]
 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. More...
 
virtual string UpdatedRaw [get, set]
 Last modification time of the event (as a RFC3339 timestamp). Read-only. More...
 
virtual System.Nullable< System.DateTime > Updated [get, set]
 
See also
System.DateTime

representation of UpdatedRaw. More...

 
virtual string Visibility [get, set]
 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. More...
 
- Properties inherited from Google::Apis::Requests::IDirectResponseSchema
string ETag
 

Property Documentation

◆ AnyoneCanAddSelf

virtual System.Nullable<bool> Google.Apis.Calendar.v3.Data.Event.AnyoneCanAddSelf
getset

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

◆ Attachments

virtual System.Collections.Generic.IList<EventAttachment> Google.Apis.Calendar.v3.Data.Event.Attachments
getset

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,

◆ Attendees

virtual System.Collections.Generic.IList<EventAttendee> Google.Apis.Calendar.v3.Data.Event.Attendees
getset

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

◆ AttendeesOmitted

virtual System.Nullable<bool> Google.Apis.Calendar.v3.Data.Event.AttendeesOmitted
getset

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.

◆ ColorId

virtual string Google.Apis.Calendar.v3.Data.Event.ColorId
getset

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.

◆ ConferenceData

virtual ConferenceData Google.Apis.Calendar.v3.Data.Event.ConferenceData
getset

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.

◆ Created

virtual System.Nullable<System.DateTime> Google.Apis.Calendar.v3.Data.Event.Created
getset

See also
System.DateTime

representation of CreatedRaw.

◆ CreatedRaw

virtual string Google.Apis.Calendar.v3.Data.Event.CreatedRaw
getset

Creation time of the event (as a RFC3339 timestamp). Read-only.

◆ Creator

virtual Event.CreatorData Google.Apis.Calendar.v3.Data.Event.Creator
getset

The creator of the event. Read-only.

◆ Description

virtual string Google.Apis.Calendar.v3.Data.Event.Description
getset

Description of the event. Optional.

◆ End

virtual EventDateTime Google.Apis.Calendar.v3.Data.Event.End
getset

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

◆ EndTimeUnspecified

virtual System.Nullable<bool> Google.Apis.Calendar.v3.Data.Event.EndTimeUnspecified
getset

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.

◆ ETag

virtual string Google.Apis.Calendar.v3.Data.Event.ETag
getset

ETag of the resource.

◆ ExtendedProperties

virtual Event.ExtendedPropertiesData Google.Apis.Calendar.v3.Data.Event.ExtendedProperties
getset

Extended properties of the event.

◆ Gadget

virtual Event.GadgetData Google.Apis.Calendar.v3.Data.Event.Gadget
getset

A gadget that extends this event.

◆ GuestsCanInviteOthers

virtual System.Nullable<bool> Google.Apis.Calendar.v3.Data.Event.GuestsCanInviteOthers
getset

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

◆ GuestsCanModify

virtual System.Nullable<bool> Google.Apis.Calendar.v3.Data.Event.GuestsCanModify
getset

Whether attendees other than the organizer can modify the event. Optional. The default is False.

◆ GuestsCanSeeOtherGuests

virtual System.Nullable<bool> Google.Apis.Calendar.v3.Data.Event.GuestsCanSeeOtherGuests
getset

Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

◆ HangoutLink

virtual string Google.Apis.Calendar.v3.Data.Event.HangoutLink
getset

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

◆ HtmlLink

virtual string Google.Apis.Calendar.v3.Data.Event.HtmlLink
getset

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

◆ ICalUID

virtual string Google.Apis.Calendar.v3.Data.Event.ICalUID
getset

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.

◆ Id

virtual string Google.Apis.Calendar.v3.Data.Event.Id
getset

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.

◆ Kind

virtual string Google.Apis.Calendar.v3.Data.Event.Kind
getset

Type of the resource ("calendar#event").

◆ Location

virtual string Google.Apis.Calendar.v3.Data.Event.Location
getset

Geographic location of the event as free-form text. Optional.

◆ Locked

virtual System.Nullable<bool> Google.Apis.Calendar.v3.Data.Event.Locked
getset

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.

◆ Organizer

virtual Event.OrganizerData Google.Apis.Calendar.v3.Data.Event.Organizer
getset

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.

◆ OriginalStartTime

virtual EventDateTime Google.Apis.Calendar.v3.Data.Event.OriginalStartTime
getset

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.

◆ PrivateCopy

virtual System.Nullable<bool> Google.Apis.Calendar.v3.Data.Event.PrivateCopy
getset

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.

◆ Recurrence

virtual System.Collections.Generic.IList<string> Google.Apis.Calendar.v3.Data.Event.Recurrence
getset

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.

◆ RecurringEventId

virtual string Google.Apis.Calendar.v3.Data.Event.RecurringEventId
getset

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

◆ Reminders

virtual Event.RemindersData Google.Apis.Calendar.v3.Data.Event.Reminders
getset

Information about the event's reminders for the authenticated user.

◆ Sequence

virtual System.Nullable<int> Google.Apis.Calendar.v3.Data.Event.Sequence
getset

Sequence number as per iCalendar.

◆ Source

virtual Event.SourceData Google.Apis.Calendar.v3.Data.Event.Source
getset

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.

◆ Start

virtual EventDateTime Google.Apis.Calendar.v3.Data.Event.Start
getset

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

◆ Status

virtual string Google.Apis.Calendar.v3.Data.Event.Status
getset

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.

◆ Summary

virtual string Google.Apis.Calendar.v3.Data.Event.Summary
getset

Title of the event.

◆ Transparency

virtual string Google.Apis.Calendar.v3.Data.Event.Transparency
getset

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.

◆ Updated

virtual System.Nullable<System.DateTime> Google.Apis.Calendar.v3.Data.Event.Updated
getset

See also
System.DateTime

representation of UpdatedRaw.

◆ UpdatedRaw

virtual string Google.Apis.Calendar.v3.Data.Event.UpdatedRaw
getset

Last modification time of the event (as a RFC3339 timestamp). Read-only.

◆ Visibility

virtual string Google.Apis.Calendar.v3.Data.Event.Visibility
getset

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.


The documentation for this class was generated from the following file: