slackline/api/chat/unfurl

This module is generated by gleam run -m slackline_codegen/generate. Do not edit it by hand.

Setters for the optional arguments of chat.unfurl. Each setter takes the call that chat.unfurl returns and sets one argument:

chat.unfurl()
|> unfurl.channel("channel")

Values

pub fn channel(
  call: slackline.Call(chat.UnfurlMethod, r),
  channel: String,
) -> slackline.Call(chat.UnfurlMethod, r)

Channel ID of the message. Both channel and ts must be provided together, or unfurl_id and source must be provided together. Required for public channels.

pub fn metadata(
  call: slackline.Call(chat.UnfurlMethod, r),
  metadata: message.MessageMetadata,
) -> slackline.Call(chat.UnfurlMethod, r)

Work Object entities for the unfurled resources, in entities. Either unfurls or metadata must be provided.

pub fn source(
  call: slackline.Call(chat.UnfurlMethod, r),
  source: chat.UnfurlSource,
) -> slackline.Call(chat.UnfurlMethod, r)

The source of the link to unfurl. The source may either be composer, when the link is inside the message composer, or conversations_history, when the link has been posted to a conversation. Acceptable values: composer conversations_history

pub fn ts(
  call: slackline.Call(chat.UnfurlMethod, r),
  ts: String,
) -> slackline.Call(chat.UnfurlMethod, r)

Timestamp of the message to add unfurl behavior to. Required for public channels.

pub fn unfurl_id(
  call: slackline.Call(chat.UnfurlMethod, r),
  unfurl_id: String,
) -> slackline.Call(chat.UnfurlMethod, r)

The ID of the link to unfurl. Both unfurl_id and source must be provided together, or channel and ts must be provided together.

pub fn unfurls(
  call: slackline.Call(chat.UnfurlMethod, r),
  unfurls: dict.Dict(String, chat.Unfurl),
) -> slackline.Call(chat.UnfurlMethod, r)

A map keyed on the URLs in the message, pointing to their unfurl blocks or a single message attachment. Either unfurls or metadata must be provided.

pub fn user_auth_blocks(
  call: slackline.Call(chat.UnfurlMethod, r),
  user_auth_blocks: List(block.Block),
) -> slackline.Call(chat.UnfurlMethod, r)

Blocks sent as an ephemeral message inviting the user to authenticate. They override the default buttons of user_auth_message.

pub fn user_auth_message(
  call: slackline.Call(chat.UnfurlMethod, r),
  user_auth_message: String,
) -> slackline.Call(chat.UnfurlMethod, r)

Text with simple formatting, sent as an ephemeral message that asks the user to authenticate. Implies user_auth_required.

pub fn user_auth_required(
  call: slackline.Call(chat.UnfurlMethod, r),
  user_auth_required: Bool,
) -> slackline.Call(chat.UnfurlMethod, r)

Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain Defaults to 0.

pub fn user_auth_url(
  call: slackline.Call(chat.UnfurlMethod, r),
  user_auth_url: String,
) -> slackline.Call(chat.UnfurlMethod, r)

Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.

✨ Search Document