Class MergedUploadTaskCompleteEvent

Hierarchy

AbstractMergedUploadTaskEvent
- MergedUploadTaskCompleteEvent

Index

Constructors

constructor

new MergedUploadTaskCompleteEvent(
bytes: number,
urls: string[],
): MergedUploadTaskCompleteEvent
Creates the event.
Parameters
- bytes: number
  Bytes uploaded
- urls: string[]
  Urls at which the resources are available. In the same order as the tasks
Returns MergedUploadTaskCompleteEvent
Overrides AbstractMergedUploadTaskEvent.constructor
- Defined in packages/firestorm/src/storage/upload/upload-task.event.ts:258

Properties

`Readonly`urls

urls: string[]

Urls at which the resources are available. In the same order as the tasks

Accessors

bytesTransferred

get bytesTransferred(): number
Returns number
Inherit Doc
Inherited from AbstractMergedUploadTaskEvent.bytesTransferred
- Defined in packages/firestorm/src/storage/upload/upload-task.event.ts:147
set bytesTransferred(value: number): void
Parameters
- value: number
Returns void
Inherit Doc
Inherited from AbstractMergedUploadTaskEvent.bytesTransferred
- Defined in packages/firestorm/src/storage/upload/upload-task.event.ts:152

completionRate

get completionRate(): number
Returns number
Inherit Doc
Inherited from AbstractMergedUploadTaskEvent.completionRate
- Defined in packages/firestorm/src/storage/upload/upload-task.event.ts:172

remainingBytes

get remainingBytes(): number
Returns number
Inherit Doc
Inherited from AbstractMergedUploadTaskEvent.remainingBytes
- Defined in packages/firestorm/src/storage/upload/upload-task.event.ts:157

state

get state(): StorageTaskState
Returns StorageTaskState
Inherit Doc
Inherited from AbstractMergedUploadTaskEvent.state
- Defined in packages/firestorm/src/storage/upload/upload-task.event.ts:178
set state(value: StorageTaskState): void
Sets the state of the storage task
Parameters
- value: StorageTaskState
  New value of the state
Returns void
Inherited from AbstractMergedUploadTaskEvent.state
- Defined in packages/firestorm/src/storage/upload/upload-task.event.ts:186

totalBytes

get totalBytes(): number
Returns number
Inherit Doc
Inherited from AbstractMergedUploadTaskEvent.totalBytes
- Defined in packages/firestorm/src/storage/upload/upload-task.event.ts:162
set totalBytes(value: number): void
Parameters
- value: number
Returns void
Inherit Doc
Inherited from AbstractMergedUploadTaskEvent.totalBytes
- Defined in packages/firestorm/src/storage/upload/upload-task.event.ts:167

Methods

`Static`mergeUploadTaskEvents

mergeUploadTaskEvents(
tasks: UploadTaskEvent[],
): MergedUploadTaskChangeEvent | MergedUploadTaskCompleteEvent
Merge multiple upload tasks event into one single upload task.

The completion rate is computing the participation of the subtasks int the total count of bytes
Parameters
- tasks: UploadTaskEvent[]
  Tasks to merge
Returns MergedUploadTaskChangeEvent | MergedUploadTaskCompleteEvent
Inherited from AbstractMergedUploadTaskEvent.mergeUploadTaskEvents
- Defined in packages/firestorm/src/storage/upload/upload-task.event.ts:200

Class MergedUploadTaskCompleteEvent

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MergedUploadTaskCompleteEvent

Properties

Readonlyurls

Accessors

bytesTransferred

Returns number

Inherit Doc

Parameters

Returns void

Inherit Doc

completionRate

Returns number

Inherit Doc

remainingBytes

Returns number

Inherit Doc

state

Returns StorageTaskState

Inherit Doc

Parameters

Returns void

totalBytes

Returns number

Inherit Doc

Parameters

Returns void

Inherit Doc

Methods

StaticmergeUploadTaskEvents

Parameters

Returns MergedUploadTaskChangeEvent | MergedUploadTaskCompleteEvent

Settings

On This Page

`Readonly`urls

`Static`mergeUploadTaskEvents