Class BlobInvocation<TArgs>

BlobInvocation represents a JMAP Blob capability invocation.

The Blob data type handles binary data management with methods for copying, uploading, retrieving, and looking up binary data across accounts. The Blob/copy method is part of the Core capability (RFC 8620), while upload/get/lookup are part of the Blob Management Extension (RFC 9404).

See

Type Parameters

TArgs extends BlobRequestInvocationArgs | BlobResponseInvocationArgs

Hierarchy (View Summary)

Invocation<TArgs>
- BlobInvocation

Index

Constructors

constructor

new BlobInvocation<
    TArgs extends BlobRequestInvocationArgs
    | BlobResponseInvocationArgs,
>(
    method: JMAPMethodName,
    args: InvocationArgs<TArgs>,
    methodCallId?: symbol,
): BlobInvocation<TArgs>
Constructs a BlobInvocation
Type Parameters
- TArgs extends BlobRequestInvocationArgs | BlobResponseInvocationArgs
Parameters
- method: JMAPMethodName
  The name of the method being invoked (e.g., "copy", "upload", "get", "lookup")
- args: InvocationArgs<TArgs>
  The arguments for the method invocation
- OptionalmethodCallId: symbol
  An optional unique symbol to identify this method call for result referencing
Returns BlobInvocation<TArgs>
Overrides Invocation.constructor
- Defined in src/capabilities/blob/blob.ts:46

Accessors

arguments

get arguments(): TArgs
Get the arguments for the invocation

The arguments are the named parameters passed to the method being invoked.

Returns TArgs
Inherited from Invocation.arguments
- Defined in src/invocation/invocation.ts:88

dataType

get dataType(): JMAPDataType
Get the data type of the invocation

The data type of the invocation is the name of the object that methods are associated with (e.g., "Email", "Mailbox", "Thread")

Returns JMAPDataType
Inherited from Invocation.dataType
- Defined in src/invocation/invocation.ts:61

id

get id(): symbol
Get the internal identifier for the invocation

The internal identifier is a unique symbol used to identify this invocation instance.

Returns symbol
Inherited from Invocation.id
- Defined in src/invocation/invocation.ts:79

method

get method(): JMAPMethodName
Get the method name of the invocation

The method name of the invocation is the name of the method being invoked (e.g., "get", "set", "query")

Returns JMAPMethodName
Inherited from Invocation.method
- Defined in src/invocation/invocation.ts:70

name

get name(): string
Get the name of the method

The name of the method in the format "{dataType}/{method}"

Returns string
Inherited from Invocation.name
- Defined in src/invocation/invocation.ts:51

uri

get uri(): keyof JMAPServerCapabilities
Returns keyof JMAPServerCapabilities
Overrides Invocation.uri
- Defined in src/capabilities/blob/blob.ts:32

Methods

argumentKeys

argumentKeys(): (keyof TArgs & string)[]
Get the keys of all arguments.

Returns (keyof TArgs & string)[]
An array of argument names
Inherited from Invocation.argumentKeys
- Defined in src/invocation/invocation.ts:136

createReference

createReference(path: string): ResultReference
Create a result reference for a named argument to use in another method.
Parameters
- path: string
  The path to the result to reference
Returns ResultReference
The result reference
Inherited from Invocation.createReference
- Defined in src/invocation/invocation.ts:145

deleteArgument

deleteArgument(name: keyof TArgs & string): boolean
Delete a named argument.
Parameters
- name: keyof TArgs & string
  The name of the argument
Returns boolean
Whether the argument was deleted
Inherited from Invocation.deleteArgument
- Defined in src/invocation/invocation.ts:119

getArgument

getArgument<K extends string>(name: K): TArgs[K]
Get the value of a named argument.
Type Parameters
- K extends string
Parameters
- name: K
  The name of the argument
Returns TArgs[K]
The value or result reference for the named argument.
Inherited from Invocation.getArgument
- Defined in src/invocation/invocation.ts:98

hasArgument

hasArgument(name: keyof TArgs & string): boolean
Check if a named argument exists.
Parameters
- name: keyof TArgs & string
  The name of the argument
Returns boolean
Whether the argument exists
Inherited from Invocation.hasArgument
- Defined in src/invocation/invocation.ts:128

resolve

resolve(
id: string,
lookupId: (id: symbol) => string | undefined,
): JMAPRequestInvocation
Resolve the invocation into a JMAP request invocation tuple.

Converts internal ResultReference arguments into their wire format (#property keys with resolved resultOf ids) and produces the [name, arguments, methodCallId] tuple expected by the JMAP protocol.
Parameters
- id: string
  The method call id to assign to this invocation in the request
- lookupId: (id: symbol) => string | undefined
  A function that resolves an invocation's internal symbol id to the string method call id assigned in the request
Returns JMAPRequestInvocation
The resolved JMAP request invocation tuple

Throws
If a result reference refers to an invocation whose id cannot be resolved
Inherited from Invocation.resolve
- Defined in src/invocation/invocation.ts:162

setArgument

setArgument<K extends string>(name: K, value: InvocationArgs<TArgs>[K]): void
Set the value of a named argument.
Type Parameters
- K extends string
Parameters
- name: K
  The name of the argument
- value: InvocationArgs<TArgs>[K]
  The value or result reference for the named argument.
Returns void
Inherited from Invocation.setArgument
- Defined in src/invocation/invocation.ts:107

toJSON

toJSON(): JMAPInvocationInternal
Convert the invocation to a serialisable representation.

Returns JMAPInvocationInternal
A serialisable representation of the invocation

Remarks
It is expected that the caller will provide a resolver function to resolve the ID and any result references referring to other invocations.
Inherited from Invocation.toJSON
- Defined in src/invocation/invocation.ts:180

`Static`createInvocationFactory

createInvocationFactory<
    TArgs extends BlobRequestInvocationArgs
    | BlobResponseInvocationArgs,
>(
    method: JMAPMethodName,
): InvocationFactory<TArgs, BlobInvocation<TArgs>>
Create an invocation factory function
Type Parameters
- TArgs extends BlobRequestInvocationArgs | BlobResponseInvocationArgs
Parameters
- method: JMAPMethodName
  The name of the method to create
Returns InvocationFactory<TArgs, BlobInvocation<TArgs>>
A new Blob invocation factory function for creating invocations of the specified type
- Defined in src/capabilities/blob/blob.ts:56

Class BlobInvocation<TArgs>

See

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BlobInvocation<TArgs>

Accessors

arguments

Returns TArgs

dataType

Returns JMAPDataType

id

Returns symbol

method

Returns JMAPMethodName

name

Returns string

uri

Returns keyof JMAPServerCapabilities

Methods

argumentKeys

Returns (keyof TArgs & string)[]

createReference

Parameters

Returns ResultReference

deleteArgument

Parameters

Returns boolean

getArgument

Type Parameters

Parameters

Returns TArgs[K]

hasArgument

Parameters

Returns boolean

resolve

Parameters

Returns JMAPRequestInvocation

Throws

setArgument

Type Parameters

Parameters

Returns void

toJSON

Returns JMAPInvocationInternal

Remarks

StaticcreateInvocationFactory

Type Parameters

Parameters

Returns InvocationFactory<TArgs, BlobInvocation<TArgs>>

Settings

On This Page

`Static`createInvocationFactory