ash v1.24.1 Ash.Resource.Dsl.Destroy View Source

Link to this section Summary

Functions

Declares a destroy action. For calling this action, see the Ash.Api documentation.

Link to this section Functions

Link to this macro

destroy(name, opts \\ [])

View Source (macro)

Declares a destroy action. For calling this action, see the Ash.Api documentation.

Examples

destroy :soft_delete, primary?: true

Arguments

  • :name - The name of the action

Options

  • :accept - The list of attributes and relationships to accept. Defaults to all attributes on the resource. Has no effect unless soft? is specified.

  • :soft? - If specified, the destroy action calls the datalayer's update function with any specified changes.

  • :primary? - Whether or not this action should be used when no action is specified by the caller. The default value is false.

  • :description - An optional description for the action