LoginURL class abstract

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

Annotations
  • @freezed

Constructors

LoginURL({@JsonKey.new(name: 'url') required String url, @JsonKey.new(name: 'forward_text') String? forwardText, @JsonKey.new(name: 'bot_username') String? botUsername, @JsonKey.new(name: 'request_write_access') bool? requestWriteAccess})
Constructs a LoginURL object.
const
factory
LoginURL.fromJson(Map<String, dynamic> json)
Creates a LoginURL object from JSON object.
factory

Properties

botUsername → String?
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.
no setterinherited
copyWith → $LoginURLCopyWith<LoginURL>
Create a copy of LoginURL with the given fields replaced by the non-null parameter values.
no setterinherited
forwardText → String?
Optional. New text of the button in forwarded messages.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
requestWriteAccess → bool?
Optional. Pass True to request the permission for your bot to send messages to the user.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
url → String
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.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Serializes this LoginURL to a JSON map.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited