View Source Ash.Policy.SimpleCheck behaviour (ash v3.0.0-rc.31)

A type of check that operates only on request context, never on the data

Define match?/3, which gets the actor, request context, and opts, and returns true or false

Summary

Types

actor()

context()

options()

Callbacks

match?(actor, context, options)

Whether or not the request matches the check

Types

actor()

@type actor() :: Ash.Policy.Check.actor()

context()

@type context() :: %{
  :action => Ash.Resource.Actions.action(),
  :resource => Ash.Resource.t(),
  :domain => Ash.Domain.t(),
  optional(:query) => Ash.Query.t(),
  optional(:changeset) => Ash.Changeset.t(),
  optional(any()) => any()
}

options()

@type options() :: Keyword.t()

Callbacks

match?(actor, context, options)

@callback match?(actor(), context(), options()) ::
  boolean() | {:ok, boolean()} | {:error, term()}

Whether or not the request matches the check