Interface: FileUploadProvider

Defined in: src/forms/fileUploadProvider.ts:10

Provides a strategy to upload files from the UI, e.g. forms.

Methods

getFileMetadata()

getFileMetadata(fileIri): undefined | ElementModel

Defined in: src/forms/fileUploadProvider.ts:18

Gets metadata for a file uploaded with this provider instance.

Parameters

Parameter	Type
fileIri	string

Returns

undefined | ElementModel

---

resolveFileUrl()

resolveFileUrl(fileIri, options): Promise<undefined | string>

Defined in: src/forms/fileUploadProvider.ts:27

Gets or creates a resolvable asset URL for a file uploaded with this provider instance.

Parameters

Parameter	Type
fileIri	string
options	{ signal?: AbortSignal; }
options.signal?	AbortSignal

Returns

Promise<undefined | string>

a URL that can be used in <a href="..."> or <img src="..."> or undefined if the specified IRI does not correspond to an uploaded file with this provider instance

---

uploadFile()

uploadFile(file, options): Promise<UploadedFile>

Defined in: src/forms/fileUploadProvider.ts:14

Uploads a file, generates and returns its metadata.

Parameters

Parameter	Type
file	File
options	{ signal?: AbortSignal; }
options.signal?	AbortSignal

Returns

Promise<UploadedFile>