Appointment Class

Definition

Contains the properties and methods used to define an appointment or a meeting. Properties that are available on appointments are defined in the AppointmentSchema class.

public ref class Appointment : Microsoft::Exchange::WebServices::Data::Item
public class Appointment : Microsoft.Exchange.WebServices.Data.Item
Public Class Appointment
Inherits Item
Inheritance
Appointment

Constructors

Appointment(ExchangeService)

Initializes an unsaved local instance of the Appointment class. To bind to an existing appointment, use the Bind(ExchangeService, ItemId) method instead.

Properties

AdjacentMeetingCount

Gets the number of calendar entries that are adjacent to the appointment.

AdjacentMeetings

Gets a list of meetings that are adjacent to the appointment.

AllowedResponseActions

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

(Inherited from Item)
AllowNewTimeProposal

Gets or sets whether attendees may propose a new time for the meeting.

AppointmentReplyTime

Gets the time that an attendee replied to the meeting request.

AppointmentSequenceNumber

Gets a value that indicates the version number of a changed appointment.

AppointmentState

Gets a value that indicates whether the associated object is an appointment, a meeting, a response to a meeting, or a cancelled meeting.

AppointmentType

Gets a value that indicates the occurrence type of the appointment; for example, a single meeting, an instance of a recurring meeting, an exception to a recurring meeting, or a master item that contains a meeting recurrence pattern.

ArchiveTag

Gets or sets the archive tag. The ArchiveTag property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

(Inherited from Item)
Attachments

Gets a list of the attachments to this item.

(Inherited from Item)
Body

Gets or sets the body of this item.

(Inherited from Item)
Categories

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

(Inherited from Item)
ConferenceType

Gets or sets the type of conferencing that will be used during the meeting; for example, a video conference, a presentation, or a chat session.

ConflictingMeetingCount

Gets the number of calendar entries that conflict with the appointment.

ConflictingMeetings

Gets a list of meetings that conflict with the appointment.

ConversationId

Gets the ID of the conversation that this item is part of.

(Inherited from Item)
Culture

Gets or sets the culture that is associated with this item.

(Inherited from Item)
DateTimeCreated

Gets the date and time at which this item was created.

(Inherited from Item)
DateTimeReceived

Gets the time when this item was received.

(Inherited from Item)
DateTimeSent

Gets the date and time at which this item was sent.

(Inherited from Item)
DeletedOccurrences

Gets a list of deleted occurrences for a recurring meeting or appointment.

DisplayCc

Gets a text string that lists the Cc recipients of this item.

(Inherited from Item)
DisplayTo

Gets a text string that lists the To recipients of this item.

(Inherited from Item)
Duration

Gets the duration of the appointment.

EffectiveRights

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

(Inherited from Item)
End

Gets or sets the end time of the appointment.

EndTimeZone

Gets or sets the time zone of the end property of the appointment.

EnhancedLocation

Gets or sets additional meeting or appointment location information. The EnhancedLocation property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

EntityExtractionResult

Gets the entity extraction information on the item. The EntityExtractionResult property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

(Inherited from Item)
ExtendedProperties

Gets a list of extended properties that are defined on this item.

(Inherited from Item)
FirstOccurrence

Gets the first occurrence of a recurring meeting or appointment.

Flag

Gets or sets a flag value that indicates the status, start date, due date, or completion date for an item. The Flag property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

(Inherited from Item)
HasAttachments

Gets a value that indicates whether the item has attachments.

(Inherited from Item)
ICalDateTimeStamp

Gets the iCalendar DateTimeStamp.

ICalRecurrenceId

Gets the iCalendar RecurrenceId.

ICalUid

Gets or sets the iCalendar Uid.

IconIndex

Gets the icon index. The IconIndex property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

(Inherited from Item)
Id

Gets the ID of this item.

(Inherited from Item)
Importance

Gets or sets the importance of this item.

(Inherited from Item)
InReplyTo

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

(Inherited from Item)
InstanceKey

Gets the item instance key. The InstanceKey property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

(Inherited from Item)
InternetMessageHeaders

Gets a list of Internet headers for this item. To get the entire collection of Internet message headers, use the PR_TRANSPORT_MESSAGE_HEADERS property.

(Inherited from Item)
IsAllDayEvent

Gets or sets whether the appointment is an all-day event.

IsAssociated

Gets a value that indicates whether this is an associated item.

(Inherited from Item)
IsAttachment

Gets a value that indicates whether the item is an attachment.

(Inherited from Item)
IsCancelled

Gets whether the appointment has been canceled.

IsDirty

Gets a value that indicates whether the object has been modified.

(Inherited from ServiceObject)
IsDraft

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

(Inherited from Item)
IsFromMe

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

(Inherited from Item)
IsMeeting

Gets whether the appointment is a meeting.

IsNew

