Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Appointment

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

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

  • Initializes an unsaved local instance of . To bind to an existing appointment, use Appointment.Bind() instead.

    Parameters

    Returns Appointment

  • Initializes an unsaved local instance of . To bind to an existing appointment, use Appointment.Bind() instead.

    internal

    Initializes a new instance of Appointment.

    Parameters

    • parentAttachment: ItemAttachment

      Parent attachment.

    • isNew: boolean

      If true, attachment is new.

    Returns Appointment

Accessors

AdjacentMeetingCount

  • get AdjacentMeetingCount(): number
  • Gets the number of calendar entries that are adjacent to this appointment in the authenticated user's calendar.

    Returns number

AdjacentMeetings

  • Gets a list of meetings that is adjacent to this appointment in the authenticated user's calendar.

    Returns ItemCollection<Appointment>

AllowNewTimeProposal

  • get AllowNewTimeProposal(): boolean
  • set AllowNewTimeProposal(value: boolean): void
  • Gets or sets a value indicating whether new time proposals are allowed for attendees of this meeting.

    Returns boolean

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

    Parameters

    • value: boolean

    Returns void

AllowedResponseActions

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

    Returns ResponseActions

AppointmentReplyTime

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

    Returns DateTime

AppointmentSequenceNumber

  • get AppointmentSequenceNumber(): number
  • Gets the sequence number of this appointment.

    Returns number

AppointmentState

  • get AppointmentState(): number
  • Gets the state of this appointment.

    Returns number

AppointmentType

  • Gets a value indicating the type of this appointment.

    Returns AppointmentType

ArchiveTag

  • Gets or sets the archive tag.

    Returns ArchiveTag

  • Gets or sets the archive tag.

    Parameters

    Returns void

Attachments

Body

  • Gets or sets the body of this item.

    Returns MessageBody

  • Gets or sets the body of this item.

    Parameters

    Returns void

Categories

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

    Returns StringList

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

    Parameters

    Returns void

ConferenceType

  • get ConferenceType(): number
  • set ConferenceType(value: number): void
  • Gets or sets the type of conferencing that will be used during the meeting.

    Returns number

  • Gets or sets the type of conferencing that will be used during the meeting.

    Parameters

    • value: number

    Returns void

ConflictingMeetingCount

  • get ConflictingMeetingCount(): number
  • Gets the number of calendar entries that conflict with this appointment in the authenticated user's calendar.

    Returns number

ConflictingMeetings

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

    Returns ItemCollection<Appointment>

ConversationId

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

    Returns ConversationId

Culture

  • get Culture(): string
  • set Culture(value: string): void
  • Gets or sets the culture associated with this item.

    Returns string

  • Gets or sets the culture associated with this item.

    Parameters

    • value: string

    Returns void

DateTimeCreated

  • get DateTimeCreated(): Date
  • Gets the date and time this item was created.

    Returns Date

DateTimeReceived

  • get DateTimeReceived(): Date
  • Gets the time when this item was received.

    Returns Date

DateTimeSent

  • get DateTimeSent(): Date
  • Gets the date and time this item was sent.

    Returns Date

DefaultAffectedTaskOccurrences

  • internal

    Gets the default setting for how to treat affected task occurrences on Delete. Subclasses will override this for different default behavior.

    Returns AffectedTaskOccurrence

DefaultSendCancellationsMode

  • internal

    Gets the default setting for sending cancellations on Delete.

    Returns SendCancellationsMode

    If Delete() is called on Appointment, we want to send cancellations and save a copy.

DefaultSendInvitationsMode

DefaultSendInvitationsOrCancellationsMode

DeletedOccurrences

DisplayCc

  • get DisplayCc(): string
  • Gets a text summarizing the Cc receipients of this item.

    Returns string

DisplayTo

  • get DisplayTo(): string
  • Gets a text summarizing the To recipients of this item.

    Returns string

Duration

  • Gets the duration of this appointment.

    Returns TimeSpan

EffectiveRights

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

    Returns EffectiveRights

End

  • Gets or sets the end time of the appointment.

    Returns DateTime

  • Gets or sets the end time of the appointment.

    Parameters

    Returns void

EndTimeZone

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

    Returns TimeZoneInfo

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

    Parameters

    Returns void

EnhancedLocation

  • Gets or sets the Enhanced location object.

    Returns EnhancedLocation

  • Gets or sets the Enhanced location object.

    Parameters

    Returns void

