View Source Ash.Policy.FilterCheckWithContext behaviour (ash v2.21.13)

A type of check that is represented by a filter statement, and has access to the context.

Summary

Types

context()

options()

Callbacks

filter(actor, context, options)

reject(actor, context, options)

Functions

is_filter_check?(module)

Types

context()

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

options()

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

Callbacks

filter(actor, context, options)

@callback filter(actor :: term(), context(), options()) :: Keyword.t() | Ash.Expr.t()

reject(actor, context, options)

(optional)

@callback reject(actor :: term(), context(), options()) :: Keyword.t() | Ash.Expr.t()