AppleIntents.Response (apple_intents v0.1.0)

Copy Markdown View Source

Structured responses returned to Apple / Siri.

Summary

Functions

Encode an approval gate response.

Encode a dry-run preview response.

Encode a handler or verification failure.

Encode a successful handler result.

Encode a rejected approval callback.

Types

result()

@type result() :: map()

Functions

approval_required(details, opts \\ [])

@spec approval_required(
  map(),
  keyword()
) :: map()

Encode an approval gate response.

dry_run(preview, opts \\ [])

@spec dry_run(
  map(),
  keyword()
) :: map()

Encode a dry-run preview response.

error(reason, opts \\ [])

@spec error(
  AppleIntents.Error.t() | term(),
  keyword()
) :: map()

Encode a handler or verification failure.

ok(result, opts \\ [])

@spec ok(
  result(),
  keyword()
) :: map()

Encode a successful handler result.

rejected(details, opts \\ [])

@spec rejected(
  map(),
  keyword()
) :: map()

Encode a rejected approval callback.