FolderIdCollection | Ews JavaScript Api

Hierarchy

ComplexPropertyCollection<FolderId>
- FolderIdCollection

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new FolderIdCollection(): FolderIdCollection

Inherited from ComplexPropertyCollection.constructor

Overwrites ComplexProperty.constructor
- Defined in ComplexProperties/ComplexPropertyCollection.ts:73
internal

Initializes a new instance of the class.

Returns FolderIdCollection

Properties

Namespace

Namespace: XmlNamespace

OnChange

OnChange: ComplexPropertyChangedDelegate[]

____implementsInterface

____implementsInterface: string[]

____typeGenerics

____typeGenerics: string[]

____typeName

____typeName: string

Accessors

AddedItems

get AddedItems(): FolderId[]

Inherited from ComplexPropertyCollection.AddedItems
- Defined in ComplexProperties/ComplexPropertyCollection.ts:41
internal

Gets the added items.

Returns FolderId[]

The added items.

Count

get Count(): number

Inherited from ComplexPropertyCollection.Count
- Defined in ComplexProperties/ComplexPropertyCollection.ts:60
Gets the total number of properties in the collection.

Returns number

Items

get Items(): FolderId[]

Inherited from ComplexPropertyCollection.Items
- Defined in ComplexProperties/ComplexPropertyCollection.ts:34
internal

Gets the items.

Returns FolderId[]

The items.

ModifiedItems

get ModifiedItems(): FolderId[]

Inherited from ComplexPropertyCollection.ModifiedItems
- Defined in ComplexProperties/ComplexPropertyCollection.ts:48
internal

Gets the modified items.

Returns FolderId[]

The modified items

RemovedItems

get RemovedItems(): FolderId[]

Inherited from ComplexPropertyCollection.RemovedItems
- Defined in ComplexProperties/ComplexPropertyCollection.ts:55
internal

Gets the removed items.

Returns FolderId[]

The removed items.

Methods

Add

Add(folderId: FolderId): any

- Defined in ComplexProperties/FolderIdCollection.ts:5
Parameters
- folderId: FolderId
Returns any

Changed

Changed(): void

Inherited from ComplexProperty.Changed
- Defined in ComplexProperties/ComplexProperty.ts:21
Returns void

Clear

Clear(): any

- Defined in ComplexProperties/FolderIdCollection.ts:7
Returns any

ClearChangeLog

ClearChangeLog(): void

Inherited from ComplexPropertyCollection.ClearChangeLog

Overwrites ComplexProperty.ClearChangeLog
- Defined in ComplexProperties/ComplexPropertyCollection.ts:86
internal

Clears the change log.

Returns void

Contains

Contains(complexProperty: FolderId): boolean

Inherited from ComplexPropertyCollection.Contains
- Defined in ComplexProperties/ComplexPropertyCollection.ts:98
Determines whether a specific property is in the collection.

Parameters
- complexProperty: FolderId
  
  The property to locate in the collection.
Returns boolean

True if the property was found in the collection, false otherwise.

CreateComplexProperty

CreateComplexProperty(xmlElementName: string): FolderId

Overwrites ComplexPropertyCollection.CreateComplexProperty
- Defined in ComplexProperties/FolderIdCollection.ts:8
Parameters
- xmlElementName: string
Returns FolderId

CreateDefaultComplexProperty

CreateDefaultComplexProperty(): FolderId

Overwrites ComplexPropertyCollection.CreateDefaultComplexProperty
- Defined in ComplexProperties/FolderIdCollection.ts:9
Returns FolderId

CreateFromXmlJsObjectCollection

CreateFromXmlJsObjectCollection(jsObjectCollection: any, service: ExchangeService): void

Inherited from ComplexPropertyCollection.CreateFromXmlJsObjectCollection
- Defined in ComplexProperties/ComplexPropertyCollection.ts:123
internal

Loads from XMLJsObject collection to create a new collection item.

interface

IJsonCollectionDeserializer

