ExtendedPropertyDefinition | Ews JavaScript Api

Represents the definition of an extended property.

Hierarchy

PropertyDefinitionBase
- ExtendedPropertyDefinition

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ExtendedPropertyDefinition(): ExtendedPropertyDefinition
new ExtendedPropertyDefinition(mapiType: MapiPropertyType): ExtendedPropertyDefinition
new ExtendedPropertyDefinition(tag: number, mapiType: MapiPropertyType): ExtendedPropertyDefinition
new ExtendedPropertyDefinition(propertySet: DefaultExtendedPropertySet, name: string, mapiType: MapiPropertyType): ExtendedPropertyDefinition
new ExtendedPropertyDefinition(propertySet: DefaultExtendedPropertySet, id: number, mapiType: MapiPropertyType): ExtendedPropertyDefinition
new ExtendedPropertyDefinition(propertySetId: Guid, name: string, mapiType: MapiPropertyType): ExtendedPropertyDefinition
new ExtendedPropertyDefinition(propertySetId: Guid, id: number, mapiType: MapiPropertyType): ExtendedPropertyDefinition

Overwrites PropertyDefinitionBase.constructor
- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:76
Initializes a new instance of the ExtendedPropertyDefinition class. Initializes a new instance of the ExtendedPropertyDefinition class. Initializes a new instance of the ExtendedPropertyDefinition class. Initializes a new instance of the ExtendedPropertyDefinition class. Initializes a new instance of the ExtendedPropertyDefinition class.

internal

Initializes a new instance of the ExtendedPropertyDefinition class.

Returns ExtendedPropertyDefinition
Overwrites PropertyDefinitionBase.constructor
- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:81
Initializes a new instance of the ExtendedPropertyDefinition class. Initializes a new instance of the ExtendedPropertyDefinition class. Initializes a new instance of the ExtendedPropertyDefinition class. Initializes a new instance of the ExtendedPropertyDefinition class. Initializes a new instance of the ExtendedPropertyDefinition class.

internal

Initializes a new instance of the ExtendedPropertyDefinition class.

Parameters
- mapiType: MapiPropertyType
  
  The MAPI type of the extended property.
Returns ExtendedPropertyDefinition
Overwrites PropertyDefinitionBase.constructor
- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:87
Initializes a new instance of the ExtendedPropertyDefinition class.

Parameters
- tag: number
  
  The tag of the extended property.
- mapiType: MapiPropertyType
  
  The MAPI type of the extended property.
Returns ExtendedPropertyDefinition
Overwrites PropertyDefinitionBase.constructor
- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:94
Initializes a new instance of the ExtendedPropertyDefinition class.

Parameters
- propertySet: DefaultExtendedPropertySet
  
  The extended property set of the extended property.
- name: string
  
  The name of the extended property.
- mapiType: MapiPropertyType
  
  The MAPI type of the extended property.
Returns ExtendedPropertyDefinition
Overwrites PropertyDefinitionBase.constructor
- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:102
Initializes a new instance of the ExtendedPropertyDefinition class.

Parameters
- propertySet: DefaultExtendedPropertySet
  
  The extended property set of the extended property.
- id: number
  
  The Id of the extended property.
- mapiType: MapiPropertyType
  
  The MAPI type of the extended property.
Returns ExtendedPropertyDefinition
Overwrites PropertyDefinitionBase.constructor
- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:110
Initializes a new instance of the ExtendedPropertyDefinition class.

Parameters
- propertySetId: Guid
  
  The property set Id of the extended property.
- name: string
  
  The name of the extended property.
- mapiType: MapiPropertyType
  
  The MAPI type of the extended property.
Returns ExtendedPropertyDefinition
Overwrites PropertyDefinitionBase.constructor
- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:118
Initializes a new instance of the ExtendedPropertyDefinition class.

Parameters
- propertySetId: Guid
  
  The property set Id of the extended property.
- id: number
  
  The Id of the extended property.
- mapiType: MapiPropertyType
  
  The MAPI type of the extended property.
Returns ExtendedPropertyDefinition

Properties

Type

Type: any

Gets the property type.

Private id

id: number

Private mapiType

mapiType: MapiPropertyType

Private name

name: string

Private propertySet

propertySet: DefaultExtendedPropertySet

Private propertySetId

propertySetId: Guid

Private tag

tag: number

Static Private FieldFormat

FieldFormat: string

Static Private IdFieldName

IdFieldName: string

Static Private MapiTypeFieldName

MapiTypeFieldName: string

Static Private NameFieldName

NameFieldName: string

Static Private PropertySetFieldName

PropertySetFieldName: string

Static Private PropertySetIdFieldName