EntityExtractionResult

ExtendedProperties

FirstOccurrence

  • Gets an OccurrenceInfo identifying the first occurrence of this meeting.

    Returns OccurrenceInfo

Flag

  • get Flag(): Flag
  • set Flag(value: Flag): void
  • Get or set the Flag value for this item.

    Returns Flag

  • Get or set the Flag value for this item.

    Parameters

    Returns void

HasAttachments

  • get HasAttachments(): boolean
  • Gets a value indicating whether the item has attachments.

    Returns boolean

ICalDateTimeStamp

  • Gets the ICalendar DateTimeStamp.

    Returns DateTime

ICalRecurrenceId

  • Gets the ICalendar RecurrenceId.

    Returns DateTime

ICalUid

  • get ICalUid(): string
  • set ICalUid(value: string): void
  • Gets or sets the ICalendar Uid.

    Returns string

  • Gets or sets the ICalendar Uid.

    Parameters

    • value: string

    Returns void

IconIndex

  • Gets the icon index.

    Returns IconIndex

Id

  • Gets the Id of this item.

    Returns ItemId

Importance

  • Gets or sets the importance of this item.

    Returns Importance

  • Gets or sets the importance of this item.

    Parameters

    Returns void

InReplyTo

  • get InReplyTo(): string
  • set InReplyTo(value: string): void
  • Gets or sets the In-Reply-To reference of this item.

    Returns string

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

    Parameters

    • value: string

    Returns void

InstanceKey

  • get InstanceKey(): number[]
  • Gets the item instance key.

    Returns number[]

InternetMessageHeaders

IsAllDayEvent

  • get IsAllDayEvent(): boolean
  • set IsAllDayEvent(value: boolean): void
  • Gets or sets a value indicating whether this appointment is an all day event.

    Returns boolean

  • Gets or sets a value indicating whether this appointment is an all day event.

    Parameters

    • value: boolean

    Returns void

IsAssociated

  • get IsAssociated(): boolean
  • Gets a value indicating whether this is an associated item.

    Returns boolean

IsAttachment

  • get IsAttachment(): boolean
  • Gets a value indicating whether the item is an attachment.

    Returns boolean

IsCancelled

  • get IsCancelled(): boolean
  • Gets a value indicating whether the appointment has been cancelled.

    Returns boolean

IsDirty

  • get IsDirty(): boolean
  • Gets a value indicating whether the object has been modified and should be saved.

    Returns boolean

IsDraft

  • get IsDraft(): boolean
  • Gets a value indicating whether the item is is a draft. An item is a draft when it has not yet been sent.

    Returns boolean

IsFromMe

  • get IsFromMe(): boolean
  • Gets a value indicating whether the item has been sent by the current authenticated user.

    Returns boolean

IsMeeting

  • get IsMeeting(): boolean
  • Gets a value indicating whether the appointment is a meeting.

    Returns boolean

IsNew

  • get IsNew(): boolean
  • 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.

    Returns boolean

IsOnlineMeeting

  • get IsOnlineMeeting(): boolean
  • set IsOnlineMeeting(value: boolean): void
  • Gets or sets a value indicating whether this is an online meeting.

    Returns boolean

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

    Parameters

    • value: boolean

    Returns void

IsRecurring

  • get IsRecurring(): boolean
  • Gets a value indicating whether the appointment is recurring.

    Returns boolean

IsReminderSet

  • get IsReminderSet(): boolean
  • set IsReminderSet(value: boolean): void
  • Gets or sets a value indicating whether a reminder is set for this item.

    Returns boolean

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

    Parameters

    • value: boolean

    Returns void

IsResend

  • get IsResend(): boolean
  • Gets a value indicating whether the item is a resend of another item.

    Returns boolean

IsResponseRequested

  • get IsResponseRequested(): boolean
  • set IsResponseRequested(value: boolean): void
  • Gets or sets a value indicating whether responses are requested when invitations are sent for this meeting.

    Returns boolean

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

    Parameters

    • value: boolean

    Returns void

IsSubmitted

  • get IsSubmitted(): boolean
  • Gets a value indicating whether the message has been submitted to be sent.

    Returns boolean

IsUnmodified

  • get IsUnmodified(): boolean
  • Gets a value indicating whether the item has been modified since it was created.

    Returns boolean