Parameters
- jsObjectCollection: any
  
  The json collection.
- service: ExchangeService
  
  The service.
Returns void

GetCollectionItemXmlElementName

GetCollectionItemXmlElementName(complexProperty: FolderId): string

Overwrites ComplexPropertyCollection.GetCollectionItemXmlElementName
- Defined in ComplexProperties/FolderIdCollection.ts:10
Parameters
- complexProperty: FolderId
Returns string

IndexOf

IndexOf(complexProperty: FolderId): number

Inherited from ComplexPropertyCollection.IndexOf
- Defined in ComplexProperties/ComplexPropertyCollection.ts:179
Searches for a specific property and return its zero-based index within the collection.

Parameters
- complexProperty: FolderId
  
  The property to locate in the collection.
Returns number

The zero-based index of the property within the collection.

Private InternalAdd

InternalAdd(complexProperty: FolderId): void
InternalAdd(complexProperty: FolderId, loading: boolean): void

Inherited from ComplexPropertyCollection.InternalAdd
- Defined in ComplexProperties/ComplexPropertyCollection.ts:186
internal

Add complex property.

Parameters
- complexProperty: FolderId
  
  The complex property.
Returns void
Inherited from ComplexPropertyCollection.InternalAdd
- Defined in ComplexProperties/ComplexPropertyCollection.ts:193
Parameters
- complexProperty: FolderId
  
  The complex property.
- loading: boolean
  
  If true, collection is being loaded.
Returns void

InternalClear

InternalClear(): void

Inherited from ComplexPropertyCollection.InternalClear
- Defined in ComplexProperties/ComplexPropertyCollection.ts:214
internal

Clear collection.

Returns void

InternalLoadFromXmlJsObject

InternalLoadFromXmlJsObject(jsObject: any, service: ExchangeService, readAction: function): void

Inherited from ComplexProperty.InternalLoadFromXmlJsObject
- Defined in ComplexProperties/ComplexProperty.ts:32
Parameters
- jsObject: any
- service: ExchangeService
- readAction: function
  - - (jsonProperty: any, service: ExchangeService): void
    - Parameters
      - jsonProperty: any
      - service: ExchangeService
      Returns void
Returns void

InternalRemove

InternalRemove(complexProperty: FolderId): boolean

Inherited from ComplexPropertyCollection.InternalRemove
- Defined in ComplexProperties/ComplexPropertyCollection.ts:226
internal

Remove specified complex property.

Parameters
- complexProperty: FolderId
  
  The complex property.
Returns boolean

True if the complex property was successfully removed from the collection, false otherwise.

InternalRemoveAt

InternalRemoveAt(index: number): void

Inherited from ComplexPropertyCollection.InternalRemoveAt
- Defined in ComplexProperties/ComplexPropertyCollection.ts:256
internal

Remote entry at index.

Parameters
- index: number
  
  The index.
Returns void

InternalToJson

InternalToJson(service: ExchangeService): any

Inherited from ComplexPropertyCollection.InternalToJson
- Defined in ComplexProperties/ComplexPropertyCollection.ts:264
Parameters
- service: ExchangeService
Returns any

InternalValidate

InternalValidate(): void

Inherited from ComplexProperty.InternalValidate
- Defined in ComplexProperties/ComplexProperty.ts:60
Returns void

ItemChanged

ItemChanged(complexProperty: ComplexProperty): void

Inherited from ComplexPropertyCollection.ItemChanged
- Defined in ComplexProperties/ComplexPropertyCollection.ts:271
internal

Item changed.

Parameters
- complexProperty: ComplexProperty
  
  The complex property.
Returns void

LoadFromXmlJsObject

LoadFromXmlJsObject(jsObject: any, service: ExchangeService): void

Inherited from ComplexPropertyCollection.LoadFromXmlJsObject

Overwrites ComplexProperty.LoadFromXmlJsObject
- Defined in ComplexProperties/ComplexPropertyCollection.ts:286
Parameters
- jsObject: any
- service: ExchangeService
Returns void

