View Source LightningWeb.WorkflowLive.Helpers (Lightning v2.10.15)

Helper functions for the Workflow LiveViews.

Summary

Functions

broadcast_updated_params(socket, params)

run_workflow(workflow_or_changeset, params, opts)

save_workflow(changeset, actor)

subscribe_to_params_update(socket_id)

workflow_enabled?(workflow)

Determines if a workflow is enabled based on its triggers. Accepts either a Workflow struct or an Ecto.Changeset.

workflow_state_tooltip(changeset)

Generates a tooltip describing the workflow's state. Accepts either a Workflow struct or an Ecto.Changeset.

Functions

broadcast_updated_params(socket, params)

run_workflow(workflow_or_changeset, params, opts)

@spec run_workflow(
  Ecto.Changeset.t(Lightning.Workflows.Workflow.t())
  | Lightning.Workflows.Workflow.t(),
  map(),
  selected_job: map(),
  created_by: map(),
  project: map()
) ::
  {:ok,
   %{
     workorder: Lightning.WorkOrder.t(),
     workflow: Lightning.Workflows.Workflow.t(),
     message: Lightning.Extensions.UsageLimiting.message()
   }}
  | {:error, Ecto.Changeset.t(Lightning.Workflows.Workflow.t())}
  | {:error, Ecto.Changeset.t(Lightning.WorkOrders.Manual.t())}
  | {:error, Lightning.Extensions.UsageLimiting.message()}
  | {:error, :workflow_deleted}

save_workflow(changeset, actor)

@spec save_workflow(
  Ecto.Changeset.t(),
  struct()
) ::
  {:ok, Lightning.Workflows.Workflow.t()}
  | {:error,
     Ecto.Changeset.t()
     | Lightning.Extensions.UsageLimiting.message()
     | :workflow_deleted}

subscribe_to_params_update(socket_id)

workflow_enabled?(workflow)

Determines if a workflow is enabled based on its triggers. Accepts either a Workflow struct or an Ecto.Changeset.

workflow_state_tooltip(changeset)

Generates a tooltip describing the workflow's state. Accepts either a Workflow struct or an Ecto.Changeset.