Class Event
Inheritance
Implements
Namespace: Google.Apis.Calendar.v3.Data
Assembly: Google.Apis.Calendar.v3.dll
Syntax
public class Event : object, IDirectResponseSchema
Properties
AnyoneCanAddSelf
Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.
Declaration
public virtual Nullable<bool> AnyoneCanAddSelf { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
Attachments
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,
Declaration
public virtual IList<EventAttachment> Attachments { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<EventAttachment> |
Attendees
The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.
Declaration
public virtual IList<EventAttendee> Attendees { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<EventAttendee> |
AttendeesOmitted
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.
Declaration
public virtual Nullable<bool> AttendeesOmitted { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
ColorId
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.
Declaration
public virtual string ColorId { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
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.
Declaration
public virtual ConferenceData ConferenceData { get; set; }
Property Value
| Type | Description |
|---|---|
| ConferenceData |
Created
System.DateTime representation of CreatedRaw.
Declaration
public virtual Nullable<DateTime> Created { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.DateTime> |
CreatedRaw
Creation time of the event (as a RFC3339 timestamp). Read-only.
Declaration
public virtual string CreatedRaw { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Creator
The creator of the event. Read-only.
Declaration
public virtual Event.CreatorData Creator { get; set; }
Property Value
| Type | Description |
|---|---|
| Event.CreatorData |
Description
Description of the event. Can contain HTML. Optional.
Declaration
public virtual string Description { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
End
The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
Declaration
public virtual EventDateTime End { get; set; }
Property Value
| Type | Description |
|---|---|
| EventDateTime |
EndTimeUnspecified
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.
Declaration
public virtual Nullable<bool> EndTimeUnspecified { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
ETag
ETag of the resource.
Declaration
public virtual string ETag { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ExtendedProperties
Extended properties of the event.
Declaration
public virtual Event.ExtendedPropertiesData ExtendedProperties { get; set; }
Property Value
| Type | Description |
|---|---|
| Event.ExtendedPropertiesData |
Gadget
A gadget that extends this event.
Declaration
public virtual Event.GadgetData Gadget { get; set; }
Property Value
| Type | Description |
|---|---|
| Event.GadgetData |
GuestsCanInviteOthers
Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
Declaration
public virtual Nullable<bool> GuestsCanInviteOthers { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
GuestsCanModify
Whether attendees other than the organizer can modify the event. Optional. The default is False.
Declaration
public virtual Nullable<bool> GuestsCanModify { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
GuestsCanSeeOtherGuests
Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
Declaration
public virtual Nullable<bool> GuestsCanSeeOtherGuests { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
HangoutLink
An absolute link to the Google+ hangout associated with this event. Read-only.
Declaration
public virtual string HangoutLink { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
HtmlLink
An absolute link to this event in the Google Calendar Web UI. Read-only.
Declaration
public virtual string HtmlLink { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ICalUID
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.
Declaration
public virtual string ICalUID { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Id
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.
Declaration
public virtual string Id { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Kind
Type of the resource ("calendar#event").
Declaration
public virtual string Kind { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Location
Geographic location of the event as free-form text. Optional.
Declaration
public virtual string Location { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
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.
Declaration
public virtual Nullable<bool> Locked { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
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.
Declaration
public virtual Event.OrganizerData Organizer { get; set; }
Property Value
| Type | Description |
|---|---|
| Event.OrganizerData |
OriginalStartTime
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.
Declaration
public virtual EventDateTime OriginalStartTime { get; set; }
Property Value
| Type | Description |
|---|---|
| EventDateTime |
PrivateCopy
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.
Declaration
public virtual Nullable<bool> PrivateCopy { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
Recurrence
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.
Declaration
public virtual IList<string> Recurrence { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |
RecurringEventId
For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
Declaration
public virtual string RecurringEventId { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Reminders
Information about the event's reminders for the authenticated user.
Declaration
public virtual Event.RemindersData Reminders { get; set; }
Property Value
| Type | Description |
|---|---|
| Event.RemindersData |
Sequence
Sequence number as per iCalendar.
Declaration
public virtual Nullable<int> Sequence { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
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.
Declaration
public virtual Event.SourceData Source { get; set; }
Property Value
| Type | Description |
|---|---|
| Event.SourceData |
Start
The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
Declaration
public virtual EventDateTime Start { get; set; }
Property Value
| Type | Description |
|---|---|
| EventDateTime |
Status
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.
Declaration
public virtual string Status { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Summary
Title of the event.
Declaration
public virtual string Summary { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Transparency
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.
Declaration
public virtual string Transparency { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Updated
System.DateTime representation of UpdatedRaw.
Declaration
public virtual Nullable<DateTime> Updated { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.DateTime> |
UpdatedRaw
Last modification time of the event (as a RFC3339 timestamp). Read-only.
Declaration
public virtual string UpdatedRaw { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Visibility
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.
Declaration
public virtual string Visibility { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |