UploadService | iland-sdk

Upload Service provides a wrapper for the iland upload engine to allow robust, resumable uploads of large files.

Hierarchy

UploadService

Index

Methods

Methods

Static getSessionFileInfo

getSessionFileInfo(host: string, sessionID: string, fileName: string): Promise<UploadSessionFileInfo>

- Defined in service/upload-service/upload-service.ts:63
Gets info for a specific file within an upload session.

Parameters
- host: string
  
  the upload session host
- sessionID: string
  
  the upload session UUID
- fileName: string
  
  the name of the file within the upload session
Returns Promise<UploadSessionFileInfo>

a promise that resolves with the file info

Static listMissingFileChunks

listMissingFileChunks(host: string, sessionID: string, fileName: string): Promise<UploadSessionFileChunkRangeList>

- Defined in service/upload-service/upload-service.ts:44
Lists the missing file chunks for an upload session.

Parameters
- host: string
  
  the upload session host
- sessionID: string
  
  the upload session UUID
- fileName: string
  
  the name of the file within the upload session
Returns Promise<UploadSessionFileChunkRangeList>

a promise that resolves with upload session missing file chunk range list

Static listSessionFileInfo

listSessionFileInfo(host: string, sessionID: string): Promise<UploadSessionFileInfoList>

- Defined in service/upload-service/upload-service.ts:30
Lists info about the files in an upload session.

Parameters
- host: string
  
  the upload session host
- sessionID: string
  
  the upload session UUID
Returns Promise<UploadSessionFileInfoList>

a promise that resolves with upload session file info list

Static uploadFiles

uploadFiles(host: string, sessionID: string, files: Array<File>, logger?: Logger): FileProgressObservable

- Defined in service/upload-service/upload-service.ts:160
Uploads multiple files to an upload session simultaneously.

Parameters
- host: string
  
  the upload session host
- sessionID: string
  
  the upload session UUID
- files: Array<File>
  
  the list of files to upload
- Optional logger: Logger
  
  an optional logger to enable console messages for internal process details
Returns FileProgressObservable

an observable that emits events to notify consumers of upload progress for each file

Generated using TypeDoc