ItemClass

  • get ItemClass(): string
  • set ItemClass(value: string): void
  • Gets or sets the custom class name of this item.

    Returns string

  • Gets or sets the custom class name of this item.

    Parameters

    • value: string

    Returns void

JoinOnlineMeetingUrl

  • get JoinOnlineMeetingUrl(): string
  • Gets the Url for joining an online meeting

    Returns string

LastModifiedName

  • get LastModifiedName(): string
  • Gets the name of the user who last modified this item.

    Returns string

LastModifiedTime

  • get LastModifiedTime(): Date
  • Gets the date and time this item was last modified.

    Returns Date

LastOccurrence

  • Gets an OccurrenceInfo identifying the last occurrence of this meeting.

    Returns OccurrenceInfo

LegacyFreeBusyStatus

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

    Returns LegacyFreeBusyStatus

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

    Parameters

    Returns void

Location

  • get Location(): string
  • set Location(value: string): void
  • Gets or sets the location of this appointment.

    Returns string

  • Gets or sets the location of this appointment.

    Parameters

    • value: string

    Returns void

MeetingRequestWasSent

  • get MeetingRequestWasSent(): boolean
  • Gets a value indicating whether the meeting request has already been sent.

    Returns boolean

MeetingWorkspaceUrl

  • get MeetingWorkspaceUrl(): string
  • set MeetingWorkspaceUrl(value: string): void
  • Gets or sets the URL of the meeting workspace. A meeting workspace is a shared Web site for planning meetings and tracking results.

    Returns string

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

    Parameters

    • value: string

    Returns void

MimeContent

  • Get or sets the MIME content of this item.

    Returns MimeContent

  • Get or sets the MIME content of this item.

    Parameters

    Returns void

ModifiedOccurrences

  • Gets a list of modified occurrences for this meeting.

    Returns OccurrenceInfoCollection

MyResponseType

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

    Returns MeetingResponseType

NetShowUrl

  • get NetShowUrl(): string
  • set NetShowUrl(value: string): void
  • Gets or sets the URL of the Microsoft NetShow online meeting.

    Returns string

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

    Parameters

    • value: string

    Returns void

NormalizedBody

OnlineMeetingSettings

  • Gets the Online Meeting Settings

    Returns OnlineMeetingSettings

OptionalAttendees

  • Gets a list of optional attendeed for this meeting.

    Returns AttendeeCollection

Organizer

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

    Returns EmailAddress

OriginalStart

  • Gets the original start time of this appointment.

    Returns DateTime

ParentAttachment

ParentFolderId

  • Gets the Id of the parent folder of this item.

    Returns FolderId

PolicyTag

  • Gets or sets the policy tag.

    Returns PolicyTag

  • Gets or sets the policy tag.

    Parameters

    Returns void

Preview

  • get Preview(): string
  • Gets the item Preview.

    Returns string

PropertyBag

Recurrence

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

    Returns Recurrence

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

    Parameters

    Returns void

ReminderDueBy

  • get ReminderDueBy(): Date
  • set ReminderDueBy(value: Date): void
  • Gets or sets the date and time when the reminder is due for this item.

    Returns Date

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

    Parameters

    • value: Date

    Returns void

ReminderMinutesBeforeStart

  • get ReminderMinutesBeforeStart(): number
  • set ReminderMinutesBeforeStart(value: number): void
  • Gets or sets the number of minutes before the start of this item when the reminder should be triggered.

    Returns number

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

    Parameters

    • value: number

    Returns void

RequiredAttendees

  • Gets a list of required attendees for this meeting.

    Returns AttendeeCollection

Resources

  • Gets a list of resources for this meeting.

    Returns AttendeeCollection

RetentionDate

  • get RetentionDate(): Date
  • Gets the retention date.

    Returns Date

RootItemId

  • internal

    Gets Id of the root item for this item.

    Returns ItemId

Schema

Sensitivity

  • Gets or sets the sensitivity of this item.

    Returns Sensitivity

  • Gets or sets the sensitivity of this item.

    Parameters

    Returns void

Service

Size

  • get Size(): number
  • Gets the size of this item.

    Returns number

Start

  • Gets or sets the start time of the appointment.

    Returns DateTime

  • Gets or sets the start time of the appointment.

    Parameters

    Returns void

StartTimeZone

  • Gets or sets time zone of the start property of this appointment.

    Returns TimeZoneInfo

  • Gets or sets time zone of the start property of this appointment.

    Parameters

    Returns void