Gets a value that indicates whether this object is a real store item or a local object that has yet to be saved.

(Inherited from Item)
IsOnlineMeeting

Gets or sets whether the meeting is an online meeting.

IsRecurring

Gets whether the appointment is part of a recurring series.

IsReminderSet

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

(Inherited from Item)
IsResend

Gets a value that indicates whether the item is a resend of another item.

(Inherited from Item)
IsResponseRequested

Gets or sets whether responses are requested when invitations are sent for the meeting.

IsSubmitted

Gets a value that indicates whether the message has been submitted to be sent.

(Inherited from Item)
IsUnmodified

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

(Inherited from Item)
Item[PropertyDefinitionBase]

Gets the value of the specified property in this instance.

(Inherited from ServiceObject)
ItemClass

Gets or sets the custom class name of this item.

(Inherited from Item)
JoinOnlineMeetingUrl

Gets the URL for joining an online meeting. The JoinOnlineMeetingUrl property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

LastModifiedName

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

(Inherited from Item)
LastModifiedTime

Gets the date and time that this item was last modified.

(Inherited from Item)
LastOccurrence

Gets the last occurrence of a recurring series.

LegacyFreeBusyStatus

Gets or sets a value that indicates the free/busy status of the owner of the appointment.

Location

Gets or sets the location of this appointment.

MeetingRequestWasSent

Gets whether the meeting request has been sent.

MeetingWorkspaceUrl

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

MimeContent

Gets the MIME content of this item.

(Inherited from Item)
ModifiedOccurrences

Gets a list of meetings or appointments in a recurring series that have been changed.

MyResponseType

Gets the user's last response to a meeting request; for example, accept or decline.

NetShowUrl

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

NormalizedBody

Gets the message body of an item that has been converted to a normalized value. The NormalizedBody property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

(Inherited from Item)
OnlineMeetingSettings

Gets a set of participant access settings for an online meeting. The OnlineMeetingSettings property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

OptionalAttendees

Gets a list of optional attendees for the meeting.

Organizer

Gets the email address of the meeting organizer.

OriginalStart

Gets the original start time of the appointment.

ParentFolderId

Gets the ID of the parent folder of this item.

(Inherited from Item)
PolicyTag

Gets or sets the retention policy value. The PolicyTag property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

(Inherited from Item)
Preview

Gets the item preview. The Preview property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

(Inherited from Item)
Recurrence

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

ReminderDueBy

Gets or sets the date and time when the reminder is due for this item.

(Inherited from Item)
ReminderMinutesBeforeStart

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

(Inherited from Item)
RequiredAttendees

Gets a list of required attendees for the meeting.

Resources

Gets a list of resources for the meeting, such as audio-visual equipment.

RetentionDate

Gets the date until which an item must be preserved. The RetentionDate property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

(Inherited from Item)
Schema

Gets the schema that is associated with this type of object.

(Inherited from ServiceObject)
Sensitivity

Gets the sensitivity of this item.

(Inherited from Item)
Service

Gets the Exchange service for this object.

(Inherited from ServiceObject)
Size

Gets the size of this item.

(Inherited from Item)
Start

Gets or sets the start time of the appointment.

StartTimeZone

Gets or sets the time zone of the Start property of the appointment.

StoreEntryId

Gets the entry ID of the store that hosts the item. The StoreEntryId property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

(Inherited from Item)
Subject

Gets or sets the subject of this item.

(Inherited from Item)
TextBody

Gets the text body of the item. The TextBody property is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

(Inherited from Item)
TimeZone

Gets the time zone that is specified for the appointment.

UniqueBody

Gets the body part that is unique to the conversation that this item is part of.

(Inherited from Item)
WebClientEditFormQueryString

Gets the query string that can be appended to the Outlook Web App URL to open this item in a web browser.

(Inherited from Item)
WebClientReadFormQueryString

Gets the query string that should be appended to the Exchange web client URL to open this item by using the appropriate read form in a web browser.

(Inherited from Item)
When

Gets a text value that indicates when the appointment occurs. The text value is localized by using the Exchange Server culture or by using the culture specified in the PreferredCulture property of the ExchangeService object that this appointment is bound to.

Methods

Accept(Boolean)

Accepts the meeting. Calling this method results in a call to Exchange Web Services (EWS).

AcceptTentatively(Boolean)

Tentatively accepts the meeting. Calling this method results in a call to Exchange Web Services (EWS).

Bind(ExchangeService, ItemId)

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

Bind(ExchangeService, ItemId, PropertySet)

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

BindToOccurrence(ExchangeService, ItemId, Int32)

Binds to an occurrence of an existing appointment and loads its first class properties. Calling this method results in a call to Exchange Web Services (EWS).

BindToOccurrence(ExchangeService, ItemId, Int32, PropertySet)

