SearchFolderSchemaStatic | Ews JavaScript Api

Represents the schema for search folders.

Hierarchy

SearchFolderSchema
- SearchFolderSchemaStatic

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new SearchFolderSchemaStatic(): SearchFolderSchemaStatic

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

Initializes a new instance of the ServiceObjectSchema class.

Returns SearchFolderSchemaStatic

Properties

Instance

Instance: SearchFolderSchema

internal: Instance of SearchFolderSchema

SearchParameters

SearchParameters: PropertyDefinition

Defines the SearchParameters property.

Static ArchiveTag

ArchiveTag: PropertyDefinition

Defines the ArchiveTag property.

Static ChildFolderCount

ChildFolderCount: PropertyDefinition

Defines the ChildFolderCount property.

Static DisplayName

DisplayName: PropertyDefinition

Defines the DisplayName property.

Static EffectiveRights

EffectiveRights: PropertyDefinition

Defines the EffectiveRights property.

Static ExtendedProperties

ExtendedProperties: PropertyDefinition

Defines the ExtendedProperties property.

Static FolderClass

FolderClass: PropertyDefinition

Defines the FolderClass property.

Static Id

Id: PropertyDefinition

Defines the Id property.

Static Instance

Instance: SearchFolderSchema

internal: Instance of SearchFolderSchema

Static ManagedFolderInformation

ManagedFolderInformation: PropertyDefinition

Defines the ManagedFolderInformation property.

Static ParentFolderId

ParentFolderId: PropertyDefinition

Defines the ParentFolderId property.

Static Permissions

Permissions: PropertyDefinition

Defines the Permissions property.

Static PolicyTag

PolicyTag: PropertyDefinition

Defines the PolicyTag property.

Static SearchParameters

SearchParameters: PropertyDefinition

Defines the SearchParameters property.

Static TotalCount

TotalCount: PropertyDefinition

Defines the TotalCount property.

Static UnreadCount

UnreadCount: PropertyDefinition

Defines the UnreadCount property.

Static WellKnownFolderName

WellKnownFolderName: PropertyDefinition

Defines the WellKnownFolderName 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

Inherited from SearchFolderSchema.RegisterProperties

Overwrites FolderSchema.RegisterProperties
- Defined in Core/ServiceObjects/Schemas/SearchFolderSchema.ts:44
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
- 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 SearchFolderSchemaStatic

Properties

Instance

SearchParameters

Static ArchiveTag

Static ChildFolderCount

Static DisplayName

Static EffectiveRights

Static ExtendedProperties

Static FolderClass

Static Id

Static Instance

Static ManagedFolderInformation

Static ParentFolderId

Static Permissions

Static PolicyTag

Static SearchParameters

Static TotalCount

Static UnreadCount

Static WellKnownFolderName

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