Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents the base class for all responses that can be sent.

Type parameters

Hierarchy

Index

Constructors

constructor

  • Initializes a new instance of the ResponseObject class.

    Parameters

    • referenceItem: Item

      The reference item.

    Returns ResponseObject

Properties

Private referenceItem

referenceItem: Item

Accessors

IsDeliveryReceiptRequested

  • get IsDeliveryReceiptRequested(): boolean
  • set IsDeliveryReceiptRequested(value: boolean): void
  • Gets or sets a value indicating whether delivery receipts should be sent to the sender.

    Returns boolean

  • Gets or sets a value indicating whether delivery receipts should be sent to the sender.

    Parameters

    • value: boolean

    Returns void

IsDirty

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

    Returns boolean

IsNew

  • get IsNew(): boolean
  • Indicates whether this object is a real store item, or if it's a local object that has yet to be saved.

    Returns boolean

IsReadReceiptRequested

  • get IsReadReceiptRequested(): boolean
  • set IsReadReceiptRequested(value: boolean): void
  • Gets or sets a value indicating whether read receipts will be requested from recipients of this response.

    Returns boolean

  • Gets or sets a value indicating whether read receipts will be requested from recipients of this response.

    Parameters

    • value: boolean

    Returns void

PropertyBag

Schema

Service

Methods

Changed

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

    Returns void

ClearChangeLog

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

    Returns 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 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
  • GetXmlElementName retrieves the XmlElementName of this type based on the EwsObjectDefinition attribute that decorates it, if present.

    Returns string

    The XML element name associated with this type.

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.

InternalCreate

  • Create the response object.

    Parameters

    Returns IPromise<Item[]>

    The list of items returned by EWS.

InternalDelete

InternalLoad

  • Loads the specified set of properties on the object.

    Parameters

    Returns IPromise<void>

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

Save

  • Saves the response in the Drafts folder. Calling this method results in a call to EWS.

    Returns IPromise<TMessage>

    A TMessage that represents the response.

  • Saves the response in the specified folder. Calling this method results in a call to EWS.

    Parameters

    • destinationFolderName: WellKnownFolderName

      The name of the folder in which to save the response.

    Returns IPromise<TMessage>

    A TMessage that represents the response.

  • Saves the response in the specified folder. Calling this method results in a call to EWS.

    Parameters

    • destinationFolderId: FolderId

      The Id of the folder in which to save the response.

    Returns IPromise<TMessage>

    A TMessage that represents the response.

Send

  • Sends this response without saving a copy. Calling this method results in a call to EWS.

    Returns IPromise<void>

SendAndSaveCopy

  • Sends this response and saves a copy in the Sent Items folder. Calling this method results in a call to EWS.

    Returns IPromise<void>

  • Sends this response and saves a copy in the specified folder. Calling this method results in a call to EWS.

    Parameters

    • destinationFolderName: WellKnownFolderName

      The name of the folder in which to save the copy of the message.

    Returns IPromise<void>

  • Sends this response and saves a copy in the specified folder. Calling this method results in a call to EWS.

    Parameters

    • destinationFolderId: FolderId

      The Id of the folder in which to save the copy of the message.

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

Validate

  • Validate(): void
  • 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