Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServiceObject

Hierarchy

Index

Constructors

constructor

  • Internal constructor.

    Parameters

    Returns ServiceObject

Properties

Private OnChange

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

Private lockObject

lockObject: any

Private propertyBag

propertyBag: PropertyBag

Private service

Private xmlElementName

xmlElementName: string

Accessors

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

PropertyBag

  • The property bag holding property values for this object.

    Returns PropertyBag

Schema

  • Gets the schema associated with this type of object.

    Returns ServiceObjectSchema

Service

  • Gets the ExchangeService the object is bound to.

    Returns ExchangeService

  • Gets the ExchangeService the object is bound to.

    Parameters

    Returns void

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
  • Gets the name of the delete field XML element.

    Returns string

    XML element name,

GetExtendedProperties

  • Gets the extended properties collection.

    Returns ExtendedPropertyCollection

    Extended properties collection.

GetId

  • The unique Id of this object.

    Returns ServiceId

    A ServiceId instance..

GetIdPropertyDefinition

  • The property definition for the Id of this object.

    Returns PropertyDefinition

    A PropertyDefinition instance.

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

  • Gets the collection of loaded property definitions.

    Returns PropertyDefinitionBase[]

    Collection of property definitions.

GetMinimumRequiredServerVersion

  • Gets the minimum required server version.

    Returns ExchangeVersion

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

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
  • Gets the name of the set field XML element.

    Returns string

    XML element name,

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.

InternalDelete

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

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

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

  • Writes service object as XML.

    Parameters

    Returns void

WriteToXmlForUpdate

  • Writes service object for update as XML.

    Parameters

    Returns void

_getItem

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

    Parameters

    Returns any

Generated using TypeDoc