Appointment class

Represents an appointment or a meeting. Properties available on appointments are defined in the AppointmentSchema class.

Inheritance

• Object
• ServiceObject
• Item
• Appointment

Implemented types

• ICalendarActionProvider

Constructors

Appointment(ExchangeService service)

Initializes an unsaved local instance of

Appointment.withAttachment(ItemAttachment parentAttachment, bool isNew)

Initializes a new instance of Appointment.

Properties

AdjacentMeetingCount → int?

Gets the number of calendar entries that are adjacent to this appointment in the authenticated user's calendar.

no setter

AdjacentMeetings → ItemCollection<Appointment>?

Gets a list of meetings that conflict with this appointment in the authenticated user's calendar.

no setter

AllowNewTimeProposal ↔ bool?

Gets or sets a value indicating whether new time proposals are allowed for attendees of this meeting.

getter/setter pair

AppointmentReplyTime → DateTime?

Gets the time when the attendee replied to the meeting request.

no setter

AppointmentSequenceNumber → int?

Gets the sequence number of this appointment.

no setter

AppointmentState → int?

Gets the state of this appointment.

no setter

AppointmentType → AppointmentType?

Gets a value indicating the type of this appointment.

no setter

Attachments → AttachmentCollection

Gets a list of the attachments to this item.

no setter, inherited

Body ↔ MessageBody?

Gets or sets the body of this item.

getter/setter pair, inherited

Categories ↔ StringList

Gets or sets the list of categories associated with this item.

getter/setter pair, inherited

ConferenceType ↔ int?

Gets an OccurrenceInfo identifying the first occurrence of this meeting.

getter/setter pair

ConflictingMeetingCount → int?

Gets the number of calendar entries that conflict with this appointment in the authenticated user's calendar.

no setter

ConflictingMeetings → ItemCollection<Appointment>?

Gets a list of meetings that conflict with this appointment in the authenticated user's calendar.

no setter

DateTimeCreated → DateTime?

Gets the date and time this item was created.

no setter, inherited

DateTimeReceived → DateTime?

Gets the time when this item was received.

no setter, inherited

DateTimeSent → DateTime?

Gets a list of Internet headers for this item.

no setter, inherited

DefaultAffectedTaskOccurrences → AffectedTaskOccurrence?

Gets the icon index.

no setter, inherited

DefaultSendCancellationsMode → SendCancellationsMode

Gets the default setting for sending cancellations on Delete.

no setter, override

DefaultSendInvitationsMode → SendInvitationsMode

Gets the default settings for sending invitations on Save.

no setter, override

DefaultSendInvitationsOrCancellationsMode → SendInvitationsOrCancellationsMode

Gets the default settings for sending invitations or cancellations on Update.

no setter, override

Duration → TimeSpan?

Gets the duration of this appointment.

no setter

EffectiveRights → Set<EffectiveRights>?

Gets a value indicating the effective rights the current authenticated user has on this item.

no setter, inherited

End ↔ DateTime?

Gets or sets the end time of the appointment.

getter/setter pair

EnhancedLocation ↔ EnhancedLocation?

Gets or sets the Enhanced location object.

getter/setter pair

ExtendedProperties → ExtendedPropertyCollection

Gets a list of extended properties defined on this item.

no setter, inherited

HasAttachments → bool?

Gets or sets the number of minutes before the start of this item when the reminder should be triggered.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

ICalDateTimeStamp → DateTime?

Gets the ICalendar DateTimeStamp.

no setter

ICalRecurrenceId → DateTime?

Gets the ICalendar RecurrenceId.

no setter

ICalUid ↔ String?

Gets or sets the ICalendar Uid.

getter/setter pair, override-getter

Id → ItemId?

Gets the Id of this item.

no setter, inherited

Importance ↔ Importance?

Gets or sets the culture associated with this item.

getter/setter pair, inherited

InstanceKey → Uint8List?

Gets the item instance key.

no setter, inherited

IsAllDayEvent ↔ bool?

Gets the original start time of this appointment.

getter/setter pair

IsAssociated → bool?

Gets a value indicating whether this is an associated item.

no setter, inherited

IsAttachment → bool

Gets a value indicating whether the item is an attachment.

no setter, inherited

IsCancelled → bool?

Gets a value indicating whether the appointment has been cancelled.

no setter

IsDirty → bool

Gets a value indicating whether the object has been modified and should be saved.

