Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IFile<Result>

IFile

Type parameters

  • Result

Hierarchy

Index

Properties

Methods

Properties

Optional query

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

Queries the collection.

param

The OData information.

Type declaration

    • (query: IODataQuery): IBaseExecution<IFileQuery>

    • Parameters

      • query: IODataQuery

      Returns IBaseExecution<IFileQuery>

Methods

Author

CheckedOutByUser

EffectiveInformationRightsManagementSettings

InformationRightsManagementSettings

ListItemAllFields

LockedByUser

ModifiedBy

Properties

VersionEvents

Versions

addClientActivities

  • addClientActivities(activitiesStream?: any): IBaseCollection<ActivityClientResponse>

  • Parameters

    • Optional activitiesStream: any

    Returns IBaseCollection<ActivityClientResponse>

approve

  • approve(comment?: string): IBaseExecution<any>

  • Parameters

    • Optional comment: string

    Returns IBaseExecution<any>

batch

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

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

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

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

cancelUpload

  • cancelUpload(uploadId?: any): IBaseExecution<any>

  • Parameters

    • Optional uploadId: any

    Returns IBaseExecution<any>

checkAccessAndPostViewAuditEvent

  • checkAccessAndPostViewAuditEvent(): IBaseExecution<boolean>

checkIn

  • checkIn(comment?: string, checkInType?: number): IBaseExecution<any>

  • Parameters

    • Optional comment: string
    • Optional checkInType: number

    Returns IBaseExecution<any>

checkOut

  • checkOut(): IBaseExecution<any>

  • Returns IBaseExecution<any>

content

  • content(): IBaseExecution<any>

  • Returns IBaseExecution<any>

continueUpload

  • continueUpload(uploadId?: any, fileOffset?: number, stream?: any): IBaseExecution<number>

  • Parameters

    • Optional uploadId: any
    • Optional fileOffset: number
    • Optional stream: any

    Returns IBaseExecution<number>

copyTo

  • copyTo(strNewUrl?: string, bOverWrite?: boolean): IBaseExecution<any>

  • Parameters

    • Optional strNewUrl: string
    • Optional bOverWrite: boolean

    Returns IBaseExecution<any>

copyToUsingPath

  • copyToUsingPath(DecodedUrl?: string, bOverWrite?: boolean): IBaseExecution<any>

  • Parameters

    • Optional DecodedUrl: string
    • Optional bOverWrite: boolean

    Returns IBaseExecution<any>

delete

  • delete(): IBaseExecution<any>

  • Returns IBaseExecution<any>

deleteWithParameters

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

  • Parameters

    • Optional parameters: FileDeleteParameters

    Returns IBaseExecution<any>

deny

  • deny(comment?: string): IBaseExecution<any>

  • Parameters

    • Optional comment: string

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

  • Method to execute the request.

    Parameters

    • waitFl: boolean

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

    Returns File

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

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

executeAndWait

  • executeAndWait(): Result

  • Method to execute the request synchronously.

    Returns Result

executeCobaltRequest

  • executeCobaltRequest(inputStream?: any): IBaseExecution<any>

  • Parameters

    • Optional inputStream: any

    Returns IBaseExecution<any>

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

finishUpload

finishUploadWithChecksum

getFileUserValue

  • getFileUserValue(key?: string): IBaseExecution<officeFileUserValueResponse>

  • Parameters

    • Optional key: string

    Returns IBaseExecution<officeFileUserValueResponse>

getImagePreviewUri

  • getImagePreviewUri(width?: number, height?: number, clientType?: string): IBaseExecution<string>

  • Parameters

    • Optional width: number
    • Optional height: number
    • Optional clientType: string

    Returns IBaseExecution<string>

getImagePreviewUrl

  • getImagePreviewUrl(width?: number, height?: number, clientType?: string): IBaseExecution<string>

  • Parameters

    • Optional width: number
    • Optional height: number
    • Optional clientType: string

    Returns IBaseExecution<string>

