Class TransferFilePool

Index

Constructors

Methods

abortFileDownload addFile clearFile deleteFile downloadFile fileExists getBlob getFile readFilePart receiveFilePart storeFileMetadata

Constructors

constructor

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

Methods

abortFileDownload

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

addFile

addFile(blob: Blob, name: string): 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 TransferFilePool.ts:172

clearFile

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

deleteFile

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

downloadFile

downloadFile(
    fileId: string,
    askFilePartCallback?: AskFilePartCallback,
    parallelCalls?: number,
): 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 TransferFilePool.ts:133

fileExists

fileExists(fileId: string): 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 TransferFilePool.ts:73

getBlob

getBlob(fileId: string): 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 TransferFilePool.ts:258

getFile

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

readFilePart

readFilePart(fileId: string, offset: number, limit: number): 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 TransferFilePool.ts:205

receiveFilePart

receiveFilePart(
    fileId: string,
    offset: number,
    limit: number,
    data: ArrayBuffer,
): 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 TransferFilePool.ts:225

storeFileMetadata

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