no setter, inherited

IsDraft → bool?

Gets a value indicating whether the item is is a draft. An item is a draft when it has not yet been sent.

no setter, inherited

IsFromMe → bool?

Gets a value indicating whether the item has been sent by the current authenticated user.

no setter, inherited

IsMeeting → bool?

Gets a value indicating whether the appointment is a meeting.

no setter

IsNew → bool

Gets a value indicating whether this object is a real store item, or if it's a local object that has yet to be saved.

no setter, inherited

IsOnlineMeeting ↔ bool?

Gets or sets a value indicating whether this is an online meeting.

getter/setter pair

IsRecurring → bool?

Gets a value indicating whether the appointment is recurring.

no setter

IsReminderSet ↔ bool?

Gets or sets a value indicating whether a reminder is set for this item.

getter/setter pair, inherited

IsResend → bool?

Gets a value indicating whether the item is a resend of another item.

no setter, inherited

IsResponseRequested ↔ bool?

Gets or sets a value indicating whether responses are requested when invitations are sent for this meeting.

getter/setter pair

IsSubmitted → bool?

Gets or sets the In-Reply-To reference of this item.

no setter, inherited

IsUnmodified → bool?

Gets a value indicating whether the item has been modified since it was created.

no setter, inherited

ItemClass ↔ String?

Gets or sets the custom class name of this item.

getter/setter pair, inherited

JoinOnlineMeetingUrl → String?

Gets the Url for joining an online meeting

no setter

LastModifiedName → String?

Gets the name of the user who last modified this item.

no setter, inherited

LastModifiedTime → DateTime?

Gets the date and time this item was last modified.

no setter, inherited

Location ↔ String?

Gets or sets a value indicating the free/busy status of the owner of this appointment.

getter/setter pair

MeetingRequestWasSent → bool?

Gets a value indicating whether the meeting request has already been sent.

no setter

MeetingWorkspaceUrl ↔ String?

Gets or sets the URL of the meeting workspace. A meeting workspace is a shared Web site for planning meetings and tracking results.

getter/setter pair

MimeContent ↔ MimeContent?

Get or sets the MIME content of this item.

getter/setter pair, inherited

MyResponseType → MeetingResponseType?

Gets a value indicating what was the last response of the user that loaded this meeting.

no setter

NetShowUrl ↔ String?

Gets or sets the URL of the Microsoft NetShow online meeting.

getter/setter pair

onChange ↔ List<IServiceObjectChangedDelegate>

Defines an event that is triggered when the service object changes.

getter/setter pair, inherited

OptionalAttendees → AttendeeCollection

Gets a list of optional attendeed for this meeting.

no setter

Organizer → EmailAddress?

Gets the organizer of this meeting. The Organizer property is read-only and is only relevant for attendees. The organizer of a meeting is automatically set to the user that created the meeting.

no setter

ParentAttachment → ItemAttachment?

Gets the parent attachment of this item.

no setter, inherited

ParentFolderId → FolderId?

Get or sets the MimeContentUTF8 of this item.

no setter, inherited

Preview → String?

Get or set the Flag value for this item.

no setter, inherited

PropertyBag → PropertyBag

The property bag holding property values for this object.

no setter, inherited

Recurrence ↔ Recurrence?

Gets or sets the recurrence pattern for this appointment. Available recurrence pattern classes include Recurrence.DailyPattern, Recurrence.MonthlyPattern and Recurrence.YearlyPattern.

getter/setter pair

ReminderDueBy ↔ DateTime?

Gets a value indicating which response actions are allowed on this item. Examples of response actions are Reply and Forward.

getter/setter pair, inherited

RequiredAttendees → AttendeeCollection

Gets a list of required attendees for this meeting.

no setter

Resources → AttendeeCollection

Gets a list of resources for this meeting.

no setter

RootItemId → ItemId?

Gets Id of the root item for this item.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Schema → ServiceObjectSchema

Gets the schema associated with this type of object.

no setter, inherited

Sensitivity ↔ Sensitivity?

Gets or sets the sensitivity of this item.

getter/setter pair, inherited

Service ↔ ExchangeService

Gets the ExchangeService the object is bound to.

getter/setter pair, inherited

Size → int?

Gets the size of this item.

no setter, inherited

Start ↔ DateTime?

Gets or sets the start time of the appointment.

getter/setter pair

