Interface FileMethods

FileMethods

Hierarchy

FileMethods
- IFile
- IFileQuery
- File
- FileOData

Index

Methods

Methods

addClientActivities

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

- Defined in lib/SP/entitytypes.d.ts:1907
Parameters
- Optional activitiesStream: any
Returns IBaseCollection<ActivityClientResponse>

approve

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

- Defined in lib/SP/entitytypes.d.ts:1908
Parameters
- Optional comment: string
Returns IBaseExecution<any>

cancelUpload

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

- Defined in lib/SP/entitytypes.d.ts:1909
Parameters
- Optional uploadId: any
Returns IBaseExecution<any>

checkAccessAndPostViewAuditEvent

checkAccessAndPostViewAuditEvent(): IBaseExecution<boolean>

- Defined in lib/SP/entitytypes.d.ts:1910
Returns IBaseExecution<boolean>

checkIn

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

- Defined in lib/SP/entitytypes.d.ts:1911
Parameters
- Optional comment: string
- Optional checkInType: number
Returns IBaseExecution<any>

checkOut

checkOut(): IBaseExecution<any>

- Defined in lib/SP/entitytypes.d.ts:1912
Returns IBaseExecution<any>

content

content(): IBaseExecution<any>

- Defined in lib/SP/entitytypes.d.ts:1945
Returns IBaseExecution<any>

continueUpload

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

- Defined in lib/SP/entitytypes.d.ts:1913
Parameters
- Optional uploadId: any
- Optional fileOffset: number
- Optional stream: any
Returns IBaseExecution<number>

copyTo

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

- Defined in lib/SP/entitytypes.d.ts:1914
Parameters
- Optional strNewUrl: string
- Optional bOverWrite: boolean
Returns IBaseExecution<any>

copyToUsingPath

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

- Defined in lib/SP/entitytypes.d.ts:1915
Parameters
- Optional DecodedUrl: string
- Optional bOverWrite: boolean
Returns IBaseExecution<any>

delete

delete(): IBaseExecution<any>

- Defined in lib/SP/entitytypes.d.ts:1916
Returns IBaseExecution<any>

deleteWithParameters

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

- Defined in lib/SP/entitytypes.d.ts:1917
Parameters
- Optional parameters: FileDeleteParameters
Returns IBaseExecution<any>

deny

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

- Defined in lib/SP/entitytypes.d.ts:1918
Parameters
- Optional comment: string
Returns IBaseExecution<any>

executeCobaltRequest

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

- Defined in lib/SP/entitytypes.d.ts:1919
Parameters
- Optional inputStream: any
Returns IBaseExecution<any>

finishUpload

finishUpload(uploadId?: any, fileOffset?: number, stream?: any): IBaseQuery<File, FileOData> & FileCollections & FileMethods

- Defined in lib/SP/entitytypes.d.ts:1920
Parameters
- Optional uploadId: any
- Optional fileOffset: number
- Optional stream: any
Returns IBaseQuery<File, FileOData> & FileCollections & FileMethods

finishUploadWithChecksum

finishUploadWithChecksum(uploadId?: any, fileOffset?: number, checksum?: string, stream?: any): IBaseQuery<File, FileOData> & FileCollections & FileMethods

- Defined in lib/SP/entitytypes.d.ts:1921
Parameters
- Optional uploadId: any
- Optional fileOffset: number
- Optional checksum: string
- Optional stream: any
Returns IBaseQuery<File, FileOData> & FileCollections & FileMethods

getFileUserValue

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

- Defined in lib/SP/entitytypes.d.ts:1922
Parameters
- Optional key: string
Returns IBaseExecution<officeFileUserValueResponse>

getImagePreviewUri

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

- Defined in lib/SP/entitytypes.d.ts:1923
Parameters
- Optional width: number
- Optional height: number
- Optional clientType: string
Returns IBaseExecution<string>

getImagePreviewUrl

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

