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

Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use inputMessageContent to send a message with the specified content instead of the audio. More...

#include <InlineQueryResult.hpp>

Inheritance diagram for tgbotxx::InlineQueryResultAudio:
tgbotxx::InlineQueryResult

Public Member Functions

 InlineQueryResultAudio ()
 
 InlineQueryResultAudio (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 audioUrl
 A valid URL for the audio file. More...
 
std::string title
 Title. More...
 
std::string caption
 Optional. Caption, 0-1024 characters after entities parsing. More...
 
std::string parseMode
 Optional. Mode for parsing entities in the audio 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 audioDuration {}
 Optional. Audio 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 an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use inputMessageContent to send a message with the specified content instead of the audio.

Definition at line 441 of file InlineQueryResult.hpp.

Constructor & Destructor Documentation

◆ InlineQueryResultAudio() [1/2]

tgbotxx::InlineQueryResultAudio::InlineQueryResultAudio ( )
inline

Definition at line 442 of file InlineQueryResult.hpp.

◆ InlineQueryResultAudio() [2/2]

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

Definition at line 445 of file InlineQueryResult.hpp.

Member Function Documentation

◆ fromJson()

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

Reimplemented from tgbotxx::InlineQueryResult.

Definition at line 487 of file InlineQueryResult.hpp.

◆ toJson()

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

Reimplemented from tgbotxx::InlineQueryResult.

Definition at line 474 of file InlineQueryResult.hpp.

Member Data Documentation

◆ audioDuration

std::int32_t tgbotxx::InlineQueryResultAudio::audioDuration {}

Optional. Audio duration in seconds.

Definition at line 468 of file InlineQueryResult.hpp.

◆ audioUrl

std::string tgbotxx::InlineQueryResultAudio::audioUrl

A valid URL for the audio file.

Definition at line 450 of file InlineQueryResult.hpp.

◆ caption

std::string tgbotxx::InlineQueryResultAudio::caption

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

Definition at line 456 of file InlineQueryResult.hpp.

◆ captionEntities

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

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

Definition at line 462 of file InlineQueryResult.hpp.

◆ inputMessageContent

Ptr<InputMessageContent> tgbotxx::InlineQueryResultAudio::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 472 of file InlineQueryResult.hpp.

◆ parseMode

std::string tgbotxx::InlineQueryResultAudio::parseMode

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

Definition at line 459 of file InlineQueryResult.hpp.

◆ performer

std::string tgbotxx::InlineQueryResultAudio::performer

Optional. Performer.

Definition at line 465 of file InlineQueryResult.hpp.

◆ title

std::string tgbotxx::InlineQueryResultAudio::title

Title.

Definition at line 453 of file InlineQueryResult.hpp.


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