getInfo

  • getInfo(): IRequestInfo

  • Method to get the request information.

    Returns IRequestInfo

getLimitedWebPartManager

  • getLimitedWebPartManager(scope?: number): IBaseQuery<LimitedWebPartManager, LimitedWebPartManagerOData> & LimitedWebPartManagerCollections & LimitedWebPartManagerMethods

  • Parameters

    • Optional scope: number

    Returns IBaseQuery<LimitedWebPartManager, LimitedWebPartManagerOData> & LimitedWebPartManagerCollections & LimitedWebPartManagerMethods

getPreAuthorizedAccessUrl

  • getPreAuthorizedAccessUrl(expirationHours?: number): IBaseExecution<string>

  • Parameters

    • Optional expirationHours: number

    Returns IBaseExecution<string>

getPreAuthorizedAccessUrl2

  • getPreAuthorizedAccessUrl2(expirationHours?: number, expirationMinuites?: number): IBaseExecution<string>

  • Parameters

    • Optional expirationHours: number
    • Optional expirationMinuites: number

    Returns IBaseExecution<string>

getUploadStatus

  • getUploadStatus(uploadId?: any): IBaseExecution<UploadStatus>

  • Parameters

    • Optional uploadId: any

    Returns IBaseExecution<UploadStatus>

getWOPIFrameUrl

  • getWOPIFrameUrl(action?: number): IBaseExecution<string>

  • Parameters

    • Optional action: number

    Returns IBaseExecution<string>

moveTo

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

  • Parameters

    • Optional newUrl: string
    • Optional flags: number

    Returns IBaseExecution<any>

moveToUsingPath

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

  • Parameters

    • Optional DecodedUrl: string
    • Optional moveOperations: number

    Returns IBaseExecution<any>

openBinaryStream

  • openBinaryStream(): IBaseExecution<any>

  • Returns IBaseExecution<any>

openBinaryStreamWithOptions

  • openBinaryStreamWithOptions(openOptions?: number): IBaseExecution<any>

publish

  • publish(comment?: string): IBaseExecution<any>

  • Parameters

    • Optional comment: string

    Returns IBaseExecution<any>

recycle

  • recycle(): IBaseExecution<any>

  • Returns IBaseExecution<any>

recycleWithETag

  • recycleWithETag(etagMatch?: string): IBaseExecution<any>

  • Parameters

    • Optional etagMatch: string

    Returns IBaseExecution<any>

recycleWithParameters

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

  • Parameters

    • Optional parameters: FileDeleteParameters

    Returns IBaseExecution<any>

saveBinaryStream

  • saveBinaryStream(file?: any): IBaseExecution<any>

  • Parameters

    • Optional file: any

    Returns IBaseExecution<any>

setFileUserValue

  • setFileUserValue(key?: string, value?: string): IBaseExecution<officeFileUserValueResponse>

  • Parameters

    • Optional key: string
    • Optional value: string

    Returns IBaseExecution<officeFileUserValueResponse>

startUpload

  • startUpload(uploadId?: any, stream?: any): IBaseExecution<number>

  • Parameters

    • Optional uploadId: any
    • Optional stream: any

    Returns IBaseExecution<number>

unPublish

  • unPublish(comment?: string): IBaseExecution<any>

  • Parameters

    • Optional comment: string

    Returns IBaseExecution<any>

undoCheckOut

  • undoCheckOut(): IBaseExecution<any>

  • Returns IBaseExecution<any>

update

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

  • Parameters

    • Optional properties: any

    Returns IBaseExecution<any>

updateVirusInfo

  • updateVirusInfo(virusStatus?: any, virusMessage?: string, etagToCheck?: string): IBaseExecution<any>

  • Parameters

    • Optional virusStatus: any
    • Optional virusMessage: string
    • Optional etagToCheck: string

    Returns IBaseExecution<any>

Generated using TypeDoc