Class Event

Inheritance

object

Event

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Calendar.v3.Data

Assembly: Google.Apis.Calendar.v3.dll

Syntax

public class Event : IDirectResponseSchema

Properties

AnyoneCanAddSelf

Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.

Declaration

[JsonProperty("anyoneCanAddSelf")]
public virtual bool? AnyoneCanAddSelf { get; set; }

Property Value

Type	Description
bool?

Attachments

File attachments for the event. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,

Declaration

[JsonProperty("attachments")]
public virtual IList<EventAttachment> Attachments { get; set; }

Property Value

Type	Description
IList<EventAttachment>

Attendees

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.

Declaration

[JsonProperty("attendees")]
public virtual IList<EventAttendee> Attendees { get; set; }

Property Value

Type	Description
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

[JsonProperty("attendeesOmitted")]
public virtual bool? AttendeesOmitted { get; set; }

Property Value

Type	Description
bool?

BirthdayProperties

Birthday or special event data. Used if eventType is "birthday". Immutable.

Declaration

[JsonProperty("birthdayProperties")]
public virtual EventBirthdayProperties BirthdayProperties { get; set; }

Property Value

Type	Description
EventBirthdayProperties

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

[JsonProperty("colorId")]
public virtual string ColorId { get; set; }

Property Value

Type	Description
string

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.

Declaration

[JsonProperty("conferenceData")]
public virtual ConferenceData ConferenceData { get; set; }

Property Value

Type	Description
ConferenceData

Created

DateTime representation of CreatedRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreatedDateTimeOffset instead.")]
public virtual DateTime? Created { get; set; }

Property Value

Type	Description
DateTime?

CreatedDateTimeOffset

DateTimeOffset representation of CreatedRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreatedDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreatedRaw

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

Declaration

[JsonProperty("created")]
public virtual string CreatedRaw { get; set; }

Property Value

Type	Description
string

Creator

The creator of the event. Read-only.

Declaration

[JsonProperty("creator")]
public virtual Event.CreatorData Creator { get; set; }

Property Value

Type	Description
Event.CreatorData

Description

Description of the event. Can contain HTML. Optional.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

ETag

ETag of the resource.

Declaration

[JsonProperty("etag")]
public virtual string ETag { get; set; }

Property Value

Type	Description
string

End

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

Declaration

[JsonProperty("end")]
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

[JsonProperty("endTimeUnspecified")]
public virtual bool? EndTimeUnspecified { get; set; }

Property Value

Type	Description
bool?

EventType

Specific type of the event. This cannot be modified after the event is created. Possible values are: - "birthday" - A special all-day event with an annual recurrence. - "default" - A regular event or not further specified. - "focusTime" - A focus-time event. - "fromGmail" - An event from Gmail. This type of event cannot be created. - "outOfOffice" - An out-of-office event. - "workingLocation" - A working location event.

Declaration

[JsonProperty("eventType")]
public virtual string EventType { get; set; }

Property Value

Type	Description
string

ExtendedProperties

Extended properties of the event.

Declaration

[JsonProperty("extendedProperties")]
public virtual Event.ExtendedPropertiesData ExtendedProperties { get; set; }

Property Value

Type	Description
Event.ExtendedPropertiesData

FocusTimeProperties

Focus Time event data. Used if eventType is focusTime.

Declaration

[JsonProperty("focusTimeProperties")]
public virtual EventFocusTimeProperties FocusTimeProperties { get; set; }

Property Value

Type	Description
EventFocusTimeProperties

Gadget

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

Declaration

[JsonProperty("gadget")]
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

[JsonProperty("guestsCanInviteOthers")]
public virtual bool? GuestsCanInviteOthers { get; set; }

Property Value

Type	Description
bool?

GuestsCanModify

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

Declaration

[JsonProperty("guestsCanModify")]
public virtual bool? GuestsCanModify { get; set; }

Property Value

Type	Description
bool?

GuestsCanSeeOtherGuests

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

Declaration

[JsonProperty("guestsCanSeeOtherGuests")]
public virtual bool? GuestsCanSeeOtherGuests { get; set; }

Property Value

Type	Description
bool?

HangoutLink

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

Declaration

[JsonProperty("hangoutLink")]
public virtual string HangoutLink { get; set; }

Property Value

Type	Description
string

HtmlLink

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

Declaration

[JsonProperty("htmlLink")]
public virtual string HtmlLink { get; set; }

Property Value

Type	Description
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. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method.

Declaration

[JsonProperty("iCalUID")]
public virtual string ICalUID { get; set; }

Property Value

Type	Description
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

[JsonProperty("id")]
public virtual string Id { get; set; }

Property Value

Type	Description
string

Kind

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

Declaration

[JsonProperty("kind")]
public virtual string Kind { get; set; }

Property Value

Type	Description
string

Location

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

Declaration

[JsonProperty("location")]
public virtual string Location { get; set; }

Property Value

Type	Description
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

[JsonProperty("locked")]
public virtual bool? Locked { get; set; }

Property Value

Type	Description
bool?

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

[JsonProperty("organizer")]
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

[JsonProperty("originalStartTime")]
public virtual EventDateTime OriginalStartTime { get; set; }

Property Value

Type	Description
EventDateTime

OutOfOfficeProperties

Out of office event data. Used if eventType is outOfOffice.

Declaration

[JsonProperty("outOfOfficeProperties")]
public virtual EventOutOfOfficeProperties OutOfOfficeProperties { get; set; }

Property Value

Type	Description
EventOutOfOfficeProperties

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

[JsonProperty("privateCopy")]
public virtual bool? PrivateCopy { get; set; }

Property Value

Type	Description
bool?

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

[JsonProperty("recurrence")]
public virtual IList<string> Recurrence { get; set; }

Property Value

Type	Description
IList<string>

RecurringEventId

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

Declaration

[JsonProperty("recurringEventId")]
public virtual string RecurringEventId { get; set; }

Property Value

Type	Description
string

Reminders

Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event.

Declaration

[JsonProperty("reminders")]
public virtual Event.RemindersData Reminders { get; set; }

Property Value

Type	Description
Event.RemindersData

Sequence

Sequence number as per iCalendar.

Declaration

[JsonProperty("sequence")]
public virtual int? Sequence { get; set; }

Property Value

Type	Description
int?

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

[JsonProperty("source")]
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

[JsonProperty("start")]
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

[JsonProperty("status")]
public virtual string Status { get; set; }

Property Value

Type	Description
string

Summary

Title of the event.

Declaration

[JsonProperty("summary")]
public virtual string Summary { get; set; }

Property Value

Type	Description
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

[JsonProperty("transparency")]
public virtual string Transparency { get; set; }

Property Value

Type	Description
string

Updated

DateTime representation of UpdatedRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdatedDateTimeOffset instead.")]
public virtual DateTime? Updated { get; set; }

Property Value

Type	Description
DateTime?

UpdatedDateTimeOffset

DateTimeOffset representation of UpdatedRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdatedDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdatedRaw

Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only.

Declaration

[JsonProperty("updated")]
public virtual string UpdatedRaw { get; set; }

Property Value

Type	Description
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

[JsonProperty("visibility")]
public virtual string Visibility { get; set; }

Property Value

Type	Description
string

WorkingLocationProperties

Working location event data.

Declaration

[JsonProperty("workingLocationProperties")]
public virtual EventWorkingLocationProperties WorkingLocationProperties { get; set; }

Property Value

Type	Description
EventWorkingLocationProperties

Implements

IDirectResponseSchema