- Defined in lib/SP/entitytypes.d.ts:1924
Parameters
- Optional width: number
- Optional height: number
- Optional clientType: string
Returns IBaseExecution<string>

getLimitedWebPartManager

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

- Defined in lib/SP/entitytypes.d.ts:1925
Parameters
- Optional scope: number
Returns IBaseQuery<LimitedWebPartManager, LimitedWebPartManagerOData> & LimitedWebPartManagerCollections & LimitedWebPartManagerMethods

getPreAuthorizedAccessUrl

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

- Defined in lib/SP/entitytypes.d.ts:1926
Parameters
- Optional expirationHours: number
Returns IBaseExecution<string>

getPreAuthorizedAccessUrl2

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

- Defined in lib/SP/entitytypes.d.ts:1927
Parameters
- Optional expirationHours: number
- Optional expirationMinuites: number
Returns IBaseExecution<string>

getUploadStatus

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

- Defined in lib/SP/entitytypes.d.ts:1928
Parameters
- Optional uploadId: any
Returns IBaseExecution<UploadStatus>

getWOPIFrameUrl

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

- Defined in lib/SP/entitytypes.d.ts:1929
Parameters
- Optional action: number
Returns IBaseExecution<string>

moveTo

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

- Defined in lib/SP/entitytypes.d.ts:1930
Parameters
- Optional newUrl: string
- Optional flags: number
Returns IBaseExecution<any>

moveToUsingPath

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

- Defined in lib/SP/entitytypes.d.ts:1931
Parameters
- Optional DecodedUrl: string
- Optional moveOperations: number
Returns IBaseExecution<any>

openBinaryStream

openBinaryStream(): IBaseExecution<any>

- Defined in lib/SP/entitytypes.d.ts:1932
Returns IBaseExecution<any>

openBinaryStreamWithOptions

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

- Defined in lib/SP/entitytypes.d.ts:1933
Parameters
- Optional openOptions: number
Returns IBaseExecution<any>

publish

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

- Defined in lib/SP/entitytypes.d.ts:1934
Parameters
- Optional comment: string
Returns IBaseExecution<any>

recycle

recycle(): IBaseExecution<any>

- Defined in lib/SP/entitytypes.d.ts:1935
Returns IBaseExecution<any>

recycleWithETag

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

- Defined in lib/SP/entitytypes.d.ts:1936
Parameters
- Optional etagMatch: string
Returns IBaseExecution<any>

recycleWithParameters

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

- Defined in lib/SP/entitytypes.d.ts:1937
Parameters
- Optional parameters: FileDeleteParameters
Returns IBaseExecution<any>

saveBinaryStream

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

- Defined in lib/SP/entitytypes.d.ts:1938
Parameters
- Optional file: any
Returns IBaseExecution<any>

setFileUserValue

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

- Defined in lib/SP/entitytypes.d.ts:1939
Parameters
- Optional key: string
- Optional value: string
Returns IBaseExecution<officeFileUserValueResponse>

startUpload

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

- Defined in lib/SP/entitytypes.d.ts:1940
Parameters
- Optional uploadId: any
- Optional stream: any
Returns IBaseExecution<number>

unPublish

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

- Defined in lib/SP/entitytypes.d.ts:1942
Parameters
- Optional comment: string
Returns IBaseExecution<any>

undoCheckOut

undoCheckOut(): IBaseExecution<any>

- Defined in lib/SP/entitytypes.d.ts:1941
Returns IBaseExecution<any>

update

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

- Defined in lib/SP/entitytypes.d.ts:1946
Parameters
- Optional properties: any
Returns IBaseExecution<any>

updateVirusInfo

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

- Defined in lib/SP/entitytypes.d.ts:1944
Parameters
- Optional virusStatus: any
- Optional virusMessage: string
- Optional etagToCheck: string
Returns IBaseExecution<any>

Generated using TypeDoc