TDLib
Loading...
Searching...
No Matches
openWebApp Class Referencefinal

Inherits Function.

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>.

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< MessageTopic > &&topic_id_, object_ptr< InputMessageReplyTo > &&reply_to_, object_ptr< webAppOpenParameters > &&parameters_)
void store (TlStorerToString &s, const char *field_name) const final
Public Member Functions inherited from TlObject
TlObject & operator= (const TlObject &)=delete
TlObject & operator= (TlObject &&)=default
virtual void store (TlStorerCalcLength &s) const
virtual void store (TlStorerUnsafe &s) const
 TlObject ()=default
 TlObject (const TlObject &)=delete
 TlObject (TlObject &&)=default
virtual ~TlObject ()=default

Public Attributes

int53 bot_user_id_
 Identifier of the bot, providing the Web App. If the bot is restricted for the current user, then show an error instead of calling the method.
int53 chat_id_
 Identifier of the chat in which the Web App is opened. The Web App can't be opened in secret chats.
object_ptr< webAppOpenParameters > parameters_
 Parameters to use to open the Web App.
object_ptr< InputMessageReplyTo > reply_to_
 Information about the message or story to be replied in the message sent by the Web App; pass null if none.
object_ptr< MessageTopic > topic_id_
 Topic in which the message will be sent; pass null if none.
string url_
 The URL from an inlineKeyboardButtonTypeWebApp button, a botMenuButton button, an internalLinkTypeAttachmentMenuBot link, or an empty string otherwise.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ openWebApp() [1/2]

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]

openWebApp ( int53 chat_id_,
int53 bot_user_id_,
string const & url_,
object_ptr< MessageTopic > && topic_id_,
object_ptr< InputMessageReplyTo > && reply_to_,
object_ptr< webAppOpenParameters > && parameters_ )

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. If the bot is restricted for the current user, then show an error instead of calling the method.
[in]url_The URL from an inlineKeyboardButtonTypeWebApp button, a botMenuButton button, an internalLinkTypeAttachmentMenuBot link, or an empty string otherwise.
[in]topic_id_Topic in which the message will be sent; pass null if none.
[in]reply_to_Information about the message or story to be replied in the message sent by the Web App; pass null if none.
[in]parameters_Parameters to use to open the Web App.

Member Function Documentation

◆ store()

void 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 TlObject.


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