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

Copy Markdown View Source

Typed options for Telegram stream/3.

Summary

Types

t()

Functions

draft_request(opts, draft_id, text)

Builds the Telegram method and payload for a draft update.

new(opts)

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

schema()

Returns the Zoi schema for stream options.

send_opts(opts)

Builds keyword options for the final send_message/3 call.

transport_opts(opts)

Builds transport-level options consumed by ExGramClient.

Types

t()

@type t() :: %Jido.Chat.Telegram.StreamOptions{
  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(),
  draft_id: nil | nil | integer(),
  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(),
  reply_markup: nil | nil | any(),
  rich_format: nil | nil | :markdown | :html,
  stream_update_interval_ms: integer(),
  thread_id: nil | nil | any(),
  token: nil | nil | binary(),
  transport: any(),
  url: nil | nil | binary()
}

Functions

draft_request(opts, draft_id, text)

@spec draft_request(t(), integer(), String.t()) :: {String.t(), map()}

Builds the Telegram method and payload for a draft update.

new(opts)

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

schema()

Returns the Zoi schema for stream options.

send_opts(opts)

@spec send_opts(t()) :: keyword()

Builds keyword options for the final send_message/3 call.

transport_opts(opts)

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

Builds transport-level options consumed by ExGramClient.