Type Alias UploadOptions

Options for files.upload().

Use path for an absolute Capsule File path. Use replace with fileId or fileReference when preserving the stable File ID but writing a new version.

type UploadOptions = {
    fileId?: string;
    fileReference?: FileReference;
    path?: string;
    replace?: boolean;
    onComplete?(event: UploadCompleteEvent): void;
    onProgress?(event: UploadProgressEvent): void;
}

Index

Properties

fileId? fileReference? path? replace?

Methods

onComplete? onProgress?

Properties

`Optional`fileId

fileId?: string

`Optional`fileReference

fileReference?: FileReference

`Optional`path

path?: string

`Optional`replace

replace?: boolean

Methods

`Optional`onComplete

onComplete?(event: UploadCompleteEvent): void
Parameters
- event: UploadCompleteEvent
Returns void
- Defined in client.d.ts:214

`Optional`onProgress

onProgress?(event: UploadProgressEvent): void
Parameters
- event: UploadProgressEvent
Returns void
- Defined in client.d.ts:213