Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRemoteWeb<Result>

IRemoteWeb

Type parameters

  • Result

Hierarchy

Index

Properties

Optional query

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

Queries the collection.

param

The OData information.

Type declaration

Methods

Web

batch

  • batch(resolve: (value?: Result) => void): RemoteWeb
  • batch(appendFl?: boolean): RemoteWeb
  • batch(resolve: (value?: Result) => void, appendFl?: boolean): RemoteWeb
  • 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 RemoteWeb

  • 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 RemoteWeb

  • 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 RemoteWeb

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): RemoteWeb
  • execute(resolve?: (value?: Result) => void, waitFl?: boolean): RemoteWeb
  • execute(resolve?: (value?: Result) => void, reject?: (value?: Result) => void, waitFl?: boolean): RemoteWeb
  • Method to execute the request.

    Parameters

    • waitFl: boolean

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

    Returns RemoteWeb

  • 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 RemoteWeb

  • 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 RemoteWeb

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

getFileByServerRelativePath

getFileByServerRelativeUrl

getFileByUrl

getFolderByServerRelativeUrl

getGroupById

getInfo

  • getInfo(): IRequestInfo
  • Method to get the request information.

    Returns IRequestInfo

getListById

getListByServerRelativeUrl

Generated using TypeDoc