Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IView<Result>

IView

Type parameters

  • Result

Hierarchy

Index

Properties

Methods

Properties

Optional query

query: (query: IODataQuery) => IBaseExecution<IViewQuery>

Queries the collection.

param

The OData information.

Type declaration

    • (query: IODataQuery): IBaseExecution<IViewQuery>

    • Parameters

      • query: IODataQuery

      Returns IBaseExecution<IViewQuery>

Methods

ViewFields

addToSpotlight

  • addToSpotlight(itemId?: number, folderPath?: string, afterItemId?: number): IBaseExecution<SpotlightResult>

  • Parameters

    • Optional itemId: number
    • Optional folderPath: string
    • Optional afterItemId: number

    Returns IBaseExecution<SpotlightResult>

batch

  • batch(resolve: (value?: Result) => void): View
  • batch(appendFl?: boolean): View
  • batch(resolve: (value?: Result) => void, appendFl?: boolean): View

  • Method to execute the request as a batch. Currently available in SharePoint Online only.

    Parameters

    • resolve: (value?: Result) => void

      The method to be executed after the request completes.

        • (value?: Result): void

        • Parameters

          • Optional value: Result

          Returns void

    Returns View

  • Method to execute the request as a batch. Currently available in SharePoint Online only.

    Parameters

    • Optional appendFl: boolean

      Flag to execute the request as part of a change set.

    Returns View

  • Method to execute the request as a batch. Currently available in SharePoint Online only.

    Parameters

    • resolve: (value?: Result) => void

      The method to be executed after the request completes.

        • (value?: Result): void

        • Parameters

          • Optional value: Result

          Returns void

    • Optional appendFl: boolean

      Flag to execute the request as part of a change set.

    Returns View

delete

  • delete(): IBaseExecution<any>

  • Returns IBaseExecution<any>

done

  • done<T>(resolve: (value?: T) => void): any

  • Method to wait for the requests to complete.

    Type parameters

    • T

    Parameters

    • resolve: (value?: T) => void

      The method to be executed after the request completes.

        • (value?: T): void

        • Parameters

          • Optional value: T

          Returns void

    Returns any

execute

  • execute(waitFl: boolean): View
  • execute(resolve?: (value?: Result) => void, waitFl?: boolean): View
  • execute(resolve?: (value?: Result) => void, reject?: (value?: Result) => void, waitFl?: boolean): View

  • Method to execute the request.

    Parameters

    • waitFl: boolean

      Flag to execute the request, after the previous requests have completed.

    Returns View

  • Method to execute the request.

    Parameters

    • Optional resolve: (value?: Result) => void

      The method to be executed if the request is successful.

        • (value?: Result): void

        • Parameters

          • Optional value: Result

          Returns void

    • Optional waitFl: boolean

      Flag to execute the request, after the previous requests have completed.

    Returns View

  • Method to execute the request.

    Parameters

    • Optional resolve: (value?: Result) => void

      The method to be executed if the request is successful.

        • (value?: Result): void

        • Parameters

          • Optional value: Result

          Returns void

    • Optional reject: (value?: Result) => void

      The method to be executed if the request fails.

        • (value?: Result): void

        • Parameters

          • Optional value: Result

          Returns void

    • Optional waitFl: boolean

      Flag to execute the request, after the previous requests have completed.

    Returns View

executeAndWait

  • executeAndWait(): Result

  • Method to execute the request synchronously.

    Returns Result

executeMethod

  • executeMethod(methodName: string, methodConfig: IMethodInfo, args?: any): any

  • Method to execute the request. (This is an internal method, but can be used for dev purposes.)

    Parameters

    • methodName: string

      The method name to execute.

    • methodConfig: IMethodInfo

      The configuration to pass with the request.

    • Optional args: any

      The optional arguments for the request.

    Returns any

getInfo

  • getInfo(): IRequestInfo

  • Method to get the request information.

    Returns IRequestInfo

removeFromSpotlight

  • removeFromSpotlight(itemId?: number, folderPath?: string): IBaseExecution<SpotlightResult>

  • Parameters

    • Optional itemId: number
    • Optional folderPath: string

    Returns IBaseExecution<SpotlightResult>

renderAsHtml

  • renderAsHtml(): IBaseExecution<string>

  • Returns IBaseExecution<string>

setViewXml

  • setViewXml(viewXml?: string): IBaseExecution<any>

  • Parameters

    • Optional viewXml: string

    Returns IBaseExecution<any>

update

  • update(properties?: any): IBaseExecution<any>

  • Parameters

    • Optional properties: any

    Returns IBaseExecution<any>

Generated using TypeDoc