Class FolderView

Represents the view settings in a folder search operation.

Hierarchy

PagedView
- FolderView

Index

Constructors

constructor

new FolderView(pageSize: number): FolderView
new FolderView(pageSize: number, offset: number): FolderView
new FolderView(pageSize: number, offset: number, offsetBasePoint: OffsetBasePoint): FolderView

Overwrites PagedView.constructor
- Defined in Search/FolderView.ts:24
Initializes a new instance of the FolderView class.

Parameters
- pageSize: number
  
  The maximum number of elements the search operation should return.
Returns FolderView
Overwrites PagedView.constructor
- Defined in Search/FolderView.ts:30
Initializes a new instance of the FolderView class.

Parameters
- pageSize: number
  
  The maximum number of elements the search operation should return.
- offset: number
  
  The offset of the view from the base point.
Returns FolderView
Overwrites PagedView.constructor
- Defined in Search/FolderView.ts:37
Initializes a new instance of the FolderView class.

Parameters
- pageSize: number
  
  The maximum number of elements the search operation should return.
- offset: number
  
  The offset of the view from the base point.
- offsetBasePoint: OffsetBasePoint
  
  The base point of the offset.
Returns FolderView

Properties

OffsetBasePoint

OffsetBasePoint: OffsetBasePoint

PropertySet

PropertySet: PropertySet

Private traversal

traversal: FolderTraversal

Accessors

Offset

get Offset(): number
set Offset(value: number): void

Inherited from PagedView.Offset
- Defined in Search/PagedView.ts:18
Returns number
Inherited from PagedView.Offset
- Defined in Search/PagedView.ts:19
Parameters
- value: number
Returns void

PageSize

get PageSize(): number
set PageSize(value: number): void

Inherited from PagedView.PageSize
- Defined in Search/PagedView.ts:10
Returns number
Inherited from PagedView.PageSize
- Defined in Search/PagedView.ts:11
Parameters
- value: number
Returns void

Traversal

get Traversal(): FolderTraversal
set Traversal(value: FolderTraversal): void

- Defined in Search/FolderView.ts:19
Gets or sets the search traversal mode. Defaults to FolderTraversal.Shallow.

Returns FolderTraversal
- Defined in Search/FolderView.ts:22
Gets or sets the search traversal mode. Defaults to FolderTraversal.Shallow.

Parameters
- value: FolderTraversal
Returns void

Methods

AddJsonProperties

AddJsonProperties(jsonRequest: any, service: ExchangeService): any

Inherited from ViewBase.AddJsonProperties
- Defined in Search/ViewBase.ts:12
Parameters
- jsonRequest: any
- service: ExchangeService
Returns any

GetMaxEntriesReturned

GetMaxEntriesReturned(): number

Inherited from PagedView.GetMaxEntriesReturned

Overwrites ViewBase.GetMaxEntriesReturned
- Defined in Search/PagedView.ts:39
Returns number

GetPropertySetOrDefault

GetPropertySetOrDefault(): PropertySet

Inherited from ViewBase.GetPropertySetOrDefault
- Defined in Search/ViewBase.ts:14
Returns PropertySet

GetServiceObjectType

GetServiceObjectType(): ServiceObjectType

Overwrites ViewBase.GetServiceObjectType
- Defined in Search/FolderView.ts:55
Gets the type of service object this view applies to.

Returns ServiceObjectType

A ServiceObjectType value.

GetViewJsonTypeName

GetViewJsonTypeName(): string

Inherited from ViewBase.GetViewJsonTypeName
- Defined in Search/ViewBase.ts:16
Returns string

GetViewXmlElementName

GetViewXmlElementName(): string

Overwrites ViewBase.GetViewXmlElementName
- Defined in Search/FolderView.ts:62
Gets the name of the view XML element.

Returns string

XML element name.

InternalValidate

InternalValidate(request: ServiceRequestBase): void

Inherited from PagedView.InternalValidate

Overwrites ViewBase.InternalValidate
- Defined in Search/PagedView.ts:40
Parameters
- request: ServiceRequestBase
Returns void

InternalWritePagingToJson

InternalWritePagingToJson(jsonView: any, service: ExchangeService): any

Inherited from PagedView.InternalWritePagingToJson

Overwrites ViewBase.InternalWritePagingToJson
- Defined in Search/PagedView.ts:41
Parameters
- jsonView: any
- service: ExchangeService
Returns any

InternalWriteSearchSettingsToXml

InternalWriteSearchSettingsToXml(writer: EwsServiceXmlWriter, groupBy: Grouping): void

Inherited from PagedView.InternalWriteSearchSettingsToXml

Overwrites ViewBase.InternalWriteSearchSettingsToXml
- Defined in Search/PagedView.ts:42
Parameters
- writer: EwsServiceXmlWriter
- groupBy: Grouping
Returns void

InternalWriteViewToXml

InternalWriteViewToXml(writer: EwsServiceXmlWriter): void

Inherited from PagedView.InternalWriteViewToXml

Overwrites ViewBase.InternalWriteViewToXml
- Defined in Search/PagedView.ts:47
Parameters
- writer: EwsServiceXmlWriter
Returns void

WriteAttributesToXml

WriteAttributesToXml(writer: EwsServiceXmlWriter): void

Overwrites ViewBase.WriteAttributesToXml
- Defined in Search/FolderView.ts:68
Writes the attributes to XML.

Parameters
- writer: EwsServiceXmlWriter
  
  The writer.
Returns void

WriteGroupingToJson

WriteGroupingToJson(service: ExchangeService, groupBy: Grouping): any

Inherited from PagedView.WriteGroupingToJson

Overwrites ViewBase.WriteGroupingToJson
- Defined in Search/PagedView.ts:52
Parameters
- service: ExchangeService
- groupBy: Grouping
Returns any

WriteOrderByToXml

WriteOrderByToXml(writer: EwsServiceXmlWriter): void

Inherited from PagedView.WriteOrderByToXml

Overwrites ViewBase.WriteOrderByToXml
- Defined in Search/PagedView.ts:53
Parameters
- writer: EwsServiceXmlWriter
Returns void

WritePagingToJson

WritePagingToJson(service: ExchangeService): any

Inherited from ViewBase.WritePagingToJson
- Defined in Search/ViewBase.ts:35
Parameters
- service: ExchangeService
Returns any

WriteShapeToJson

WriteShapeToJson(jsonRequest: any, service: ExchangeService): any

Inherited from ViewBase.WriteShapeToJson
- Defined in Search/ViewBase.ts:36
Parameters
- jsonRequest: any
- service: ExchangeService
Returns any

WriteToXml

WriteToXml(writer: EwsServiceXmlWriter, groupBy: Grouping): void

Inherited from ViewBase.WriteToXml
- Defined in Search/ViewBase.ts:37
Parameters
- writer: EwsServiceXmlWriter
- groupBy: Grouping
Returns void

Generated using TypeDoc