Slackblocks.Blocks.TaskCard (slackblocks v2.8.0)

View Source

One task with its status, details, output, and sources.

Slack reference: https://docs.slack.dev/reference/block-kit/blocks/task-card-block

Fields

  • task_id — Sets the identifier of the task. Required.
  • title — Sets the task title. Required.
  • details — Sets a rich text description of the task. Optional; nil omits the field.
  • output — Sets rich text describing the task's output. Optional; nil omits the field.
  • sources — Adds links to the sources the task used, in display order. Optional; nil omits the field.
  • status — Sets the task's current state. Required.
  • block_id — Sets a unique identifier for this block. Slack returns it in interaction payloads, so use a stable value when you need to find the block again. 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.Blocks.TaskCard{
  block_id: binary() | nil,
  details: Slackblocks.Blocks.RichText.t() | nil,
  output: Slackblocks.Blocks.RichText.t() | nil,
  sources: [Slackblocks.Objects.UrlSource.t()] | nil,
  status: Slackblocks.Types.task_status(),
  task_id: binary(),
  title: binary()
}

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.