PropertySetIdFieldName: string

Static Private TagFieldName

TagFieldName: string

Accessors

Id

get Id(): number

- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:39
nullable

Gets the Id of the extended property.

Returns number

MapiType

get MapiType(): MapiPropertyType

- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:44
Gets the MAPI type of the extended property.

Returns MapiPropertyType

Name

get Name(): string

- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:49
Gets the name of the extended property.

Returns string

PropertySet

get PropertySet(): DefaultExtendedPropertySet

- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:54
nullable

Gets the property set of the extended property.

Returns DefaultExtendedPropertySet

PropertySetId

get PropertySetId(): Guid

- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:59
nullable

Gets the property set Id or the extended property.

Returns Guid

Version

get Version(): ExchangeVersion

Overwrites PropertyDefinitionBase.Version
- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:71
Gets the minimum Exchange version that supports this extended property.

value

{ExchangeVersion} The version.

Returns ExchangeVersion

Methods

Equals

Equals(obj: any): boolean

- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:162
Determines whether a given extended property definition is equal to this extended property definition.

Parameters
- obj: any
  
  The object to check for equality.
Returns boolean

True if the properties definitions define the same extended property.

FormatField

FormatField(name: string, fieldValue: string): string

- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:175
internal

Formats the field.

type

Type of field value.

Parameters
- name: string
  
  The name.
- fieldValue: string
  
  The field value.
Returns string

Formatted value.

GetHashCode

GetHashCode(): number

- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:187
Serves as a hash function for a particular type.

Returns number

A hash code for the current System.Object.

GetPrintableName

GetPrintableName(): string

Overwrites PropertyDefinitionBase.GetPrintableName
- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:194
internal

Gets the property definition's printable name.

Returns string

The property definition's printable name.

GetXmlElementName

GetXmlElementName(): string

Overwrites PropertyDefinitionBase.GetXmlElementName
- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:212
internal

Gets the name of the XML element.

Returns string

XML element name.

LoadPropertyValueFromXmlJsObject

LoadPropertyValueFromXmlJsObject(jsObject: any): void

- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:237
internal

Loads from XMLJsObject.

Parameters
- jsObject: any
  
  The json object.
Returns void

ToString

ToString(): string

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

WriteAttributesToXml

WriteAttributesToXml(writer: EwsServiceXmlWriter): void

Overwrites PropertyDefinitionBase.WriteAttributesToXml
- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:272
internal

Writes the attributes to XML.

Parameters
- writer: EwsServiceXmlWriter
  
  The writer.
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 IsEqualTo

IsEqualTo(extPropDef1: ExtendedPropertyDefinition, extPropDef2: ExtendedPropertyDefinition): boolean

- Defined in PropertyDefinitions/ExtendedPropertyDefinition.ts:221
internal

Determines whether two specified instances of ExtendedPropertyDefinition are equal.

Parameters
- extPropDef1: ExtendedPropertyDefinition
  
  First extended property definition.
- extPropDef2: ExtendedPropertyDefinition
  
  Second extended property definition.
Returns boolean

True if extended property definitions are equal.

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

Returns ExtendedPropertyDefinition

Parameters

mapiType: MapiPropertyType

Returns ExtendedPropertyDefinition

Parameters

tag: number

mapiType: MapiPropertyType

Returns ExtendedPropertyDefinition

Parameters

propertySet: DefaultExtendedPropertySet

name: string

mapiType: MapiPropertyType

Returns ExtendedPropertyDefinition

Parameters

propertySet: DefaultExtendedPropertySet

id: number

mapiType: MapiPropertyType

Returns ExtendedPropertyDefinition

Parameters

propertySetId: Guid

name: string

mapiType: MapiPropertyType

Returns ExtendedPropertyDefinition

Parameters

propertySetId: Guid

id: number

mapiType: MapiPropertyType

Returns ExtendedPropertyDefinition

Properties

Type

Private id

Private mapiType

Private name

Private propertySet

Private propertySetId

Private tag

Static Private FieldFormat

Static Private IdFieldName

Static Private MapiTypeFieldName

Static Private NameFieldName

Static Private PropertySetFieldName

Static Private PropertySetIdFieldName

Static Private TagFieldName

Accessors

Id

Returns number

MapiType

Returns MapiPropertyType

Name

Returns string

PropertySet

Returns DefaultExtendedPropertySet

PropertySetId

Returns Guid

Tag

Returns number

Version

Returns ExchangeVersion

Methods

Equals

Parameters

obj: any

Returns boolean

FormatField

Parameters

name: string

fieldValue: string

Returns string

GetHashCode

Returns number

GetPrintableName

Returns string