Class Invocation<TArgs>Abstract

constructor

• new Invocation<TArgs extends BaseInvocationArgs>(
      dataType: JMAPDataType,
      method: JMAPMethodName,
      args: InvocationArgs<TArgs>,
      methodCallId?: symbol,
  ): Invocation<TArgs>

  Constructs an Invocation

  Type Parameters

  • TArgs extends BaseInvocationArgs

    The type of the arguments for the invocation

  Parameters

  • dataType: JMAPDataType

    The data type of the invocation

  • method: JMAPMethodName

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

  • args: InvocationArgs<TArgs>

    object containing named arguments for that method or response

  • OptionalmethodCallId: symbol

  Returns Invocation<TArgs>

  Throws

  Throws

Abstract Readonlyuri

arguments

• get arguments(): TArgs

  Get the arguments for the invocation

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

  Returns TArgs

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

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

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

name

• get name(): string

  Get the name of the method

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

  Returns string

argumentKeys

• argumentKeys(): (keyof TArgs & string)[]

  Get the keys of all arguments.

  Returns (keyof TArgs & string)[]

  An array of argument names

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

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

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.

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

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

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

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.