Class TransferFilePool

Index

Constructors

Methods

abortFileDownload addFile clearFile deleteFile downloadFile fileExists getBlob getFile readFilePart receiveFilePart storeFileMetadata

Constructors

constructor

new TransferFilePool(options?): TransferFilePool
Parameters
- Optionaloptions: TransferFilePoolOptions
Returns TransferFilePool
- Defined in src/TransferFilePool.ts:41

Methods

abortFileDownload

abortFileDownload(fileId): void
Abort the download of a file.
Parameters
- fileId: string
  Id of the file.
Returns void
- Defined in src/TransferFilePool.ts:157

addFile

addFile(blob, name): Promise<TransferFileMetadata>
Add a file directly to the pool.
Parameters
- blob: Blob
  Blob to store to the pool.
- name: string
  Name of the file.
Returns Promise<TransferFileMetadata>
The metadata of the file.
- Defined in src/TransferFilePool.ts:173

clearFile

clearFile(fileId): void
Remove all the data of the file.
Parameters
- fileId: string
  Id of the file.
Returns void
- Defined in src/TransferFilePool.ts:272

deleteFile

deleteFile(fileId): void
Delete a file from the pool.
Parameters
- fileId: string
  Id of the file.
Returns void
- Defined in src/TransferFilePool.ts:116

downloadFile

downloadFile(fileId, askFilePartCallback?, parallelCalls?): Promise<void>
Trigger the download of a file.
Parameters
- fileId: string
  Id of the file.
- OptionalaskFilePartCallback: AskFilePartCallback
  Callback function to ask a specific part of a file.
- OptionalparallelCalls: number
  Number of parallel calls to perform.
Returns Promise<void>
- Defined in src/TransferFilePool.ts:134

fileExists

fileExists(fileId): boolean
Check existance of a file in the pool.
Parameters
- fileId: string
  Id of the file.
Returns boolean
true if the file exists.
- Defined in src/TransferFilePool.ts:74

getBlob

getBlob(fileId): Blob
Get the Blob of a specific complete file.
Parameters
- fileId: string
  Id of the file.
Returns Blob
The Blob of the complete file.
- Defined in src/TransferFilePool.ts:259

getFile

getFile(fileId): TransferFileBlob
Get informations representing a specific file.
Parameters
- fileId: string
  Id of the file.
Returns TransferFileBlob
Informations representing the requested file.
- Defined in src/TransferFilePool.ts:245

readFilePart

readFilePart(fileId, offset, limit): ArrayBuffer
Read a specific part of a file.
Parameters
- fileId: string
  Id of the file.
- offset: number
  From where to read.
- limit: number
  Maximum lenght of data we want to read.
Returns ArrayBuffer
ArrayBuffer containing the requested part of the file.
- Defined in src/TransferFilePool.ts:206

receiveFilePart

receiveFilePart(fileId, offset, limit, data): void
Receive a specific part of a file.
Parameters
- fileId: string
  Id of the file.
- offset: number
  From where it was read.
- limit: number
  Maximum length of read data.
- data: ArrayBuffer
  ArrayBuffer containing the data of defined part of the file.
Returns void
- Defined in src/TransferFilePool.ts:226

storeFileMetadata

storeFileMetadata(metadata): string
Store file metadata.
Parameters
- metadata: TransferFileMetadata
  File metadata.
Returns string
The ID of the file.
- Defined in src/TransferFilePool.ts:84