Slackblocks.Attachment (slackblocks v2.8.0)

View Source

A legacy message attachment containing blocks and an optional color bar.

Slack reference: https://docs.slack.dev/messaging/formatting-message-text#when-to-use-attachments

Fields

  • blocks — Adds the attachment's blocks in display order. Required.
  • color — Sets the attachment's left border color: a six-digit hex color or good, warning, or danger. Optional; nil omits the field.
  • fallback — Sets plain-text summary shown in clients that cannot display attachments. 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.Attachment{
  blocks: [Slackblocks.Types.block()],
  color: binary() | nil,
  fallback: binary() | nil
}

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.