StoreEntryId

  • get StoreEntryId(): number[]
  • Gets the store entry id.

    Returns number[]

Subject

  • get Subject(): string
  • set Subject(value: string): void
  • Gets or sets the subject of this item.

    Returns string

  • Gets or sets the subject of this item.

    Parameters

    • value: string

    Returns void

TextBody

  • Gets the text body of the item.

    Returns TextBody

TimeZone

  • get TimeZone(): string
  • Gets the name of the time zone this appointment is defined in.

    Returns string

UniqueBody

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

    Returns UniqueBody

WebClientEditFormQueryString

  • get WebClientEditFormQueryString(): string
  • Gets the query string that should be appended to the Exchange Web client URL to open this item using the appropriate edit form in a web browser.

    Returns string

WebClientReadFormQueryString

  • get WebClientReadFormQueryString(): string
  • Gets the query string that should be appended to the Exchange Web client URL to open this item using the appropriate read form in a web browser.

    Returns string

When

  • get When(): string
  • Gets a text indicating when this appointment occurs. The text returned by When is localized using the Exchange Server culture or using the culture specified in the PreferredCulture property of the ExchangeService object this appointment is bound to.

    Returns string

Methods

Accept

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

    Parameters

    • sendResponse: boolean

      Indicates whether to send a response to the organizer.

    Returns IPromise<CalendarActionResults>

    A CalendarActionResults object containing the various items that were created or modified as a results of this operation :Promise.

AcceptTentatively

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

    Parameters

    • sendResponse: boolean

      Indicates whether to send a response to the organizer.

    Returns IPromise<CalendarActionResults>

    A CalendarActionResults object containing the various items that were created or modified as a results of this operation :Promise.

Bind

  • Binds to an existing item, whatever its actual type is, and loads the specified set of properties. Calling this method results in a call to EWS.

    Parameters

    • service: ExchangeService

      The service to use to bind to the item.

    • id: ItemId

      The Id of the item to bind to.

    Returns IPromise<Item>

    An Item instance representing the item corresponding to the specified Id :Promise.

CancelMeeting

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

    Returns IPromise<CalendarActionResults>

    A CalendarActionResults object containing the various items that were created or modified as a results of this operation :Promise.

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

    Parameters

    • cancellationMessageText: string

      Cancellation message text sent to all attendees.

    Returns IPromise<CalendarActionResults>

    A CalendarActionResults object containing the various items that were created or modified as a results of this operation :Promise.

Changed

  • Changed(): void
  • Triggers dispatch of the change event.

    Returns void

ClearChangeLog

  • ClearChangeLog(): void
  • Clears the object's change log.

    Returns void

Copy

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

    Copy returns null if the copy operation is across two mailboxes or between a mailbox and a public folder.

    Parameters

    • destinationFolderName: WellKnownFolderName

      The name of the folder in which to create a copy of this item.

    Returns IPromise<Item>

    The copy of this item :Promise.

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

    Copy returns null if the copy operation is across two mailboxes or between a mailbox and a public folder.

    Parameters

    • destinationFolderId: FolderId

      The Id of the folder in which to create a copy of this item.

    Returns IPromise<Item>

    The copy of this item :Promise.

CreateAcceptMessage

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

    Parameters

    • tentative: boolean

      Specifies whether the meeting will be tentatively accepted.

    Returns AcceptMeetingInvitationMessage

    An AcceptMeetingInvitationMessage representing the meeting acceptance message.

CreateCancelMeetingMessage

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

    Returns CancelMeetingMessage

    A CancelMeetingMessage representing the meeting cancellation message.

CreateDeclineMessage

CreateForward

  • Creates a forward message from this appointment.

    Returns ResponseMessage

    A ResponseMessage representing the forward response that can subsequently be modified and sent.

CreateReply

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

    Parameters

    • replyAll: boolean

      Indicates whether the reply should go to the organizer only or to all the attendees.

    Returns ResponseMessage

    A ResponseMessage representing the reply response that can subsequently be modified and sent.

Decline

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

    Parameters

    • sendResponse: boolean

      Indicates whether to send a response to the organizer.

    Returns IPromise<CalendarActionResults>

    A CalendarActionResults object containing the various items that were created or modified as aresults of this operation :Promise.

Delete

  • Deletes this appointment. Calling this method results in a call to EWS.

    Parameters

    • deleteMode: DeleteMode

      The deletion mode.

    • sendCancellationsMode: SendCancellationsMode

      Specifies if and how cancellations should be sent if this appointment is a meeting.

    Returns IPromise<void>

