Interface IGraphEvent

Namespace

PnP.Core.Model.Teams

Assembly

PnP.Core.dll

Defines an event in a Team

public interface IGraphEvent : IDataModel<IGraphEvent>, IDataModelParent, IDataModelWithContext, ISupportModules<IGraphEvent>, IDataModelGet<IGraphEvent>, IDataModelLoad<IGraphEvent>, IDataModelDelete, IQueryableDataModel

Inherited Members

IDataModel<IGraphEvent>.Requested

IDataModel<IGraphEvent>.HasValue(string)

IDataModel<IGraphEvent>.HasChanged(string)

IDataModel<IGraphEvent>.IsPropertyAvailable(Expression<Func<IGraphEvent, object>>)

IDataModel<IGraphEvent>.ArePropertiesAvailable(params Expression<Func<IGraphEvent, object>>[])

IDataModel<IGraphEvent>.EnsureProperties(params Expression<Func<IGraphEvent, object>>[])

IDataModel<IGraphEvent>.EnsurePropertiesAsync(params Expression<Func<IGraphEvent, object>>[])

IDataModel<IGraphEvent>.ExecuteRequestAsync(ApiRequest)

IDataModel<IGraphEvent>.ExecuteRequest(ApiRequest)

IDataModel<IGraphEvent>.ExecuteRequestBatchAsync(ApiRequest)

IDataModel<IGraphEvent>.ExecuteRequestBatch(ApiRequest)

IDataModel<IGraphEvent>.ExecuteRequestBatchAsync(Batch, ApiRequest)

IDataModel<IGraphEvent>.ExecuteRequestBatch(Batch, ApiRequest)

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IDataModelGet<IGraphEvent>.GetBatchAsync(Batch, params Expression<Func<IGraphEvent, object>>[])

IDataModelGet<IGraphEvent>.GetAsync(params Expression<Func<IGraphEvent, object>>[])

IDataModelLoad<IGraphEvent>.LoadBatchAsync(Batch, params Expression<Func<IGraphEvent, object>>[])

IDataModelLoad<IGraphEvent>.LoadAsync(params Expression<Func<IGraphEvent, object>>[])

IDataModelDelete.DeleteBatchAsync()

IDataModelDelete.DeleteBatchAsync(Batch)

IDataModelDelete.DeleteAsync()

IDataModelDelete.DeleteBatch()

IDataModelDelete.DeleteBatch(Batch)

IDataModelDelete.Delete()

Extension Methods

DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelGetExtensions.Get<TModel>(IDataModelGet<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Batch, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.Load<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

DataModelLoadExtensions.QueryProperties<TModel>(IDataModelLoad<TModel>, params Expression<Func<TModel, object>>[])

RequestModuleExtensions.WithHeaders<TModel>(ISupportModules<TModel>, Dictionary<string, string>, Action<Dictionary<string, string>>)

RequestModuleExtensions.WithResponseHeaders<TModel>(ISupportModules<TModel>, Action<Dictionary<string, string>>)

Properties

AllowNewTimeProposals

True if the meeting organizer allows invitees to propose a new time when responding; otherwise, false.

bool AllowNewTimeProposals { get; }

Property Value

bool

Attendees

The body of the message associated with the event. It can be in HTML or text format.

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.

IGraphItemBody Body { get; }

Property Value

IGraphItemBody

BodyPreview

The preview of the message associated with the event. It is in text format.

string BodyPreview { get; }

Property Value

string

Categories

The categories associated with the event. Each category corresponds to the displayName property of an outlookCategory defined for the user.

List<string> Categories { get; set; }

Property Value

List<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.

string ChangeKey { get; }

Property Value

string

CreatedDateTime

Timestamp when the event was created

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.

IGraphDateTimeTimeZone End { get; set; }

Property Value

IGraphDateTimeTimeZone

HasAttachments

Set to true if the event has attachments.

bool HasAttachments { get; }

Property Value

bool

HideAttendees

When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.

bool HideAttendees { get; set; }

Property Value

bool

ICalUId

A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series.

string ICalUId { get; }

Property Value

string

Id

Identifier that uniquely identifies a specific instance of an event. Read only.

string Id { get; }

Property Value

string

Importance

The importance of the event.

EventImportance Importance { get; set; }

Property Value

EventImportance

IsAllDay

Set to true if the event lasts all day.

bool IsAllDay { get; set; }

Property Value

bool

IsCancelled

Set to true if the event has been canceled.

bool IsCancelled { get; }

Property Value

bool

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.

bool IsDraft { get; }

Property Value

bool

IsOnlineMeeting

Defines if the event is an online meeting (e.g. Teams meeting)

bool IsOnlineMeeting { get; set; }

Property Value

bool

IsOrganizer

Defines if the event was created by the requestor

bool IsOrganizer { get; }

Property Value

bool

IsReminderOn

Set to true if an alert is set to remind the user of the event. (n/a for Team events)

bool IsReminderOn { get; }

Property Value

bool

LastModifiedDateTime

Timestamp when the event was last modified

DateTimeOffset LastModifiedDateTime { get; }

Property Value

DateTimeOffset

Location

The location of the event.

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.

IGraphLocationCollection Locations { get; set; }

Property Value

IGraphLocationCollection

OnlineMeeting

Details for an attendee to join the meeting online. Default is null. Read-only.

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.

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.

string OnlineMeetingUrl { get; }

Property Value

string

Organizer

The organizer of the event.

IGraphRecipient Organizer { get; }

Property Value

IGraphRecipient

OriginalEndTimeZone

The end time zone that was set when the event was created.

string OriginalEndTimeZone { get; }

Property Value

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

DateTimeOffset OriginalStart { get; }

Property Value

DateTimeOffset

OriginalStartTimeZone

The start time zone that was set when the event was created.

string OriginalStartTimeZone { get; }

Property Value

string

Recurrence

The recurrence pattern for the event.

IGraphPatternedRecurrence Recurrence { get; set; }

Property Value

IGraphPatternedRecurrence

ReminderMinutesBeforeStart

The number of minutes before the event start time that the reminder alert occurs.

int ReminderMinutesBeforeStart { get; set; }

Property Value

int

ResponseRequested

Defines if the organizer would like an invitee to send a response to the event.

bool ResponseRequested { get; set; }

Property Value

bool

ResponseStatus

Indicates the type of response sent in response to an event message.

IGraphEventResponseStatus ResponseStatus { get; }

Property Value

IGraphEventResponseStatus

Sensitivity

Sensitivity of the event

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.

string SeriesMasterId { get; }

Property Value

string

ShowAs

The status to show.

EventShowAs ShowAs { get; set; }

Property Value

EventShowAs

Start

The date, time, and time zone that the event starts. By default, the start time is in UTC.

IGraphDateTimeTimeZone Start { get; set; }

Property Value

IGraphDateTimeTimeZone

Subject

The text of the event's subject line.

string Subject { get; set; }

Property Value

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.

string TransactionId { get; set; }

Property Value

string

Type

The event type.

EventType Type { get; }

Property Value

EventType

WebLink

The URL to open the event in Outlook on the web.

string WebLink { get; }

Property Value

string

Methods

Update(EventUpdateOptions)

Method to update the event

void Update(EventUpdateOptions options)

Parameters

options EventUpdateOptions

Options on what to update

UpdateAsync(EventUpdateOptions)

Method to update the event

Task UpdateAsync(EventUpdateOptions options)

Parameters

options EventUpdateOptions

Options on what to update

Returns

Task