getExternalLink Class Reference

Inherits Function.

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. May return an empty link if just a toast about successful login has to be shown.

Returns object_ptr<HttpUrl>.

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_)
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
bool	allow_write_access_
	Pass true if the current user allowed the bot that was returned in getExternalLinkInfo, to send them messages.
string	link_
	The HTTP link.

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

Constructor & Destructor Documentation

getExternalLink() [1/2]

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. May return an empty link if just a toast about successful login has to be shown.

Returns object_ptr<HttpUrl>.

getExternalLink() [2/2]

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. May return an empty link if just a toast about successful login has to be shown.

Returns object_ptr<HttpUrl>.

Parameters

[in]	link_	The HTTP link.
[in]	allow_write_access_	Pass true if the current user allowed the bot that was returned in getExternalLinkInfo, to send them messages.

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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements TlObject.

---

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

• td/generate/auto/td/telegram/td_api.h