ResponseObjectSchema | Ews JavaScript Api

Represents ResponseObject schema definition. Represents ResponseObject schema definition.

Hierarchy

ServiceObjectSchema
- ResponseObjectSchema
  - ResponseObjectSchemaStatic

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ResponseObjectSchema(): ResponseObjectSchema

Inherited from ServiceObjectSchema.constructor
- Defined in Core/ServiceObjects/Schemas/ServiceObjectSchema.ts:169
internal

Initializes a new instance of the ServiceObjectSchema class.

Returns ResponseObjectSchema

Properties

Static BodyPrefix

BodyPrefix: PropertyDefinition

Defines the BodyPrefix property. Defines the BodyPrefix property.

Static ExtendedProperties

ExtendedProperties: PropertyDefinition

Defines the ExtendedProperties property.

Static Instance

Instance: ResponseObjectSchema

internal: Instance of ResponseObjectSchema
internal: Instance of ResponseObjectSchema

Static ReferenceItemId

ReferenceItemId: PropertyDefinition

Defines the ReferenceItemId property. Defines the ReferenceItemId property.

Accessors

FirstClassProperties

get FirstClassProperties(): PropertyDefinition[]

Inherited from ServiceObjectSchema.FirstClassProperties
- Defined in Core/ServiceObjects/Schemas/ServiceObjectSchema.ts:35
internal

Gets the list of first class properties for this service object type.

Returns PropertyDefinition[]

FirstClassSummaryProperties

get FirstClassSummaryProperties(): PropertyDefinition[]

Inherited from ServiceObjectSchema.FirstClassSummaryProperties
- Defined in Core/ServiceObjects/Schemas/ServiceObjectSchema.ts:40
internal

Gets the list of first class summary properties for this service object type.

Returns PropertyDefinition[]

IndexedProperties

get IndexedProperties(): IndexedPropertyDefinition[]

Inherited from ServiceObjectSchema.IndexedProperties
- Defined in Core/ServiceObjects/Schemas/ServiceObjectSchema.ts:45
internal

Gets the list of indexed properties for this service object type.

Returns IndexedPropertyDefinition[]

Methods

GetEnumerator

GetEnumerator(): PropertyDefinition[]

Inherited from ServiceObjectSchema.GetEnumerator
- Defined in Core/ServiceObjects/Schemas/ServiceObjectSchema.ts:209
Returns PropertyDefinition[]

RegisterIndexedProperty

RegisterIndexedProperty(indexedProperty: IndexedPropertyDefinition): void

Inherited from ServiceObjectSchema.RegisterIndexedProperty
- Defined in Core/ServiceObjects/Schemas/ServiceObjectSchema.ts:218
internal

Registers an indexed property.

Parameters
- indexedProperty: IndexedPropertyDefinition
  
  The indexed property to register.
Returns void

RegisterInternalProperty

RegisterInternalProperty(registeringSchemaClass: any, property: PropertyDefinition): void

Inherited from ServiceObjectSchema.RegisterInternalProperty
- Defined in Core/ServiceObjects/Schemas/ServiceObjectSchema.ts:226
internal

Registers an internal schema property.

Parameters
- registeringSchemaClass: any
  
  SchemaClass calling this method - workaround for fieldUri registration oterhwise it registers super/parent class static properties as well. TypeScript does not provide a way to detect inherited property, hasOwnProperty returns true for parent static property
- property: PropertyDefinition
  
  The property to register.
Returns void

RegisterProperties

RegisterProperties(): void

Overwrites ServiceObjectSchema.RegisterProperties
- Defined in Core/ServiceObjects/Schemas/ResponseObjectSchema.ts:48
Registers properties.

remarks

IMPORTANT NOTE: PROPERTIES MUST BE REGISTERED IN SCHEMA ORDER (i.e. the same order as they are defined in types.xsd)

Returns void

Private RegisterProperty

RegisterProperty(registeringSchemaClass: any, property: PropertyDefinition): void
RegisterProperty(registeringSchemaClass: any, property: PropertyDefinition, isInternal: boolean): void

Inherited from ServiceObjectSchema.RegisterProperty
- Defined in Core/ServiceObjects/Schemas/ServiceObjectSchema.ts:241
internal

Registers a schema property. - workaround for fieldUri registration oterhwise it registers super/parent class static properties as well. TypeScript does not provide a way to detect inherited property, hasOwnProperty returns true

Parameters
- registeringSchemaClass: any
  
  SchemaClass calling this method - workaround for fieldUri registration oterhwise it registers super/parent class static properties as well. TypeScript does not provide a way to detect inherited property, hasOwnProperty returns true for parent static property
- property: PropertyDefinition
  
  The property to register.
Returns void
Inherited from ServiceObjectSchema.RegisterProperty
- Defined in Core/ServiceObjects/Schemas/ServiceObjectSchema.ts:249
Parameters
- registeringSchemaClass: any
  
  SchemaClass calling this method - workaround for fieldUri registration oterhwise it registers super/parent class static properties as well. TypeScript does not provide a way to detect inherited property, hasOwnProperty returns true for parent static property
- property: PropertyDefinition
  
  The property to register.
- isInternal: boolean
  
  Indicates whether the property is internal or should be visible to developers.
Returns void

TryGetPropertyDefinition

TryGetPropertyDefinition(xmlElementName: string, propertyDefinition: IOutParam<PropertyDefinition>): boolean

Inherited from ServiceObjectSchema.TryGetPropertyDefinition
- Defined in Core/ServiceObjects/Schemas/ServiceObjectSchema.ts:286
internal

Tries to get property definition.

Parameters
- xmlElementName: string
  
  Name of the XML element.
- propertyDefinition: IOutParam<PropertyDefinition>
  
  The property definition.
Returns boolean

True if property definition exists.

Protected init

init(): void

Inherited from ServiceObjectSchema.init
- Defined in Core/ServiceObjects/Schemas/ServiceObjectSchema.ts:211
Returns void

Static FindPropertyDefinition

FindPropertyDefinition(uri: string): PropertyDefinitionBase

Inherited from ServiceObjectSchema.FindPropertyDefinition

Overwrites ServiceObjectSchema.FindPropertyDefinition
- Defined in Core/ServiceObjects/Schemas/ServiceObjectSchema.ts:167
internal

Finds the property definition.

Parameters
- uri: string
  
  The URI.
Returns PropertyDefinitionBase

Property definition.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ResponseObjectSchema

Properties

Static BodyPrefix

Static ExtendedProperties

Static Instance

Static ReferenceItemId

Accessors

FirstClassProperties

Returns PropertyDefinition[]

FirstClassSummaryProperties

Returns PropertyDefinition[]

IndexedProperties

Returns IndexedPropertyDefinition[]

Methods

GetEnumerator

Returns PropertyDefinition[]

RegisterIndexedProperty

Parameters

indexedProperty: IndexedPropertyDefinition

Returns void

RegisterInternalProperty

Parameters

registeringSchemaClass: any

property: PropertyDefinition

Returns void

RegisterProperties

Returns void

Private RegisterProperty

Parameters

registeringSchemaClass: any

property: PropertyDefinition

Returns void

Parameters

registeringSchemaClass: any

property: PropertyDefinition

isInternal: boolean

Returns void

TryGetPropertyDefinition

Parameters

xmlElementName: string

propertyDefinition: IOutParam<PropertyDefinition>

Returns boolean

Protected init

Returns void

Static FindPropertyDefinition

Parameters

uri: string

Returns PropertyDefinitionBase