class Hamilton::Types::LoginUrl

Hamilton::Types::LoginUrl
Reference
Object

Overview

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.

Included Modules

Hamilton::Types::Common
JSON::Serializable

Defined in:

types/login_url.cr

Constructors

.new(pull : JSON::PullParser)
.new(params)
.new(*, __pull_for_json_serializable pull : JSON::PullParser)
.new(**params)

Instance Method Summary

#bot_username : String | Nil
Username of a bot, which will be used for user authorization.
#bot_username=(bot_username : String | Nil)
Username of a bot, which will be used for user authorization.
#forward_text : String | Nil
New text of the button in forwarded messages.
#forward_text=(forward_text : String | Nil)
New text of the button in forwarded messages.
#non_nil_fields : Array(String)
List of available non-nil fields.
#non_nil_fields=(non_nil_fields : Array(String))
List of available non-nil fields.
#request_write_access : Bool | Nil
Pass True to request the permission for your bot to send messages to the user.
#request_write_access=(request_write_access : Bool | Nil)
Pass True to request the permission for your bot to send messages to the user.
#url : String
An HTTPS URL to be opened with user authorization data added to the query string when the button is pressed.
#url=(url : String)
An HTTPS URL to be opened with user authorization data added to the query string when the button is pressed.

Instance methods inherited from class `Reference`

Instance methods inherited from class `Object`

Constructor Detail

def self.new(pull : JSON::PullParser) #

def self.new(params) #

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

def self.new(**params) #

Instance Method Detail

def bot_username : String | Nil #

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.

def bot_username=(bot_username : String | Nil) #

def forward_text : String | Nil #

New text of the button in forwarded messages.

def forward_text=(forward_text : String | Nil) #

New text of the button in forwarded messages.

def non_nil_fields : Array(String) #

List of available non-nil fields.

def non_nil_fields=(non_nil_fields : Array(String)) #

List of available non-nil fields.

def request_write_access : Bool | Nil #

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

def request_write_access=(request_write_access : Bool | Nil) #

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

def url : String #

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

def url=(url : String) #