Class AttachmentsResolver

A resolver for cell attachments 'attachment:filename'.

Will resolve to a data: url.

Implements

IRenderMime.IResolver

Index

Constructors

Methods

getDownloadUrl isLocal resolveUrl

Constructors

constructor

new AttachmentsResolver(
options: AttachmentsResolver.IOptions,
): AttachmentsResolver
Create an attachments resolver object.
Parameters
- options: AttachmentsResolver.IOptions
Returns AttachmentsResolver
- Defined in packages/attachments/src/model.ts:337

Methods

getDownloadUrl

getDownloadUrl(path: string): Promise<string>
Get the download url of a given absolute server path.

Notes
The returned URL may include a query parameter.
Parameters
- path: string
Returns Promise<string>
Implementation of IResolver.getDownloadUrl
- Defined in packages/attachments/src/model.ts:357

isLocal

isLocal(url: string): boolean
Whether the URL should be handled by the resolver or not.
Parameters
- url: string
Returns boolean
Implementation of IResolver.isLocal
- Defined in packages/attachments/src/model.ts:385

resolveUrl

resolveUrl(url: string): Promise<string>
Resolve a relative url to a correct server path.
Parameters
- url: string
Returns Promise<string>
Implementation of IResolver.resolveUrl
- Defined in packages/attachments/src/model.ts:344