Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IFolder<Result>

IFolder

Type parameters

  • Result

Hierarchy

Index

Properties

Methods

Properties

Optional query

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

Queries the collection.

param

The OData information.

Type declaration

Methods

Files

Folders

ListItemAllFields

ParentFolder

Properties

StorageMetrics

addSubFolder

  • addSubFolder(leafName?: string): IBaseExecution<any>

  • Parameters

    • Optional leafName: string

    Returns IBaseExecution<any>

addSubFolderUsingPath

  • addSubFolderUsingPath(DecodedUrl?: string): IBaseExecution<any>

  • Parameters

    • Optional DecodedUrl: string

    Returns IBaseExecution<any>

batch

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

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

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

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

delete

  • delete(): IBaseExecution<any>

  • Returns IBaseExecution<any>

deleteWithParameters

  • deleteWithParameters(parameters?: FolderDeleteParameters): IBaseExecution<any>

  • Parameters

    • Optional parameters: FolderDeleteParameters

    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): Folder
  • execute(resolve?: (value?: Result) => void, waitFl?: boolean): Folder
  • execute(resolve?: (value?: Result) => void, reject?: (value?: Result) => void, waitFl?: boolean): Folder

  • Method to execute the request.

    Parameters

    • waitFl: boolean

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

    Returns Folder

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

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

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

getChanges

  • getChanges(query?: ChangeQuery): IBaseCollection<Change>

  • Parameters

    • Optional query: ChangeQuery

    Returns IBaseCollection<Change>

getInfo

  • getInfo(): IRequestInfo

  • Method to get the request information.

    Returns IRequestInfo

getListItemChanges

  • getListItemChanges(query?: ChangeQuery): IBaseCollection<Change>

moveTo

  • moveTo(newUrl?: string): IBaseExecution<any>

  • Parameters

    • Optional newUrl: string

    Returns IBaseExecution<any>

moveToUsingPath

  • moveToUsingPath(DecodedUrl?: string): IBaseExecution<any>

  • Parameters

    • Optional DecodedUrl: string

    Returns IBaseExecution<any>

recycle

  • recycle(): IBaseExecution<any>

  • Returns IBaseExecution<any>

recycleWithParameters

  • recycleWithParameters(parameters?: FolderDeleteParameters): IBaseExecution<any>

  • Parameters

    • Optional parameters: FolderDeleteParameters

    Returns IBaseExecution<any>

update

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

  • Parameters

    • Optional properties: any

    Returns IBaseExecution<any>

Generated using TypeDoc