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

Inherits Function.

Description

Returns an HTTPS URL of a Web App to open from the side menu, a keyboardButtonTypeWebApp button, or an inlineQueryResultsButtonTypeWebApp button.

Returns object_ptr<WebAppUrl>.

Public Types

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

Public Member Functions

 getWebAppUrl ()
 getWebAppUrl (int53 bot_user_id_, string const &url_, 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 target bot. If the bot is restricted for the current user, then show an error instead of calling the method.
object_ptr< webAppOpenParameters > parameters_
 Parameters to use to open the Web App.
string url_
 The URL from a keyboardButtonTypeWebApp button, inlineQueryResultsButtonTypeWebApp button, or an empty string when the bot is opened from the side menu.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ getWebAppUrl() [1/2]

getWebAppUrl ( )

Default constructor for a function, which returns an HTTPS URL of a Web App to open from the side menu, a keyboardButtonTypeWebApp button, or an inlineQueryResultsButtonTypeWebApp button.

Returns object_ptr<WebAppUrl>.

◆ getWebAppUrl() [2/2]

getWebAppUrl ( int53 bot_user_id_,
string const & url_,
object_ptr< webAppOpenParameters > && parameters_ )

Creates a function, which returns an HTTPS URL of a Web App to open from the side menu, a keyboardButtonTypeWebApp button, or an inlineQueryResultsButtonTypeWebApp button.

Returns object_ptr<WebAppUrl>.

Parameters
[in]bot_user_id_Identifier of the target bot. If the bot is restricted for the current user, then show an error instead of calling the method.
[in]url_The URL from a keyboardButtonTypeWebApp button, inlineQueryResultsButtonTypeWebApp button, or an empty string when the bot is opened from the side menu.
[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: