Slackblocks.Elements.WorkflowButton (slackblocks v2.8.0)

View Source

A button that starts a workflow through a link trigger.

Slack reference: https://docs.slack.dev/reference/block-kit/block-elements/workflow-button-element

Fields

  • text — Sets the button label. Required.
  • workflow — Sets the workflow started when the button is clicked. Required.
  • action_id — Sets the identifier Slack returns in interaction payloads when a user acts on this element. It must be unique among the elements of its block. Required.
  • confirm — Sets a confirmation dialog shown before the action is sent. Optional; nil omits the field.
  • style — Sets the button's emphasis. Omit it for the default neutral style. Optional; nil omits the field.
  • accessibility_label — Sets the label read by screen readers in place of the visible text. Optional; nil omits the field.

Summary

Types

t()

Functions

change(value, options)

Atomically replaces supplied fields; omitted fields retain their values.

change!(value, options)

Replaces fields or raises Slackblocks.ValidationError.

new(options)

Constructs and validates a value. Text conveniences apply to keyword input.

new!(options)

Constructs a value or raises Slackblocks.ValidationError.

Types

t()

@type t() :: %Slackblocks.Elements.WorkflowButton{
  accessibility_label: binary() | nil,
  action_id: binary(),
  confirm: Slackblocks.Objects.Confirmation.t() | nil,
  style: Slackblocks.Types.button_style() | nil,
  text: Slackblocks.Objects.PlainText.t(),
  workflow: Slackblocks.Objects.Workflow.t()
}

Functions

change(value, options)

@spec change(
  t(),
  keyword()
) :: {:ok, t()} | {:error, Slackblocks.ValidationError.t()}

Atomically replaces supplied fields; omitted fields retain their values.

change!(value, options)

@spec change!(
  t(),
  keyword()
) :: t()

Replaces fields or raises Slackblocks.ValidationError.

new(options)

@spec new(keyword()) :: {:ok, t()} | {:error, Slackblocks.ValidationError.t()}

Constructs and validates a value. Text conveniences apply to keyword input.

new!(options)

@spec new!(keyword()) :: t()

Constructs a value or raises Slackblocks.ValidationError.