GramIO API Reference / @gramio/contexts/dist / LoginUrl
Class: LoginUrl
Defined in: contexts/index.d.ts:2452
This object represents a parameter of the inline keyboard button used to automatically authorize a user.
Constructors
Constructor
new LoginUrl(
payload):LoginUrl
Defined in: contexts/index.d.ts:2454
Parameters
| Parameter | Type |
|---|---|
payload | TelegramLoginUrl |
Returns
LoginUrl
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramLoginUrl | contexts/index.d.ts:2453 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:2456
Returns
string
botUsername
Get Signature
get botUsername():
string
Defined in: contexts/index.d.ts:2478
Username of a bot, which will be used for user authorization. See Setting up a bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details.
Returns
string
forwardText
Get Signature
get forwardText():
string
Defined in: contexts/index.d.ts:2470
New text of the button in forwarded messages.
Returns
string
requestWriteAccess
Get Signature
get requestWriteAccess():
boolean
Defined in: contexts/index.d.ts:2483
Pass true to request the permission for your bot to send messages to the user.
Returns
boolean
url
Get Signature
get url():
string
Defined in: contexts/index.d.ts:2468
An HTTP URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provid authorization data, the original URL without information about the user will be opened. The data added is the same as described in Receiving authorization data.
NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in Checking authorization.
Returns
string