Forward

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

    Parameters

    • bodyPrefix: MessageBody

      The prefix to prepend to the original body of the message.

    • toRecipients: EmailAddress[]

      The recipients to forward the appointment to.

    Returns IPromise<void>

GetChangeXmlElementName

  • GetChangeXmlElementName(): string
  • Gets the name of the change XML element.

    Returns string

    XML element name,

GetDeleteFieldXmlElementName

  • GetDeleteFieldXmlElementName(): string

GetExtendedProperties

GetId

  • The unique Id of this object.

    Returns ServiceId

    A ServiceId instance..

GetIdPropertyDefinition

GetIsCustomDateTimeScopingRequired

  • GetIsCustomDateTimeScopingRequired(): boolean
  • internal

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

    Returns boolean

    true if this item type requires custom scoping for scoped date/time properties; otherwise, false.

GetIsTimeZoneHeaderRequired

  • GetIsTimeZoneHeaderRequired(isUpdateOperation: boolean): boolean
  • internal

    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.

    Parameters

    • isUpdateOperation: boolean

      Indicates whether the operation being petrformed is an update operation.

    Returns boolean

    true if a time zone SOAP header should be emitted; otherwise, false.

GetLoadedPropertyDefinitions

GetMinimumRequiredServerVersion

  • internal

    Gets the minimum required server version.

    Returns ExchangeVersion

    Earliest Exchange version in which this service object type is supported.

GetSchema

  • internal

    Internal method to return the schema associated with this type of object.

    Returns ServiceObjectSchema

    The schema associated with this type of object.

GetSetFieldXmlElementName

  • GetSetFieldXmlElementName(): string

GetXmlElementName

  • GetXmlElementName(): string
  • internal

    Gets the element name of item in XML

    Returns string

    name of elelment

GetXmlElementNameOverride

  • GetXmlElementNameOverride(): string
  • This methods lets subclasses of ServiceObject override the default mechanism by which the XML element name associated with their type is retrieved.

    Returns string

    The XML element name associated with this type. If this method returns null or empty, the XML element name associated with this type is determined by the EwsObjectDefinition attribute that decorates the type, if present.

HasUnprocessedAttachmentChanges

  • HasUnprocessedAttachmentChanges(): boolean
  • internal

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

    Returns boolean

    true or false.

InternalAccept

  • internal

    Accepts the meeting.

    Parameters

    • tentative: boolean

      True if tentative accept.

    • sendResponse: boolean

      Indicates whether to send a response to the organizer.

    Returns IPromise<CalendarActionResults>

    A CalendarActionResults object containing the various items that were created or modified as aresults of this operation :Promise.

InternalCreate

InternalDelete

InternalLoad

InternalUpdate

Load

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

    Returns IPromise<void>

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

    Parameters

    • Optional propertySet: PropertySet

      The properties to load.

    Returns IPromise<void>

LoadFromXmlJsObject

  • LoadFromXmlJsObject(jsObject: any, service: ExchangeService, clearPropertyBag: boolean, requestedPropertySet?: PropertySet, summaryPropertiesOnly?: boolean): void
  • Loads service object from XML.

    Parameters

    • jsObject: any

      Jason Object converted from XML.

    • service: ExchangeService

      The service.

    • clearPropertyBag: boolean

      if set to true [clear property bag].

    • Default value requestedPropertySet: PropertySet = null

      The property set.

    • Default value summaryPropertiesOnly: boolean = false

      if set to true [summary props only].

    Returns void

Move

  • Moves this item to a the specified folder. Calling this method results in a call to EWS.

    Move returns null if the move operation is across two mailboxes or between a mailbox and a public folder.

    Parameters

    • destinationFolderId: FolderId

      The Id of the folder to which to move this item.

    Returns IPromise<Item>

    The moved copy of this item :Promise.

  • Moves this item to a the specified folder. Calling this method results in a call to EWS.

    Move returns null if the move operation is across two mailboxes or between a mailbox and a public folder.

    Parameters

    • destinationFolderName: WellKnownFolderName

      The name of the folder to which to move this item.

    Returns IPromise<Item>

    The moved copy of this item :Promise.

RemoveExtendedProperty

  • Removes an extended property.

    Parameters

    Returns boolean

    True if property was removed.

