TelegramEx.Builder.Voice (TelegramEx v1.3.0)

Builder for voice message payloads.

Supports Telegram file IDs, URLs, local files, captions, parse modes, duration, and silent sends. See Messages and Media.

Summary

Types

input()

Functions

caption(input, caption)

Sets the voice message caption.

caption(input, caption, parse_mode)

Sets the voice message caption with parse mode.

duration(input, seconds)

Sets the voice message duration in seconds.

id(input, id)

Sets the voice message by Telegram file ID.

path(input, path)

Sets the voice message from a local file path.

send(input, id)

Sends the voice message to the specified chat.

silent(input)

Sends the voice message without notification sound.

url(input, url)

Sets the voice message from a URL.

Types

input()

@type input() :: map() | TelegramEx.Effect.t()

Functions

caption(input, caption)

@spec caption(input(), String.t()) :: TelegramEx.Effect.t()

Sets the voice message caption.

caption(input, caption, parse_mode)

@spec caption(input(), String.t(), String.t()) :: TelegramEx.Effect.t()

Sets the voice message caption with parse mode.

duration(input, seconds)

@spec duration(input(), integer()) :: TelegramEx.Effect.t()

Sets the voice message duration in seconds.

id(input, id)

@spec id(input(), String.t()) :: TelegramEx.Effect.t()

Sets the voice message by Telegram file ID.

path(input, path)

@spec path(input(), String.t()) :: TelegramEx.Effect.t()

Sets the voice message from a local file path.

If the file cannot be read, the returned effect contains {:file, reason}.

send(input, id)

@spec send(input(), integer()) :: TelegramEx.Effect.t()

Sends the voice message to the specified chat.

silent(input)

@spec silent(input()) :: TelegramEx.Effect.t()

Sends the voice message without notification sound.

url(input, url)

@spec url(input(), String.t()) :: TelegramEx.Effect.t()

Sets the voice message from a URL.