Variable ExampleConst

Type Declaration

• request: {
      echo: InvocationFactory<
          BaseInvocationArgs,
          ExampleInvocation<BaseInvocationArgs>,
      >;
      get: InvocationFactory<
          ExampleGetRequestInvocationArgs,
          ExampleInvocation<ExampleGetRequestInvocationArgs>,
      >;
      query: InvocationFactory<
          ExampleQueryRequestInvocationArgs,
          ExampleInvocation<ExampleQueryRequestInvocationArgs>,
      >;
      set: InvocationFactory<
          ExampleSetRequestInvocationArgs,
          ExampleInvocation<ExampleSetRequestInvocationArgs>,
      >;
  }

  • echo: InvocationFactory<BaseInvocationArgs, ExampleInvocation<BaseInvocationArgs>>

    An example echo method that returns the same arguments it receives.

    This method demonstrates a simple request-only pattern used for testing.

    Param: args

    The invocation arguments for Example/echo

    Param: methodCallId

    An optional unique symbol to identify this method call for result referencing

    Returns

    An ExampleInvocation representing the Example/echo request

  • get: InvocationFactory<
        ExampleGetRequestInvocationArgs,
        ExampleInvocation<ExampleGetRequestInvocationArgs>,
    >

    An example get method that retrieves Example objects by their IDs.

    This method demonstrates the standard JMAP /get pattern used for testing.

    Param: args

    The invocation arguments for Example/get

    Param: methodCallId

    An optional unique symbol to identify this method call for result referencing

    Returns

    An ExampleInvocation representing the Example/get request

  • query: InvocationFactory<
        ExampleQueryRequestInvocationArgs,
        ExampleInvocation<ExampleQueryRequestInvocationArgs>,
    >

    An example query method that searches for Example objects matching criteria.

    This method demonstrates the standard JMAP /query pattern used for testing.

    Param: args

    The invocation arguments for Example/query

    Param: methodCallId

    An optional unique symbol to identify this method call for result referencing

    Returns

    An ExampleInvocation representing the Example/query request

  • set: InvocationFactory<
        ExampleSetRequestInvocationArgs,
        ExampleInvocation<ExampleSetRequestInvocationArgs>,
    >

    An example set method that creates, updates, or destroys Example objects.

    This method demonstrates the standard JMAP /set pattern used for testing.

    Param: args

    The invocation arguments for Example/set

    Param: methodCallId

    An optional unique symbol to identify this method call for result referencing

    Returns

    An ExampleInvocation representing the Example/set request

• response: {
      get: InvocationFactory<
          ExampleGetResponseInvocationArgs,
          ExampleInvocation<ExampleGetResponseInvocationArgs>,
      >;
      query: InvocationFactory<
          BaseQueryResponseInvocationArgs,
          ExampleInvocation<BaseQueryResponseInvocationArgs>,
      >;
      set: InvocationFactory<
          ExampleSetResponseInvocationArgs,
          ExampleInvocation<ExampleSetResponseInvocationArgs>,
      >;
  }