Binds to an occurrence of an existing appointment and loads the specified set of properties. Calling this method results in a call to Exchange Web Services (EWS).

BindToRecurringMaster(ExchangeService, ItemId)

Binds to the master appointment of a recurring series and loads its first class properties. Calling this method results in a call to Exchange Web Services (EWS).

BindToRecurringMaster(ExchangeService, ItemId, PropertySet)

Binds to the master appointment of a recurring series and loads the specified set of properties. Calling this method results in a call to Exchange Web Services (EWS).

CancelMeeting()

Cancels the meeting and sends cancellation messages to all attendees. Calling this method results in a call to Exchange Web Services (EWS).

CancelMeeting(String)

Cancels the meeting and sends cancellation messages to all attendees with the associated text. Calling this method results in a call to Exchange Web Services (EWS).

Copy(FolderId)

Creates a copy of this item in the specified folder. Calling this method results in a call to Exchange Web Services (EWS).

(Inherited from Item)
Copy(WellKnownFolderName)

Creates a copy of this item in the specified folder. Calling this method results in a call to Exchange Web Services (EWS).

(Inherited from Item)
CreateAcceptMessage(Boolean)

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

CreateCancelMeetingMessage()

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

CreateDeclineMessage()

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

CreateForward()

Creates a forward message from this appointment.

CreateReply(Boolean)

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

Decline(Boolean)

Declines the meeting invitation. Calling this method results in a call to Exchange Web Services (EWS).

Delete(DeleteMode)

Deletes the item. Calling this method results in a call to Exchange Web Services (EWS).

(Inherited from Item)
Delete(DeleteMode, Boolean)

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

(Inherited from Item)
Delete(DeleteMode, SendCancellationsMode)

Deletes this appointment. Calling this method results in a call to Exchange Web Services (EWS).

Forward(MessageBody, EmailAddress[])

Forwards the appointment to the associated array of recipients with a message prepended to the original meeting request. Calling this method results in a call to Exchange Web Services (EWS).

Forward(MessageBody, IEnumerable<EmailAddress>)

Forwards the appointment to the associated collection of recipients with a message prepended to the original meeting request. Calling this method results in a call to Exchange Web Services (EWS).

GetLoadedPropertyDefinitions()

Provides the collection of loaded property definitions.

(Inherited from ServiceObject)
Load()

Loads the first-class properties.

(Inherited from ServiceObject)
Load(PropertySet)

Loads the specified set of properties.

(Inherited from ServiceObject)
Move(FolderId)

Moves this item to the specified folder. Calling this method results in a call to Exchange Web Services (EWS).

(Inherited from Item)
Move(WellKnownFolderName)

Moves this item to the specified folder. Calling this method results in a call to Exchange Web Services (EWS).

(Inherited from Item)
RemoveExtendedProperty(ExtendedPropertyDefinition)

Removes an extended property.

(Inherited from Item)
Reply(MessageBody, Boolean)

Replies to the organizer and/or the attendees of the meeting. Calling this method results in a call to Exchange Web Services (EWS).

Save()

Saves this item in the default folder based on the item's type. Calling this method results in at least one call to Exchange Web Services (EWS). Multiple calls to EWS might be made if attachments have been added.

(Inherited from Item)
Save(FolderId)

Saves this item in a specific folder. Calling this method results in at least one call to Exchange Web Services (EWS). Multiple calls to EWS might be made if attachments have been added.

(Inherited from Item)
Save(FolderId, SendInvitationsMode)

Saves this appointment in the specified folder. Calling this method results in at least one call to Exchange Web Services (EWS). Multiple calls to EWS might be made if attachments have been added.

Save(SendInvitationsMode)

Saves this appointment in the Calendar folder. Calling this method results in at least one call to Exchange Web Services (EWS). Multiple calls to EWS might be made if attachments have been added.

Save(WellKnownFolderName)

Saves this item in a specific folder. Calling this method results in at least one call to Exchange Web Services (EWS). Multiple calls to EWS might be made if attachments have been added.

(Inherited from Item)
Save(WellKnownFolderName, SendInvitationsMode)

Saves this appointment in the specified folder. Calling this method results in at least one call to Exchange Web Services (EWS). Multiple calls to EWS might be made if attachments have been added.

SetExtendedProperty(ExtendedPropertyDefinition, Object)

Sets the specified extended property to the specified value.

(Inherited from Item)
TryGetProperty(PropertyDefinitionBase, Object)

Tries to get the value of a specified property.

(Inherited from ServiceObject)
TryGetProperty<T>(PropertyDefinitionBase, T)

Tries to get the value of a specified property.

(Inherited from ServiceObject)
Update(ConflictResolutionMode)

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

(Inherited from Item)
Update(ConflictResolutionMode, Boolean)

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 from Item)
Update(ConflictResolutionMode, SendInvitationsOrCancellationsMode)

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

Applies to