Reply

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

    Parameters

    • bodyPrefix: MessageBody

      The prefix to prepend to the body of the meeting.

    • replyAll: boolean

      Indicates whether the reply should go to the organizer only or to all the attendees.

    Returns IPromise<void>

Save

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

    Parameters

    • sendInvitationsMode: SendInvitationsMode

      Specifies if and how invitations should be sent if this appointment is a meeting.

    Returns IPromise<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.

    Parameters

    • destinationFolderName: WellKnownFolderName

      The name of the folder in which to save this appointment.

    • sendInvitationsMode: SendInvitationsMode

      Specifies if and how invitations should be sent if this appointment is a meeting.

    Returns IPromise<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.

    Parameters

    • destinationFolderId: FolderId

      The Id of the folder in which to save this appointment.

    • sendInvitationsMode: SendInvitationsMode

      Specifies if and how invitations should be sent if this appointment is a meeting.

    Returns IPromise<void>

SetExtendedProperty

  • Sets the extended property.

    Parameters

    Returns void

SetSubject

  • SetSubject(subject: string): void
  • internal

    Sets the subject.

    Parameters

    • subject: string

    Returns void

ThrowIfThisIsAttachment

  • ThrowIfThisIsAttachment(): void
  • Throws exception if this is attachment.

    Returns void

ThrowIfThisIsNew

  • ThrowIfThisIsNew(): void
  • Throws exception if this is a new service object.

    Returns void

ThrowIfThisIsNotNew

  • ThrowIfThisIsNotNew(): void
  • Throws exception if this is not a new service object.

    Returns void

TryGetExtendedProperty

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

    Type parameters

    • T

    Parameters

    Returns boolean

    True if property retrieved, false otherwise.

TryGetProperty

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

    Type parameters

    • T

    Parameters

    Returns boolean

    True if property retrieved, false otherwise.

Update

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

    Parameters

    Returns IPromise<void>

Validate

  • Validate(): void
  • internal

    Validates this instance.

    Returns void

WriteToXml

WriteToXmlForUpdate

_getItem

  • Gets the value of specified property in this instance. This Indexer of c#

    Parameters

    Returns any

Static Bind

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

    Parameters

    • service: ExchangeService

      The service to use to bind to the appointment.

    • id: ItemId

      The Id of the appointment to bind to.

    Returns IPromise<Appointment>

    An Appointment instance representing the appointment corresponding to the specified Id :Promise.

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

    Parameters

    • service: ExchangeService

      The service to use to bind to the appointment.

    • id: ItemId

      The Id of the appointment to bind to.

    • propertySet: PropertySet

      The set of properties to load.

    Returns IPromise<Appointment>

    An Appointment instance representing the appointment corresponding to the specified Id :Promise.

Static BindToOccurrence

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

    Parameters

    • service: ExchangeService

      The service to use to bind to the appointment.

    • recurringMasterId: ItemId

      The Id of the recurring master that the index represents an occurrence of.

    • occurenceIndex: number

      The index of the occurrence.

    Returns IPromise<Appointment>

    An Appointment instance representing the appointment occurence corresponding to the specified occurence index :Promise.

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

    Parameters

    • service: ExchangeService

      The service to use to bind to the appointment.

    • recurringMasterId: ItemId

      The Id of the recurring master that the index represents an occurrence of.

    • occurenceIndex: number

      The index of the occurrence.

    • propertySet: PropertySet

      The set of properties to load.

    Returns IPromise<Appointment>

    An Appointment instance representing the appointment occurence corresponding to the specified occurence index :Promise.

Static BindToRecurringMaster

  • Binds to the master appointment of a recurring series and loads the specified set of properties. Calling this method results in a call to EWS.

    Parameters

    • service: ExchangeService

      The service to use to bind to the appointment.

    • occurrenceId: ItemId

      The Id of one of the occurrences in the series.

    Returns IPromise<Appointment>

    An Appointment instance representing the master appointment of the recurring series to which the specified occurrence belongs :Promise.

  • Binds to the master appointment of a recurring series and loads the specified set of properties. Calling this method results in a call to EWS.

    Parameters

    • service: ExchangeService

      The service to use to bind to the appointment.

    • occurrenceId: ItemId

      The Id of one of the occurrences in the series.

    • propertySet: PropertySet

      The set of properties to load.

    Returns IPromise<Appointment>

    An Appointment instance representing the master appointment of the recurring series to which the specified occurrence belongs :Promise.

Generated using TypeDoc