Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Item

Represents a generic Item. Properties available on items are defined in the ItemSchema class.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • internal

    Initializes an unsaved local instance of Item. To bind to an existing item, use Item.Bind() instead.

    Parameters

    Returns Item

  • internal

    Initializes a new instance of the Item class. To bind to an existing item, use Item.Bind() instead

    Parameters

    Returns Item

  • internal

    used for super call, easier to manage, do not use in Actual code. //todo:fix - [ ] remove from d.ts file.

    Parameters

    Returns Item

Properties

Private parentAttachment

parentAttachment: ItemAttachment

Accessors

AllowedResponseActions

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

    Returns ResponseActions

ArchiveTag

  • Gets or sets the archive tag.

    Returns ArchiveTag

  • Gets or sets the archive tag.

    Parameters

    Returns void

Attachments

  • Gets a list of the attachments to this item.

    Returns AttachmentCollection

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

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. Subclasses will override this for different default behavior.

    Returns SendCancellationsMode

DefaultSendInvitationsMode

  • internal

    Gets the default settings for sending invitations on Save. Subclasses will override this for different default behavior.

    Returns SendInvitationsMode

DefaultSendInvitationsOrCancellationsMode

  • internal

    Gets the default settings for sending invitations or cancellations on Update. Subclasses will override this for different default behavior.

    Returns SendInvitationsOrCancellationsMode

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

EffectiveRights

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

    Returns EffectiveRights

EntityExtractionResult

  • Gets the EntityExtractionResult of the item.

    Returns EntityExtractionResult

ExtendedProperties

  • Gets a list of extended properties defined on this item.

    Returns ExtendedPropertyCollection

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

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

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

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

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

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

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

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

MimeContent

  • Get or sets the MIME content of this item.

    Returns MimeContent

  • Get or sets the MIME content of this item.

    Parameters

    Returns void

NormalizedBody

  • Gets the normalized body of the item.

    Returns NormalizedBody

ParentAttachment

  • internal

    Gets the parent attachment of this item.

    Returns ItemAttachment

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

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

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

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

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

Methods

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.

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

    • propertySet: PropertySet

      The set of properties to load.

    Returns IPromise<Item>

    An Item instance representing the item corresponding to the specified Id :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.

Delete

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

    Parameters

    Returns IPromise<void>

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

    Parameters

    • deleteMode: DeleteMode

      The deletion mode.

    • suppressReadReceipts: boolean

      Whether to suppress read receipts

    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

  • 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

  • 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

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.

InternalCreate

  • internal

    Create item.

    Parameters

    Returns IPromise<void>

InternalDelete

  • internal

    Deletes the object.

    Parameters

    • deleteMode: DeleteMode

      The deletion mode.

    • sendCancellationsMode: SendCancellationsMode

      Indicates whether meeting cancellation messages should be sent.

    • affectedTaskOccurrences: AffectedTaskOccurrence

      Indicate which occurrence of a recurring task should be deleted.

    Returns IPromise<void>

  • internal

    Deletes the object.

    Parameters

    • deleteMode: DeleteMode

      The deletion mode.

    • sendCancellationsMode: SendCancellationsMode

      Indicates whether meeting cancellation messages should be sent.

    • affectedTaskOccurrences: AffectedTaskOccurrence

      Indicate which occurrence of a recurring task should be deleted.

    • suppressReadReceipts: boolean

      Whether to suppress read receipts

    Returns IPromise<void>

InternalLoad

  • internal

    Loads the specified set of properties on the object.

    Parameters

    Returns IPromise<void>

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.

Save

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

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

    Parameters

    • Optional parentFolderName: WellKnownFolderName

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

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

    Parameters

    • Optional parentFolderId: FolderId

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

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

    Parameters

    Returns IPromise<void>

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

    Parameters

    • conflictResolutionMode: ConflictResolutionMode

      The conflict resolution mode.

    • suppressReadReceipts: boolean

      Whether to suppress read receipts

    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

Generated using TypeDoc