Jido.Chat.Telegram.SendOptions (Jido Chat Telegram v1.2.1)

Copy Markdown View Source

Typed options for Telegram send_message/3.

Summary

Types

t()

Functions

new(opts)

Builds typed send options from keyword, map, or struct input.

payload_opts(opts)

Builds Telegram API payload options for sendMessage.

rich_payload_opts(opts)

Builds Telegram API payload options for sendRichMessage.

schema()

Returns the Zoi schema for send options.

transport_opts(opts)

Builds transport-level options consumed by ExGramClient.

Types

t()

@type t() :: %Jido.Chat.Telegram.SendOptions{
  adapter_opts: nil | nil | any(),
  check_params: nil | nil | boolean(),
  debug: nil | nil | boolean(),
  disable_notification: nil | nil | boolean(),
  disable_web_page_preview: nil | nil | boolean(),
  entities: nil | nil | any(),
  ex_gram_adapter: nil | nil | any(),
  ex_gram_module: nil | nil | any(),
  link_preview_options: nil | nil | any(),
  parse_mode: nil | nil | binary(),
  protect_content: nil | nil | boolean(),
  reply_markup: nil | nil | any(),
  reply_to_message_id: nil | nil | any(),
  rich_format: nil | nil | :markdown | :html,
  thread_id: nil | nil | any(),
  token: nil | nil | binary(),
  transport: any(),
  url: nil | nil | binary()
}

Functions

new(opts)

Builds typed send options from keyword, map, or struct input.

payload_opts(opts)

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

Builds Telegram API payload options for sendMessage.

rich_payload_opts(opts)

@spec rich_payload_opts(t()) :: map()

Builds Telegram API payload options for sendRichMessage.

Rich messages carry their own formatting inside the rich_message payload, so parse_mode, entities, and the link-preview options accepted by sendMessage are not valid here and are dropped.

schema()

Returns the Zoi schema for send options.

transport_opts(opts)

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

Builds transport-level options consumed by ExGramClient.