Jido.Chat.Slack.SendOptions (Jido Chat Slack v1.0.0)

Copy Markdown View Source

Typed options for Slack send_message/3.

Summary

Functions

Builds send options from a struct, keyword list, or map.

Builds Slack API payload options for message sends.

Returns the Zoi schema for send options.

Extracts transport options for Slack send calls.

Types

t()

@type t() :: %Jido.Chat.Slack.SendOptions{
  attachments: nil | nil | any(),
  blocks: nil | nil | any(),
  icon_emoji: nil | nil | binary(),
  icon_url: nil | nil | binary(),
  reply_broadcast: nil | nil | boolean(),
  req: nil | nil | any(),
  thread_ts: nil | nil | any(),
  token: nil | nil | binary(),
  transport: any(),
  unfurl_links: nil | nil | boolean(),
  unfurl_media: nil | nil | boolean(),
  username: nil | nil | binary()
}

Functions

new(opts)

@spec new(t() | keyword() | map()) :: t()

Builds send options from a struct, keyword list, or map.

payload_opts(opts)

@spec payload_opts(t()) :: map()

Builds Slack API payload options for message sends.

schema()

Returns the Zoi schema for send options.

transport_opts(opts)

@spec transport_opts(t()) :: keyword()

Extracts transport options for Slack send calls.