tgbotxx  1.1.6.9
Telegram Bot C++ Library
tgbotxx::InlineQueryResultVoice Struct Reference

Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use inputMessageContent to send a message with the specified content instead of the voice message. More...

#include <InlineQueryResult.hpp>

Inheritance diagram for tgbotxx::InlineQueryResultVoice:
tgbotxx::InlineQueryResult

Public Member Functions

 InlineQueryResultVoice ()
 
 InlineQueryResultVoice (const nl::json &json)
 
nl::json toJson () const override
 
void fromJson (const nl::json &json) override
 
- Public Member Functions inherited from tgbotxx::InlineQueryResult
 InlineQueryResult ()=default
 
 InlineQueryResult (const nl::json &json)
 

Public Attributes

std::string voiceUrl
 A valid URL for the voice recording. More...
 
std::string title
 Recording title. More...
 
std::string caption
 Optional. Caption, 0-1024 characters after entities parsing. More...
 
std::string parseMode
 Optional. Mode for parsing entities in the voice caption. See formatting options for more details. More...
 
std::vector< Ptr< MessageEntity > > captionEntities
 Optional. List of special entities that appear in the caption, which can be specified instead of parseMode. More...
 
std::string performer
 Optional. Performer. More...
 
std::int32_t voiceDuration {}
 Optional. Recording duration in seconds. More...
 
Ptr< InputMessageContentinputMessageContent
 Optional. Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video). More...
 
- Public Attributes inherited from tgbotxx::InlineQueryResult
std::string type
 Type of the result. More...
 
std::string id
 Unique identifier for this result, 1-64 bytes. More...
 
Ptr< InlineKeyboardMarkupreplyMarkup
 Optional. Inline keyboard attached to the message. More...
 

Detailed Description

Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use inputMessageContent to send a message with the specified content instead of the voice message.

Note
: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.

Definition at line 505 of file InlineQueryResult.hpp.

Constructor & Destructor Documentation

◆ InlineQueryResultVoice() [1/2]

tgbotxx::InlineQueryResultVoice::InlineQueryResultVoice ( )
inline

Definition at line 506 of file InlineQueryResult.hpp.

◆ InlineQueryResultVoice() [2/2]

tgbotxx::InlineQueryResultVoice::InlineQueryResultVoice ( const nl::json &  json)
inlineexplicit

Definition at line 509 of file InlineQueryResult.hpp.

Member Function Documentation

◆ fromJson()

void tgbotxx::InlineQueryResultVoice::fromJson ( const nl::json &  json)
inlineoverridevirtual

Reimplemented from tgbotxx::InlineQueryResult.

Definition at line 551 of file InlineQueryResult.hpp.

◆ toJson()

nl::json tgbotxx::InlineQueryResultVoice::toJson ( ) const
inlineoverridevirtual

Reimplemented from tgbotxx::InlineQueryResult.

Definition at line 538 of file InlineQueryResult.hpp.

Member Data Documentation

◆ caption

std::string tgbotxx::InlineQueryResultVoice::caption

Optional. Caption, 0-1024 characters after entities parsing.

Definition at line 520 of file InlineQueryResult.hpp.

◆ captionEntities

std::vector<Ptr<MessageEntity> > tgbotxx::InlineQueryResultVoice::captionEntities

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

Definition at line 526 of file InlineQueryResult.hpp.

◆ inputMessageContent

Ptr<InputMessageContent> tgbotxx::InlineQueryResultVoice::inputMessageContent

Optional. Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).

Definition at line 536 of file InlineQueryResult.hpp.

◆ parseMode

std::string tgbotxx::InlineQueryResultVoice::parseMode

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

Definition at line 523 of file InlineQueryResult.hpp.

◆ performer

std::string tgbotxx::InlineQueryResultVoice::performer

Optional. Performer.

Definition at line 529 of file InlineQueryResult.hpp.

◆ title

std::string tgbotxx::InlineQueryResultVoice::title

Recording title.

Definition at line 517 of file InlineQueryResult.hpp.

◆ voiceDuration

std::int32_t tgbotxx::InlineQueryResultVoice::voiceDuration {}

Optional. Recording duration in seconds.

Definition at line 532 of file InlineQueryResult.hpp.

◆ voiceUrl

std::string tgbotxx::InlineQueryResultVoice::voiceUrl

A valid URL for the voice recording.

Definition at line 514 of file InlineQueryResult.hpp.


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