UploadApiTask <Change>

Represents content that is about to be uploaded.

Index

Properties

• bytesUploaded
• onChunkuploaded
• progress
• sizeInBytes

Methods

• cancel
• upload

Properties

readonlybytesUploaded

bytesUploaded: number

Number of bytes that have currently been uploaded

readonlyonChunkuploaded

onChunkuploaded: Observable<UploadApiTask<Change>>

Triggered every time a chunk has been sucessfully uploaded.

readonlyprogress

progress: number

Progress of upload in range of [0, 100].

readonlysizeInBytes

sizeInBytes: number

Size in bytes of the content that is to be uploaded.

Methods

cancel

• cancel(): Promise<boolean>

• cancels the ongoing upload.

  ---

  Returns Promise<boolean>

  boolean promise which evaluates to true if cancellation was a success.

upload

• upload(): Promise<Change | UploadApiClientFailure>

• Starts uploading the content.

  ---

  Returns Promise<Change | UploadApiClientFailure>

  either a change, representing the new version that the upload resulted in, or UploadApiClientFailure that represents an error.