Slackblocks.RichText.Link (slackblocks v2.8.0)

View Source

A hyperlink inside rich text.

Slack reference: https://docs.slack.dev/reference/block-kit/blocks/rich-text-block

Fields

  • url — Sets the link target. Required.
  • text — Sets the visible link text. Slack shows the URL when omitted. Optional; nil omits the field.
  • style — Sets the visual style. Optional; nil omits the field.
  • unsafe — Sets whether Slack treats the link as unsafe. 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.RichText.Link{
  style: Slackblocks.RichText.Style.t() | nil,
  text: binary() | nil,
  unsafe: boolean() | nil,
  url: 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.