tgbot-cpp
Loading...
Searching...
No Matches
TgBot::InputMediaVoiceNote Struct Reference

Represents a voice message file to be sent. More...

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<InputMediaVoiceNote>

Public Attributes

std::string type { TYPE }
 Type of the media, must be voice_note.
std::string media { }
 File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
std::optional< std::string > caption { }
 Optional. Caption of the voice message to be sent, 0-1024 characters after entities parsing.
std::optional< std::string > parseMode { }
 Optional. Mode for parsing entities in the voice message caption. See formatting options for more details.
std::optional< std::vector< std::shared_ptr< MessageEntity > > > captionEntities { }
 Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
std::optional< std::int32_t > duration { }
 Optional. Duration of the voice message in seconds.

Static Public Attributes

static TGBOT_API const std::string TYPE

Detailed Description

Represents a voice message file to be sent.

Definition at line 6880 of file Types.h.

Member Typedef Documentation

◆ Ptr

Definition at line 6881 of file Types.h.

Member Data Documentation

◆ caption

std::optional<std::string> TgBot::InputMediaVoiceNote::caption { }

Optional. Caption of the voice message to be sent, 0-1024 characters after entities parsing.

Definition at line 6902 of file Types.h.

◆ captionEntities

std::optional<std::vector<std::shared_ptr<MessageEntity> > > TgBot::InputMediaVoiceNote::captionEntities { }

Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.

Definition at line 6914 of file Types.h.

◆ duration

std::optional<std::int32_t> TgBot::InputMediaVoiceNote::duration { }

Optional. Duration of the voice message in seconds.

Definition at line 6919 of file Types.h.

◆ media

std::string TgBot::InputMediaVoiceNote::media { }

File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »

Definition at line 6896 of file Types.h.

◆ parseMode

std::optional<std::string> TgBot::InputMediaVoiceNote::parseMode { }

Optional. Mode for parsing entities in the voice message caption. See formatting options for more details.

Definition at line 6908 of file Types.h.

◆ TYPE

TGBOT_API const std::string TgBot::InputMediaVoiceNote::TYPE
static

Definition at line 6883 of file Types.h.

◆ type

std::string TgBot::InputMediaVoiceNote::type { TYPE }

Type of the media, must be voice_note.

Definition at line 6888 of file Types.h.


The documentation for this struct was generated from the following file: