PropertyDefinition | Ews JavaScript Api

Represents the definition of a folder or item property.

Hierarchy

ServiceObjectPropertyDefinition
- PropertyDefinition

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new PropertyDefinition(propertyName: string, xmlElementName: string, uri: string, version: ExchangeVersion): PropertyDefinition
new PropertyDefinition(propertyName: string, xmlElementName: string, flags: PropertyDefinitionFlags, version: ExchangeVersion): PropertyDefinition
new PropertyDefinition(propertyName: string, xmlElementName: string, uri: string, flags: PropertyDefinitionFlags, version: ExchangeVersion): PropertyDefinition

Overwrites ServiceObjectPropertyDefinition.constructor
- Defined in PropertyDefinitions/PropertyDefinition.ts:52
internal

Initializes a new instance of the PropertyDefinition class.

Parameters
- propertyName: string
  
  Name of the property (added to workaround reflection based initialization of Names).
- xmlElementName: string
  
  Name of the XML element.
- uri: string
  
  The URI.
- version: ExchangeVersion
  
  The version.
Returns PropertyDefinition
Overwrites ServiceObjectPropertyDefinition.constructor
- Defined in PropertyDefinitions/PropertyDefinition.ts:62
internal

Initializes a new instance of the PropertyDefinition class.

Parameters
- propertyName: string
  
  Name of the property (added to workaround reflection based initialization of Names).
- xmlElementName: string
  
  Name of the XML element.
- flags: PropertyDefinitionFlags
  
  The flags.
- version: ExchangeVersion
  
  The version.
Returns PropertyDefinition
Overwrites ServiceObjectPropertyDefinition.constructor
- Defined in PropertyDefinitions/PropertyDefinition.ts:71
internal

Initializes a new instance of the PropertyDefinition class.

Parameters
- propertyName: string
  
  Name of the property (added to workaround reflection based initialization of Names).
- xmlElementName: string
  
  Name of the XML element.
- uri: string
  
  The URI.
- flags: PropertyDefinitionFlags
  
  The flags.
- version: ExchangeVersion
  
  The version.
Returns PropertyDefinition

Properties

Private flags

flags: PropertyDefinitionFlags

Private name

name: string

Private version

version: ExchangeVersion

Private xmlElementName

xmlElementName: string

Accessors

IsNullable

get IsNullable(): boolean

- Defined in PropertyDefinitions/PropertyDefinition.ts:24
internalgets

a value indicating whether this property definition is for a nullable type (ref, int?, bool?...).

Returns boolean

Name

get Name(): string
set Name(value: string): void

- Defined in PropertyDefinitions/PropertyDefinition.ts:29
Gets the name of the property.

Returns string
- Defined in PropertyDefinitions/PropertyDefinition.ts:38
Gets the name of the property.

Parameters
- value: string
Returns void

Type

get Type(): any

Inherited from PropertyDefinitionBase.Type
- Defined in PropertyDefinitions/PropertyDefinitionBase.ts:28
Gets the type of the property.

Returns any

Uri

get Uri(): string

Inherited from ServiceObjectPropertyDefinition.Uri
- Defined in PropertyDefinitions/ServiceObjectPropertyDefinition.ts:27
internal

Gets the URI of the property definition.

Returns string

Version

get Version(): ExchangeVersion

Overwrites ServiceObjectPropertyDefinition.Version
- Defined in PropertyDefinitions/PropertyDefinition.ts:45
Gets the minimum Exchange version that supports this property.

value

{ExchangeVersion} The version.

Returns ExchangeVersion

XmlElementName

get XmlElementName(): string

- Defined in PropertyDefinitions/PropertyDefinition.ts:52
internalgets

the name of the XML element.

value

{string} The name of the XML element.

Returns string

Methods

GetAssociatedInternalProperties

GetAssociatedInternalProperties(): PropertyDefinition[]

- Defined in PropertyDefinitions/PropertyDefinition.ts:108
internalgets

a list of associated internal properties.

remarks

This is a hack. It is here (currently) solely to help the API register the MeetingTimeZone property definition that is internal.

Returns PropertyDefinition[]

A list of PropertyDefinition objects.

GetPrintableName

GetPrintableName(): string

Overwrites PropertyDefinitionBase.GetPrintableName
- Defined in PropertyDefinitions/PropertyDefinition.ts:121
internalgets

the property definition's printable name.

Returns string

The property definition's printable name.

GetXmlElementName

GetXmlElementName(): string

Inherited from ServiceObjectPropertyDefinition.GetXmlElementName

Overwrites PropertyDefinitionBase.GetXmlElementName
- Defined in PropertyDefinitions/ServiceObjectPropertyDefinition.ts:56
internal

Gets the name of the XML element.

Returns string

XML element name.

HasFlag

HasFlag(flag: PropertyDefinitionFlags): boolean
HasFlag(flag: PropertyDefinitionFlags, version: ExchangeVersion): boolean

- Defined in PropertyDefinitions/PropertyDefinition.ts:129
internaldetermines

whether the specified flag is set.

Parameters
- flag: PropertyDefinitionFlags
  
  The flag.
Returns boolean

true if the specified flag is set; otherwise, false.
- Defined in PropertyDefinitions/PropertyDefinition.ts:137
internaldetermines

whether the specified flag is set.

Parameters
- flag: PropertyDefinitionFlags
  
  The flag.
- version: ExchangeVersion
  
  Requested version.
Returns boolean

true if the specified flag is set; otherwise, false.

LoadPropertyValueFromXmlJsObject

LoadPropertyValueFromXmlJsObject(jsObject: any, service: ExchangeService, propertyBag: PropertyBag): void

- Defined in PropertyDefinitions/PropertyDefinition.ts:149
internal

Loads the property value from json.

Parameters
- jsObject: any
  
  The JSON value. Can be a JsonObject, string, number, bool, array, or null.
- service: ExchangeService
  
  The service.
- propertyBag: PropertyBag
  
  The property bag.
Returns void

RegisterAssociatedInternalProperties

RegisterAssociatedInternalProperties(properties: PropertyDefinition[]): void

- Defined in PropertyDefinitions/PropertyDefinition.ts:156
internalregisters

associated internal properties.

Parameters
- properties: PropertyDefinition[]
  
  The list in which to add the associated properties.
Returns void

ToString

ToString(): string

Inherited from PropertyDefinitionBase.ToString
- Defined in PropertyDefinitions/PropertyDefinitionBase.ts:48
Returns string

WriteAttributesToXml

WriteAttributesToXml(writer: EwsServiceXmlWriter): void

Inherited from ServiceObjectPropertyDefinition.WriteAttributesToXml

Overwrites PropertyDefinitionBase.WriteAttributesToXml
- Defined in PropertyDefinitions/ServiceObjectPropertyDefinition.ts:63
internal

Writes the attributes to XML.

Parameters
- writer: EwsServiceXmlWriter
  
  The writer.
Returns void

WritePropertyValueToXml

WritePropertyValueToXml(writer: EwsServiceXmlWriter, propertyBag: PropertyBag, isUpdateOperation: boolean): void

- Defined in PropertyDefinitions/PropertyDefinition.ts:166
internalwrites

the property value to XML.

Parameters
- writer: EwsServiceXmlWriter
  
  The writer.
- propertyBag: PropertyBag
  
  The property bag.
- isUpdateOperation: boolean
  
  Indicates whether the context is an update operation.
Returns void

WriteToXml

WriteToXml(writer: EwsServiceXmlWriter): void

Inherited from PropertyDefinitionBase.WriteToXml
- Defined in PropertyDefinitions/PropertyDefinitionBase.ts:94
internal

Writes to XML.

Parameters
- writer: EwsServiceXmlWriter
  
  The writer.
Returns void

Static LoadFromXmlJsObject

LoadFromXmlJsObject(jsObject: any): PropertyDefinitionBase

Inherited from PropertyDefinitionBase.LoadFromXmlJsObject
- Defined in PropertyDefinitions/PropertyDefinitionBase.ts:57
internal

load from XMLJsObject.

Parameters
- jsObject: any
Returns PropertyDefinitionBase

True if property was loaded.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

propertyName: string

xmlElementName: string

uri: string

version: ExchangeVersion

Returns PropertyDefinition

Parameters

propertyName: string

xmlElementName: string

flags: PropertyDefinitionFlags

version: ExchangeVersion

Returns PropertyDefinition

Parameters

propertyName: string

xmlElementName: string

uri: string

flags: PropertyDefinitionFlags

version: ExchangeVersion

Returns PropertyDefinition

Properties

Private flags

Private name

Private version

Private xmlElementName

Accessors

IsNullable

Returns boolean

Name

Returns string

Parameters

value: string

Returns void

Type

Returns any

Uri

Returns string

Version

Returns ExchangeVersion

XmlElementName

Returns string

Methods

GetAssociatedInternalProperties

Returns PropertyDefinition[]

GetPrintableName

Returns string

GetXmlElementName

Returns string

HasFlag

Parameters

flag: PropertyDefinitionFlags

Returns boolean

Parameters

flag: PropertyDefinitionFlags

version: ExchangeVersion

Returns boolean

LoadPropertyValueFromXmlJsObject

Parameters

jsObject: any

service: ExchangeService

propertyBag: PropertyBag

Returns void

RegisterAssociatedInternalProperties

Parameters

properties: PropertyDefinition[]

Returns void

ToString

Returns string

WriteAttributesToXml

Parameters

writer: EwsServiceXmlWriter

Returns void

WritePropertyValueToXml