StoreEntryId → Uint8List?

Gets the store entry id.

no setter, inherited

Subject ↔ String?

Gets or sets the subject of this item.

getter/setter pair, inherited

TextBody → TextBody?

Gets the text body of the item.

no setter, inherited

TimeZone → String?

Gets the name of the time zone this appointment is defined in.

no setter

UniqueBody → UniqueBody?

Gets the Id of the conversation this item is part of.

no setter, inherited

WebClientEditFormQueryString → String?

no setter, inherited

WebClientReadFormQueryString → String?

no setter, inherited

When → String?

no setter

Methods

Accept(bool sendResponse) → Future<CalendarActionResults>

Accepts the meeting. Calling this method results in a call to EWS.

override

AcceptTentatively(bool sendResponse) → Future<CalendarActionResults>

Tentatively accepts the meeting. Calling this method results in a call to EWS.

override

CancelMeeting([String? cancellationMessageText = null]) → Future<CalendarActionResults>

Cancels the meeting and sends cancellation messages to all attendees. Calling this method results in a call to EWS.

Changed() → void

Triggers dispatch of the change event.

inherited

ClearChangeLog() → void

Clears the object's change log.

inherited

CreateAcceptMessage(bool tentative) → AcceptMeetingInvitationMessage

Applies the local changes that have been made to this appointment. Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added or removed.

override

CreateCancelMeetingMessage() → CancelMeetingMessage

Creates a local meeting cancellation message that can be customized and sent.

CreateDeclineMessage() → DeclineMeetingInvitationMessage

Creates a local meeting declination message that can be customized and sent.

override

CreateForward() → ResponseMessage

Creates a forward message from this appointment.

CreateReply(bool replyAll) → ResponseMessage

Creates a reply response to the organizer and/or attendees of the meeting.

Decline(bool sendResponse) → Future<CalendarActionResults>

Declines the meeting invitation. Calling this method results in a call to EWS.

override

Delete(DeleteMode deleteMode, [bool suppressReadReceipts = false]) → Future<void>

Deletes the item. Calling this method results in a call to EWS.

inherited

GetChangeXmlElementName() → String

Gets the name of the change XML element.

inherited

GetDeleteFieldXmlElementName() → String

Gets the name of the delete field XML element.

inherited

GetExtendedProperties() → ExtendedPropertyCollection?

Gets a list of extended properties defined on this object.

inherited

GetId() → ServiceId?

The unique Id of this object.

inherited

GetIdPropertyDefinition() → PropertyDefinition

The property definition for the Id of this object.

inherited

GetIsCustomDateTimeScopingRequired() → bool

Determines whether properties defined with ScopedDateTimePropertyDefinition require custom time zone scoping.

override

GetIsTimeZoneHeaderRequired(bool isUpdateOperation) → bool

Gets a value indicating whether a time zone SOAP header should be emitted in a CreateItem or UpdateItem request so this item can be property saved or updated.

override

GetLoadedPropertyDefinitions() → List<PropertyDefinitionBase?>

Gets the collection of loaded property definitions.

inherited

GetMinimumRequiredServerVersion() → ExchangeVersion

Gets the minimum required server version.

override

GetSchema() → ServiceObjectSchema

Binds to an occurence of an existing appointment and loads its first class properties. Calling this method results in a call to EWS.

override

getServiceObjectDefinitionAttribute() → ServiceObjectDefinitionAttribute

override

GetSetFieldXmlElementName() → String

Gets the name of the set field XML element.

inherited

GetXmlElementName() → String?

GetXmlElementName retrieves the XmlElementName of this type based on the EwsObjectDefinition attribute that decorates it, if present.

inherited

GetXmlElementNameOverride() → String?

This methods lets subclasses of ServiceObject override the default mechanism by which the XML element name associated with their type is retrieved.

inherited

HasUnprocessedAttachmentChanges() → bool

Gets a value indicating whether this instance has unprocessed attachment collection changes.

inherited

InternalAccept(bool tentative, bool sendResponse) → Future<CalendarActionResults>

Accepts the meeting.

InternalCreate(FolderId? parentFolderId, MessageDisposition? messageDisposition, SendInvitationsMode? sendInvitationsMode) → Future<void>

Create item.

inherited

InternalDelete(DeleteMode deleteMode, SendCancellationsMode? sendCancellationsMode, AffectedTaskOccurrence? affectedTaskOccurrences, [bool suppressReadReceipts = false]) → Future<void>

