Telegram Bot Api Base
Back to top  

Class LoginUrlType This object represents a parameter of the inline keyboard button used to automatically authorize a user.

Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button.

see
package Default

 Methods

create() 

create(string $url, array|null $data = null) : \TgBotApi\BotApiBase\Type\LoginUrlType
Static

Parameters

$url

string

$data

arraynull

Exceptions

\TgBotApi\BotApiBase\Exception\BadArgumentException

Returns

\TgBotApi\BotApiBase\Type\LoginUrlType

fill() 

fill(array $data, array $forbidden = array()) 
Inherited

Parameters

$data

array

$forbidden

array

Exceptions

\TgBotApi\BotApiBase\Exception\BadArgumentException

 Properties

 

Optional. New text of the button in forwarded messages.

$botUsername : string

Default

 

Optional. Username of a bot, which will be used for user authorization. See Setting up a bot for more details.

$forwardText : string

Default

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.

 

Optional. Pass True to request the permission for your bot to send messages to the user.

$requestWriteAccess : boolean

Default

 

An HTTP URL to be opened with user authorization data added to the query string when the button is pressed.

$url : string

Default

If the user refuses to provide 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.