ReadAttributesFromXmlJsObject

ReadAttributesFromXmlJsObject(reader: EwsServiceXmlReader): void

Inherited from ComplexProperty.ReadAttributesFromXmlJsObject
- Defined in ComplexProperties/ComplexProperty.ts:71
Parameters
- reader: EwsServiceXmlReader
Returns void

ReadElementsFromXmlJsObject

ReadElementsFromXmlJsObject(jsonProperty: any, service: ExchangeService): void

Inherited from ComplexProperty.ReadElementsFromXmlJsObject
- Defined in ComplexProperties/ComplexProperty.ts:96
Parameters
- jsonProperty: any
- service: ExchangeService
Returns void

ReadElementsFromXmlJsObjectToPatch

ReadElementsFromXmlJsObjectToPatch(jsonProperty: any, service: ExchangeService): void

Inherited from ComplexProperty.ReadElementsFromXmlJsObjectToPatch
- Defined in ComplexProperties/ComplexProperty.ts:97
Parameters
- jsonProperty: any
- service: ExchangeService
Returns void

ReadTextValueFromXmlJsObject

ReadTextValueFromXmlJsObject(jsObject: EwsServiceXmlReader): void

Inherited from ComplexProperty.ReadTextValueFromXmlJsObject
- Defined in ComplexProperties/ComplexProperty.ts:72
Parameters
- jsObject: EwsServiceXmlReader
Returns void

Remove

Remove(folderId: FolderId): boolean

- Defined in ComplexProperties/FolderIdCollection.ts:11
Parameters
- folderId: FolderId
Returns boolean

RemoveAt

RemoveAt(index: number): any

- Defined in ComplexProperties/FolderIdCollection.ts:13
Parameters
- index: number
Returns any

RemoveFromChangeLog

RemoveFromChangeLog(complexProperty: FolderId): void

Inherited from ComplexPropertyCollection.RemoveFromChangeLog
- Defined in ComplexProperties/ComplexPropertyCollection.ts:294
internal

Removes from change log.

Parameters
- complexProperty: FolderId
  
  The complex property.
Returns void

SetFieldValue

SetFieldValue<T>(field: IRefParam<T>, value: T): void

Inherited from ComplexProperty.SetFieldValue
- Defined in ComplexProperties/ComplexProperty.ts:73
Type parameters
- T
Parameters
- field: IRefParam<T>
- value: T
Returns void

ShouldWriteToRequest

ShouldWriteToRequest(): boolean

Inherited from ComplexPropertyCollection.ShouldWriteToRequest
- Defined in ComplexProperties/ComplexPropertyCollection.ts:305
internal

Determine whether we should write collection to XML or not.

Returns boolean

True if collection contains at least one element.

UpdateFromXmlJsObject

UpdateFromXmlJsObject(jsObject: any, service: ExchangeService): void

Inherited from ComplexProperty.UpdateFromXmlJsObject
- Defined in ComplexProperties/ComplexProperty.ts:99
Parameters
- jsObject: any
- service: ExchangeService
Returns void

UpdateFromXmlJsObjectCollection

UpdateFromXmlJsObjectCollection(jsObjectCollection: any, service: ExchangeService): void

Inherited from ComplexPropertyCollection.UpdateFromXmlJsObjectCollection
- Defined in ComplexProperties/ComplexPropertyCollection.ts:318
internal

Loads from XMLJsObject collection to update collection Items.

interface

IJsonCollectionDeserializer

Parameters
- jsObjectCollection: any
  
  The XMLJsObject collection.
- service: ExchangeService
  
  The service.
Returns void

Validate

Validate(): void

Inherited from ComplexProperty.Validate
- Defined in ComplexProperties/ComplexProperty.ts:111
Returns void

WriteAttributesToXml

WriteAttributesToXml(writer: EwsServiceXmlWriter): void

