Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FolderView

Represents the view settings in a folder search operation.

Hierarchy

Index

Constructors

constructor

  • Initializes a new instance of the FolderView class.

    Parameters

    • pageSize: number

      The maximum number of elements the search operation should return.

    Returns FolderView

  • 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

  • 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
  • Returns number

  • Parameters

    • value: number

    Returns void

PageSize

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

  • Parameters

    • value: number

    Returns void

Traversal

  • Gets or sets the search traversal mode. Defaults to FolderTraversal.Shallow.

    Returns FolderTraversal

  • Gets or sets the search traversal mode. Defaults to FolderTraversal.Shallow.

    Parameters

    Returns void

Methods

AddJsonProperties

GetMaxEntriesReturned

  • GetMaxEntriesReturned(): number

GetPropertySetOrDefault

GetServiceObjectType

GetViewJsonTypeName

  • GetViewJsonTypeName(): string

GetViewXmlElementName

  • GetViewXmlElementName(): string
  • Gets the name of the view XML element.

    Returns string

    XML element name.

InternalValidate

InternalWritePagingToJson

InternalWriteSearchSettingsToXml

InternalWriteViewToXml

WriteAttributesToXml

WriteGroupingToJson

WriteOrderByToXml

WritePagingToJson

WriteShapeToJson

WriteToXml

Generated using TypeDoc