Deletes the object.

inherited

InternalLoad(PropertySet propertySet) → Future<void>

Loads the specified set of properties on the object.

inherited

InternalUpdate(FolderId? parentFolderId, ConflictResolutionMode conflictResolutionMode, MessageDisposition messageDisposition, SendInvitationsOrCancellationsMode? sendInvitationsOrCancellationsMode, [bool suppressReadReceipts = false]) → Future<Item?>

Update item.

inherited

Load() → Future<void>

Loads the first class properties. Calling this method results in a call to EWS.

inherited

LoadFromXml(EwsServiceXmlReader reader, bool clearPropertyBag) → Future<void>

Loads service object from XML.

inherited

LoadFromXmlWithPropertySet(EwsServiceXmlReader reader, bool clearPropertyBag, PropertySet? requestedPropertySet, bool summaryPropertiesOnly) → Future<void>

Loads service object from XML.

inherited

LoadWithPropertySet(PropertySet propertySet) → Future<void>

Loads the specified set of properties. Calling this method results in a call to EWS.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

RemoveExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition) → bool

Removes an extended property.

inherited

Reply(MessageBody bodyPrefix, bool replyAll) → void

Replies to the organizer and/or the attendees of the meeting. Calling this method results in a call to EWS.

Save() → Future<void>

Saves this item in the default folder based on the item's type (for example, an e-mail message is saved to the Drafts folder). Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added.

inherited

SaveWithFolderId(FolderId? parentFolderId) → Future<void>

Saves this item in a specific folder. Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added.

inherited

SaveWithFolderIdAndInvitationsMode(FolderId destinationFolderId, SendInvitationsMode sendInvitationsMode) → Future<void>

Saves this appointment in the specified folder. Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added.

SaveWithSendInvitationsMode(SendInvitationsMode sendInvitationsMode) → Future<void>

Saves this appointment in the Calendar folder. Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added.

SaveWithWellKnownFolderAndSendInvitationsMode(WellKnownFolderName destinationFolderName, SendInvitationsMode sendInvitationsMode) → Future<void>

Forwards the appointment. Calling this method results in a call to EWS.

SaveWithWellKnownFolderName(WellKnownFolderName parentFolderName) → Future<void>

Saves this item in a specific folder. Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added.

inherited

SetExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition, Object value) → void

Creates a copy of this item in the specified folder. Calling this method results in a call to EWS.

inherited

SetSubject(String? subject) → void

Sets the subject.

inherited

ThrowIfThisIsAttachment() → void

Throws exception if this is attachment.

inherited

ThrowIfThisIsNew() → void

Throws exception if this is a new service object.

inherited

ThrowIfThisIsNotNew() → void

Throws exception if this is not a new service object.

inherited

toString() → String

A string representation of this object.

inherited

TryGetExtendedProperty<T>(ExtendedPropertyDefinition propertyDefinition, OutParam<T> propertyValueOutParam) → bool

Try to get the value of a specified extended property in this instance.

inherited

TryGetProperty(PropertyDefinitionBase propertyDefinition, OutParam<Object> propertyValueOutParam) → bool

Try to get the value of a specified property in this instance.

inherited

TryGetPropertyGeneric<T>(PropertyDefinitionBase propertyDefinition, OutParam<T> propertyValueOutParam) → bool

Try to get the value of a specified property in this instance.

inherited

Update(ConflictResolutionMode conflictResolutionMode, [bool suppressReadReceipts = false]) → Future<Item?>

Applies the local changes that have been made to this item. Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added or removed.

inherited

Validate() → void

Validates this instance.

override

WriteToXml(EwsServiceXmlWriter writer) → void

Writes service object as XML.

inherited

WriteToXmlForUpdate(EwsServiceXmlWriter writer) → void

Writes service object for update as XML.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

operator [](PropertyDefinitionBase propertyDefinition) → Object?

Gets the value of specified property in this instance.

inherited

Static Methods

BindWithItemId(ExchangeService service, ItemId id) → Future<Appointment>

Binds to an existing appointment and loads its first class properties. Calling this method results in a call to EWS.

BindWithItemIdAndPropertySet(ExchangeService service, ItemId id, PropertySet propertySet) → Future<Appointment>

Binds to an existing appointment and loads the specified set of properties. Calling this method results in a call to EWS.