Slackblocks.Objects.SlackFile (slackblocks v2.8.0)

View Source

A reference to an image file hosted in Slack.

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

Fields

  • id — Sets the ID of a file previously uploaded to Slack. Cannot be combined with a URL. Optional; nil omits the field.
  • url — Sets the URL of a file hosted in Slack. Cannot be combined with an ID. 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.SlackFile{id: binary() | nil, url: 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.