Interface IGraphEvent
Defines an event in a Team
Inherited Members
Namespace: PnP.Core.Model.Teams
Assembly: PnP.Core.dll
Syntax
public interface IGraphEvent : IDataModel<IGraphEvent>, IDataModelParent, IDataModelWithContext, ISupportModules<IGraphEvent>, IDataModelGet<IGraphEvent>, IDataModelLoad<IGraphEvent>, IDataModelDelete, IQueryableDataModel
Properties
AllowNewTimeProposals
True if the meeting organizer allows invitees to propose a new time when responding; otherwise, false.
Declaration
bool AllowNewTimeProposals { get; }
Property Value
System.Boolean
|
Attendees
The body of the message associated with the event. It can be in HTML or text format.
Declaration
IGraphEventAttendeeCollection Attendees { get; set; }
Property Value
IGraphEventAttendeeCollection
|
Body
The body of the message associated with the event. It can be in HTML or text format.
Declaration
IGraphItemBody Body { get; }
Property Value
IGraphItemBody
|
BodyPreview
The preview of the message associated with the event. It is in text format.
Declaration
string BodyPreview { get; }
Property Value
System.String
|
Categories
The categories associated with the event. Each category corresponds to the displayName property of an outlookCategory defined for the user.
Declaration
List<string> Categories { get; set; }
Property Value
List<System.String>
|
ChangeKey
Identifies the version of the event object. Every time the event is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object.
Declaration
string ChangeKey { get; }
Property Value
System.String
|
CreatedDateTime
Timestamp when the event was created
Declaration
DateTimeOffset CreatedDateTime { get; }
Property Value
DateTimeOffset
|
End
The date, time, and time zone that the event starts. By default, the start time is in UTC.
Declaration
IGraphDateTimeTimeZone End { get; set; }
Property Value
IGraphDateTimeTimeZone
|
HasAttachments
Set to true if the event has attachments.
Declaration
bool HasAttachments { get; }
Property Value
System.Boolean
|
HideAttendees
When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.
Declaration
bool HideAttendees { get; set; }
Property Value
System.Boolean
|
ICalUId
A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series.
Declaration
string ICalUId { get; }
Property Value
System.String
|
Id
Identifier that uniquely identifies a specific instance of an event. Read only.
Declaration
string Id { get; }
Property Value
System.String
|
Importance
The importance of the event.
Declaration
EventImportance Importance { get; set; }
Property Value
EventImportance
|
IsAllDay
Set to true if the event lasts all day.
Declaration
bool IsAllDay { get; set; }
Property Value
System.Boolean
|
IsCancelled
Set to true if the event has been canceled.
Declaration
bool IsCancelled { get; }
Property Value
System.Boolean
|
IsDraft
Set to true if the user has updated the meeting in Outlook but has not sent the updates to attendees. Set to false if all changes have been sent, or if the event is an appointment without any attendees.
Declaration
bool IsDraft { get; }
Property Value
System.Boolean
|
IsOnlineMeeting
Defines if the event is an online meeting (e.g. Teams meeting)
Declaration
bool IsOnlineMeeting { get; set; }
Property Value
System.Boolean
|
IsOrganizer
Defines if the event was created by the requestor
Declaration
bool IsOrganizer { get; }
Property Value
System.Boolean
|
IsReminderOn
Set to true if an alert is set to remind the user of the event. (n/a for Team events)
Declaration
bool IsReminderOn { get; }
Property Value
System.Boolean
|
LastModifiedDateTime
Timestamp when the event was last modified
Declaration
DateTimeOffset LastModifiedDateTime { get; }
Property Value
DateTimeOffset
|
Location
The location of the event.
Declaration
IGraphLocation Location { get; set; }
Property Value
IGraphLocation
|
Locations
The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.
Declaration
IGraphLocationCollection Locations { get; set; }
Property Value
IGraphLocationCollection
|
OnlineMeeting
Details for an attendee to join the meeting online. Default is null. Read-only.
Declaration
IGraphOnlineMeetingInfo OnlineMeeting { get; }
Property Value
IGraphOnlineMeetingInfo
|
OnlineMeetingProvider
Represents the online meeting service provider. After you set onlineMeetingProvider, Microsoft Graph initializes onlineMeeting. Subsequently you cannot change onlineMeetingProvider again, and the meeting remains available online.
Declaration
EventOnlineMeetingProvider OnlineMeetingProvider { get; set; }
Property Value
EventOnlineMeetingProvider
|
OnlineMeetingUrl
A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.
Declaration
string OnlineMeetingUrl { get; }
Property Value
System.String
|
Organizer
The organizer of the event.
Declaration
IGraphRecipient Organizer { get; }
Property Value
IGraphRecipient
|
OriginalEndTimeZone
The end time zone that was set when the event was created.
Declaration
string OriginalEndTimeZone { get; }
Property Value
System.String
|
OriginalStart
Represents the start time of an event when it is initially created as an occurrence or exception in a recurring series. This property is not returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
Declaration
DateTimeOffset OriginalStart { get; }
Property Value
DateTimeOffset
|
OriginalStartTimeZone
The start time zone that was set when the event was created.
Declaration
string OriginalStartTimeZone { get; }
Property Value
System.String
|
Recurrence
The recurrence pattern for the event.
Declaration
IGraphPatternedRecurrence Recurrence { get; set; }
Property Value
IGraphPatternedRecurrence
|
ReminderMinutesBeforeStart
The number of minutes before the event start time that the reminder alert occurs.
Declaration
int ReminderMinutesBeforeStart { get; set; }
Property Value
System.Int32
|
ResponseRequested
Defines if the organizer would like an invitee to send a response to the event.
Declaration
bool ResponseRequested { get; set; }
Property Value
System.Boolean
|
ResponseStatus
Indicates the type of response sent in response to an event message.
Declaration
IGraphEventResponseStatus ResponseStatus { get; }
Property Value
IGraphEventResponseStatus
|
Sensitivity
Sensitivity of the event
Declaration
EventSensitivity Sensitivity { get; set; }
Property Value
EventSensitivity
|
SeriesMasterId
The ID for the recurring series master item, if this event is part of a recurring series.
Declaration
string SeriesMasterId { get; }
Property Value
System.String
|
ShowAs
Start
The date, time, and time zone that the event starts. By default, the start time is in UTC.
Declaration
IGraphDateTimeTimeZone Start { get; set; }
Property Value
IGraphDateTimeTimeZone
|
Subject
The text of the event's subject line.
Declaration
string Subject { get; set; }
Property Value
System.String
|
TransactionId
A custom identifier specified by a client app for the server to avoid redundant POST operations in case of client retries to create the same event. This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. After you set transactionId when creating an event, you cannot change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it.
Declaration
string TransactionId { get; set; }
Property Value
System.String
|
Type
WebLink
The URL to open the event in Outlook on the web.
Declaration
string WebLink { get; }
Property Value
System.String
|
Methods
Update(EventUpdateOptions)
Method to update the event
Declaration
void Update(EventUpdateOptions options)
Parameters
EventUpdateOptions
options
Options on what to update |
UpdateAsync(EventUpdateOptions)
Method to update the event
Declaration
Task UpdateAsync(EventUpdateOptions options)
Parameters
EventUpdateOptions
options
Options on what to update |
Returns
Task
|