Class ChunkUploadSdk

Description

Entry point for all chunk upload related tasks

Export

Hierarchy

ChunkUploadSdk

Index

Constructors

Properties

factory urlOptions

Methods

chunkFile cleanUpChunks commitChunks getChunkUploadInfo uploadChunk

Constructors

constructor

new ChunkUploadSdk(urlOptions: TypeOptions, factory: RequestFactory): ChunkUploadSdk
Parameters
- urlOptions: TypeOptions
- factory: RequestFactory
Returns ChunkUploadSdk
- Defined in chunk-upload/chunk-upload.sdk.ts:17

Properties

`Private` factory

factory: RequestFactory

`Private` urlOptions

urlOptions: TypeOptions

Methods

chunkFile

chunkFile(file: string | Blob, chunkSize: number, contentTypeMime: string): ChunkFileResult
Chunks the provided file. If the file is a base64 string this method will convert it to a blob and then chunk it.

Returns
{ChunkFileResult}

Memberof
ChunkUploadService
Parameters
- file: string | Blob
- chunkSize: number
- contentTypeMime: string
Returns ChunkFileResult
- Defined in chunk-upload/chunk-upload.sdk.ts:159

cleanUpChunks

cleanUpChunks(parameters: CleanUpChunksRequestOptions): void
Description
This request is intended to be used when something in the chunk upload process fails to delete the sent chunks

Memberof
ChunkUploadSdk
Parameters
- parameters: CleanUpChunksRequestOptions
Returns void
- Defined in chunk-upload/chunk-upload.sdk.ts:127

commitChunks

commitChunks(parameters: CommitChunksRequestOptions): void
Description
Sends the commit chunks request to the server

Memberof
ChunkUploadSdk
Parameters
- parameters: CommitChunksRequestOptions
Returns void
- Defined in chunk-upload/chunk-upload.sdk.ts:90

getChunkUploadInfo

getChunkUploadInfo(parameters: GetChunkUploadInfoRequestOptions): void
Description
Gets the needed information to start uploading chunks to the server

Memberof
ChunkUploadSdk
Parameters
- parameters: GetChunkUploadInfoRequestOptions
Returns void
- Defined in chunk-upload/chunk-upload.sdk.ts:27

uploadChunk

uploadChunk(parameters: UploadChunkRequestOptions): void
Description
Sends a single chunk request to the server

Memberof
ChunkUploadSdk
Parameters
- parameters: UploadChunkRequestOptions
Returns void
- Defined in chunk-upload/chunk-upload.sdk.ts:52

Generated using TypeDoc