View Source Ash.ActionInput (ash v3.3.0)

@type t() :: %Ash.ActionInput{
  action: Ash.Resource.Actions.Action.t() | nil,
  arguments: map(),
  context: map(),
  domain: Ash.Domain.t(),
  errors: term(),
  invalid_keys: MapSet.t(),
  params: map(),
  resource: Ash.Resource.t(),
  tenant: term(),
  valid?: boolean()
}

Functions

add_error(input, errors, path \\ [])

Adds an error to the input errors list, and marks the input as valid?: false

fetch_argument(input, argument)

@spec fetch_argument(t(), atom() | String.t()) :: {:ok, term()} | :error

Fetches the value of an argument provided to the input or :error.

for_action(resource_or_input, action, params, opts \\ [])

@spec for_action(
  resource_or_input :: Ash.Resource.t() | t(),
  action :: atom(),
  params :: map(),
  opts :: Keyword.t()
) :: t()

Creates a new input for a generic action

get_argument(input, argument)

@spec get_argument(t(), atom() | String.t()) :: term()

Gets the value of an argument provided to the input.

new(resource, domain \\ nil)

set_argument(input, argument, value)

@spec set_argument(input :: t(), name :: atom(), value :: term()) :: t()

Set an argument value

set_context(input, map)

@spec set_context(t(), map() | nil) :: t()

Deep merges the provided map into the input context that can be used later

Do not use the private key in your custom context, as that is reserved for internal use.

set_tenant(input, tenant)

@spec set_tenant(t(), Ash.ToTenant.t()) :: t()