Slackblocks.Objects.Confirmation (slackblocks v2.8.0)

View Source

A dialog that asks users to confirm an action before it is sent.

Slack reference: https://docs.slack.dev/reference/block-kit/composition-objects/confirmation-dialog-object

Fields

  • title — Sets the dialog title. Required.
  • text — Sets the explanatory text in the dialog body. Required.
  • confirm — Sets the label of the button that confirms the action. Required.
  • deny — Sets the label of the button that cancels the action. Required.
  • style — Sets the emphasis of the confirm button. 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.Objects.Confirmation{
  confirm: Slackblocks.Objects.PlainText.t(),
  deny: Slackblocks.Objects.PlainText.t(),
  style: Slackblocks.Types.button_style() | nil,
  text: Slackblocks.Types.text(),
  title: Slackblocks.Objects.PlainText.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.