LoginUrl

data class LoginUrl(url: String, forwardText: String?, botUsername: String?, requestWriteAccess: Boolean)

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 and confirm that they want to log in: Telegram apps support these buttons as of version 5.7. Sample bot: @discussbot

Parameters

url

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 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.

forwardText

Optional. New text of the button in forwarded messages.

botUsername

Optional. 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.

requestWriteAccess

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

Constructors

LoginUrl

common

fun LoginUrl(url: String, forwardText: String? = null, botUsername: String? = null, requestWriteAccess: Boolean = false)

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

Functions

component1

common

operator fun component1(): String

component2

common

operator fun component2(): String?

component3

common

operator fun component3(): String?

component4

common

operator fun component4(): Boolean

copy

common

fun copy(url: String, forwardText: String? = null, botUsername: String? = null, requestWriteAccess: Boolean = false): LoginUrl

equals

common

open operator override fun equals(other: Any?): Boolean

hashCode

common

open override fun hashCode(): Int

toString

common

open override fun toString(): String

Properties

botUsername

common

val botUsername: String? = null

Optional.

forwardText

common

val forwardText: String? = null

Optional.

requestWriteAccess

common

val requestWriteAccess: Boolean = false

Optional.

url

common

val url: String

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