TDLib
Loading...
Searching...
No Matches
td::td_api::openWebApp Class Referencefinal

Inherits td::td_api::Function.

Public Types

using ReturnType = object_ptr< webAppInfo >
 Typedef for the type returned by the function.
 

Public Member Functions

 openWebApp ()
 
 openWebApp (int53 chat_id_, int53 bot_user_id_, string const &url_, object_ptr< themeParameters > &&theme_, string const &application_name_, int53 message_thread_id_, object_ptr< MessageReplyTo > &&reply_to_)
 
std::int32_t get_id () const final
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Member Functions inherited from td::TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Public Attributes

int53 chat_id_
 Identifier of the chat in which the Web App is opened. The Web App can't be opened in secret chats.
 
int53 bot_user_id_
 Identifier of the bot, providing the Web App.
 
string url_
 The URL from an inlineKeyboardButtonTypeWebApp button, a botMenuButton button, an internalLinkTypeAttachmentMenuBot link, or an empty string otherwise.
 
object_ptr< themeParameterstheme_
 Preferred Web App theme; pass null to use the default theme.
 
string application_name_
 Short name of the application; 0-64 English letters, digits, and underscores.
 
int53 message_thread_id_
 If not 0, a message thread identifier in which the message will be sent.
 
object_ptr< MessageReplyToreply_to_
 Identifier of the replied message or story for the message sent by the Web App; pass null if none.
 

Static Public Attributes

static const std::int32_t ID = 3826202
 Identifier uniquely determining a type of the object.
 

Detailed Description

Informs TDLib that a Web App is being opened from the attachment menu, a botMenuButton button, an internalLinkTypeAttachmentMenuBot link, or an inlineKeyboardButtonTypeWebApp button. For each bot, a confirmation alert about data sent to the bot must be shown once.

Returns object_ptr<WebAppInfo>.

Constructor & Destructor Documentation

◆ openWebApp() [1/2]

td::td_api::openWebApp::openWebApp ( )

Default constructor for a function, which informs TDLib that a Web App is being opened from the attachment menu, a botMenuButton button, an internalLinkTypeAttachmentMenuBot link, or an inlineKeyboardButtonTypeWebApp button. For each bot, a confirmation alert about data sent to the bot must be shown once.

Returns object_ptr<WebAppInfo>.

◆ openWebApp() [2/2]

td::td_api::openWebApp::openWebApp ( int53  chat_id_,
int53  bot_user_id_,
string const &  url_,
object_ptr< themeParameters > &&  theme_,
string const &  application_name_,
int53  message_thread_id_,
object_ptr< MessageReplyTo > &&  reply_to_ 
)

Creates a function, which informs TDLib that a Web App is being opened from the attachment menu, a botMenuButton button, an internalLinkTypeAttachmentMenuBot link, or an inlineKeyboardButtonTypeWebApp button. For each bot, a confirmation alert about data sent to the bot must be shown once.

Returns object_ptr<WebAppInfo>.

Parameters
[in]chat_id_Identifier of the chat in which the Web App is opened. The Web App can't be opened in secret chats.
[in]bot_user_id_Identifier of the bot, providing the Web App.
[in]url_The URL from an inlineKeyboardButtonTypeWebApp button, a botMenuButton button, an internalLinkTypeAttachmentMenuBot link, or an empty string otherwise.
[in]theme_Preferred Web App theme; pass null to use the default theme.
[in]application_name_Short name of the application; 0-64 English letters, digits, and underscores.
[in]message_thread_id_If not 0, a message thread identifier in which the message will be sent.
[in]reply_to_Identifier of the replied message or story for the message sent by the Web App; pass null if none.

Member Function Documentation

◆ get_id()

std::int32_t td::td_api::openWebApp::get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements td::TlObject.

◆ store()

void td::td_api::openWebApp::store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements td::TlObject.


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