View Source Lightning.WorkflowTemplates (Lightning v2.12.2)

The WorkflowTemplates context.

Summary

Functions

Returns an %Ecto.Changeset{} for tracking template changes.

Creates or updates a workflow template.

Deletes a workflow template.

Gets a single workflow template.

Gets a single workflow template.

Gets a template by workflow ID.

Lists all workflow templates.

Lists workflow templates for a specific workflow.

Updates a workflow template.

Functions

Link to this function

change_template(template, attrs \\ %{})

View Source

Returns an %Ecto.Changeset{} for tracking template changes.

Examples

iex> change_template(template)
%Ecto.Changeset{data: %WorkflowTemplate{}}
Link to this function

create_template(attrs \\ %{})

View Source

Creates or updates a workflow template.

If a template already exists for the workflow, it will be updated. Otherwise, a new template will be created.

Examples

iex> create_template(%{name: "My Template", code: "workflow code", workflow_id: "123"})
{:ok, %WorkflowTemplate{}}

iex> create_template(%{name: "Invalid"})
{:error, %Ecto.Changeset{}}
Link to this function

delete_template(template)

View Source

Deletes a workflow template.

Examples

iex> delete_template(template)
{:ok, %WorkflowTemplate{}}

iex> delete_template(template)
{:error, %Ecto.Changeset{}}

Gets a single workflow template.

Returns nil if the Workflow template does not exist.

Examples

iex> get_template(123)
%WorkflowTemplate{}

iex> get_template(456)
nil

Gets a single workflow template.

Raises Ecto.NoResultsError if the Workflow template does not exist.

Examples

iex> get_template!(123)
%WorkflowTemplate{}

iex> get_template!(456)
** (Ecto.NoResultsError)
Link to this function

get_template_by_workflow_id(workflow_id)

View Source

Gets a template by workflow ID.

Examples

iex> get_template_by_workflow_id("123")
%WorkflowTemplate{}

iex> get_template_by_workflow_id("456")
nil

Lists all workflow templates.

Examples

iex> list_templates()
[%WorkflowTemplate{}, ...]
Link to this function

list_workflow_templates(workflow)

View Source

Lists workflow templates for a specific workflow.

Examples

iex> list_workflow_templates(workflow)
[%WorkflowTemplate{}, ...]
Link to this function

update_template(template, attrs)

View Source

Updates a workflow template.

Examples

iex> update_template(template, %{name: "New Name"})
{:ok, %WorkflowTemplate{}}

iex> update_template(template, %{name: ""})
{:error, %Ecto.Changeset{}}