Inherited from ComplexProperty.WriteAttributesToXml
- Defined in ComplexProperties/ComplexProperty.ts:115
Parameters
- writer: EwsServiceXmlWriter
Returns void

WriteDeleteUpdateToXml

WriteDeleteUpdateToXml(writer: EwsServiceXmlWriter, ewsObject: ServiceObject): boolean

Inherited from ComplexPropertyCollection.WriteDeleteUpdateToXml
- Defined in ComplexProperties/ComplexPropertyCollection.ts:428
internal

Writes the deletion update to XML.

Parameters
- writer: EwsServiceXmlWriter
  
  The writer.
- ewsObject: ServiceObject
  
  The ews object.
Returns boolean

True if property generated serialization.

WriteElementsToXml

WriteElementsToXml(writer: EwsServiceXmlWriter): void

Inherited from ComplexPropertyCollection.WriteElementsToXml

Overwrites ComplexProperty.WriteElementsToXml
- Defined in ComplexProperties/ComplexPropertyCollection.ts:371
internal

Writes elements to XML.

Parameters
- writer: EwsServiceXmlWriter
  
  The writer.
Returns void

WriteSetUpdateToXml

WriteSetUpdateToXml(writer: EwsServiceXmlWriter, ewsObject: ServiceObject, propertyDefinition: PropertyDefinition): boolean

Inherited from ComplexPropertyCollection.WriteSetUpdateToXml
- Defined in ComplexProperties/ComplexPropertyCollection.ts:404
internal

Writes the update to XML.

Parameters
- writer: EwsServiceXmlWriter
  
  The writer.
- ewsObject: ServiceObject
  
  The ews object.
- propertyDefinition: PropertyDefinition
  
  Property definition.
Returns boolean

True if property generated serialization.

WriteToXml

WriteToXml(writer: EwsServiceXmlWriter, xmlElementName: string, xmlNamespace?: XmlNamespace): void

Inherited from ComplexPropertyCollection.WriteToXml

Overwrites ComplexProperty.WriteToXml
- Defined in ComplexProperties/ComplexPropertyCollection.ts:384
internal

Writes to XML.

Parameters
- writer: EwsServiceXmlWriter
  
  The writer.
- xmlElementName: string
  
  Name of the XML element.
- Default value xmlNamespace: XmlNamespace = XmlNamespace.Types
  
  The XML namespace.
Returns void

___thisIndexer

___thisIndexer(index: number): FolderId

Inherited from ComplexPropertyCollection.___thisIndexer
- Defined in ComplexProperties/ComplexPropertyCollection.ts:68
Gets the property at the specified index.

Parameters
- index: number
  
  The zero-based index of the property to get.
Returns FolderId

The property at the specified index.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns FolderIdCollection

Properties

Namespace

OnChange

____implementsInterface

____typeGenerics

____typeName

Accessors

AddedItems

Returns FolderId[]

Count

Returns number

Items

Returns FolderId[]

ModifiedItems

Returns FolderId[]

RemovedItems

Returns FolderId[]

Methods

Add

Parameters

folderId: FolderId

Returns any

Changed

Returns void

Clear

Returns any

ClearChangeLog

Returns void

Contains

Parameters

complexProperty: FolderId

Returns boolean

CreateComplexProperty

Parameters

xmlElementName: string

Returns FolderId

CreateDefaultComplexProperty

Returns FolderId

CreateFromXmlJsObjectCollection

Parameters

jsObjectCollection: any

service: ExchangeService

Returns void

GetCollectionItemXmlElementName

Parameters

complexProperty: FolderId

Returns string

IndexOf

Parameters

complexProperty: FolderId

Returns number

Private InternalAdd

Parameters

complexProperty: FolderId

Returns void

Parameters

complexProperty: FolderId

loading: boolean

Returns void

InternalClear

Returns void

InternalLoadFromXmlJsObject

Parameters

jsObject: any

service: ExchangeService

readAction: function

Parameters

jsonProperty: any

service: ExchangeService

Returns void

Returns void