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

Inherits td::td_api::Function.

Public Types

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

Public Member Functions

 getExternalLink ()
 
 getExternalLink (string const &link_, bool allow_write_access_)
 
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

string link_
 The HTTP link.
 
bool allow_write_access_
 Pass true if the current user allowed the bot, returned in getExternalLinkInfo, to send them messages.
 

Static Public Attributes

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

Detailed Description

Returns an HTTP URL which can be used to automatically authorize the current user on a website after clicking an HTTP link. Use the method getExternalLinkInfo to find whether a prior user confirmation is needed.

Returns object_ptr<HttpUrl>.

Constructor & Destructor Documentation

◆ getExternalLink() [1/2]

td::td_api::getExternalLink::getExternalLink ( )

Default constructor for a function, which returns an HTTP URL which can be used to automatically authorize the current user on a website after clicking an HTTP link. Use the method getExternalLinkInfo to find whether a prior user confirmation is needed.

Returns object_ptr<HttpUrl>.

◆ getExternalLink() [2/2]

td::td_api::getExternalLink::getExternalLink ( string const &  link_,
bool  allow_write_access_ 
)

Creates a function, which returns an HTTP URL which can be used to automatically authorize the current user on a website after clicking an HTTP link. Use the method getExternalLinkInfo to find whether a prior user confirmation is needed.

Returns object_ptr<HttpUrl>.

Parameters
[in]link_The HTTP link.
[in]allow_write_access_Pass true if the current user allowed the bot, returned in getExternalLinkInfo, to send them messages.

Member Function Documentation

◆ get_id()

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

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements td::TlObject.

◆ store()

void td::td_api::getExternalLink::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: