Class BlobAPI

Hierarchy (View Summary)

BaseAPI
- BlobAPI

Index

Constructors

Properties

Methods

copy download upload

Constructors

constructor

new BlobAPI(client: JMAPClient): BlobAPI
Parameters
- client: JMAPClient
Returns BlobAPI
Overrides BaseAPI.constructor
- Defined in api/blob.ts:7

Properties

`Protected`client

client: JMAPClient

`Protected`session

session: undefined | Session<string>

Methods

copy

copy(
args: CopyBlobRequest,
): Promise<Response<ProblemDetails | CopyBlobResponse>>
RFC 8620 (6.3) - https://datatracker.ietf.org/doc/html/rfc8620#section-6.3
Parameters
- args: CopyBlobRequest
Returns Promise<Response<ProblemDetails | CopyBlobResponse>>
- Defined in api/blob.ts:86

download

download(
    accountId: string,
    blobId: string,
    contentType: string,
): Promise<ProblemDetails | ArrayBuffer>
RFC 8620 (6.2) - https://datatracker.ietf.org/doc/html/rfc8620#section-6.2
Parameters
- accountId: string
- blobId: string
- contentType: string
Returns Promise<ProblemDetails | ArrayBuffer>
- Defined in api/blob.ts:15

upload

upload(
accountId: string,
content: Blob,
): Promise<ProblemDetails | UploadingBlobResponse>
RFC 8620 (6.1) - https://datatracker.ietf.org/doc/html/rfc8620#section-6.1
Parameters
- accountId: string
- content: Blob
Returns Promise<ProblemDetails | UploadingBlobResponse>
- Defined in api/blob.ts:54