User class abstract

This object represents a Telegram user or bot.

Implemented types

• WithID

Available extensions

• GetUserChatID
• Mention

Annotations

• @freezed

Constructors

User({@JsonKey.new(name: 'id') required int id, @JsonKey.new(name: 'is_bot') required bool isBot, @JsonKey.new(name: 'first_name') required String firstName, @JsonKey.new(name: 'last_name') String? lastName, @JsonKey.new(name: 'username') String? username, @JsonKey.new(name: 'language_code') String? languageCode, @JsonKey.new(name: 'is_premium') bool? isPremium, @JsonKey.new(name: 'added_to_attachment_menu') bool? addedToAttachmentMenu, @JsonKey.new(name: 'can_join_groups') bool? canJoinGroups, @JsonKey.new(name: 'can_read_all_group_messages') bool? canReadAllGroupMessages, @JsonKey.new(name: 'supports_inline_queries') bool? supportsInlineQueries, @JsonKey.new(name: 'can_connect_to_business') bool? canConnectToBusiness, @JsonKey.new(name: 'has_main_web_app') bool? hasMainWebApp})

Creates a Telegram user or bot

const

factory

User.fromJson(Map<String, dynamic> json)

Creates a User from a JSON map

factory

Properties

addedToAttachmentMenu → bool?

Optional. True, if this user added the bot to the attachment menu

no setter, inherited

canConnectToBusiness → bool?

Optional. True, if the bot can be connected to a Telegram Business account to receive its messages. Returned only in getMe.

no setter, inherited

canJoinGroups → bool?

Optional. True, if the bot can be invited to groups. Returned only in getMe.

no setter, inherited

canReadAllGroupMessages → bool?

Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

no setter, inherited

copyWith → $UserCopyWith<User>

Create a copy of User with the given fields replaced by the non-null parameter values.

no setter, inherited

firstName → String

User's or bot's first name

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hasMainWebApp → bool?

Optional. True, if the bot has a main Web App. Returned only in getMe.

no setter, inherited

id → int

Unique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.

no setter, inherited

isBot → bool

True, if this user is a bot

no setter, inherited

isPremium → bool?

Optional. True, if this user is a Telegram Premium user

no setter, inherited

languageCode → String?

Optional. IETF language tag of the user's language

no setter, inherited

lastName → String?

Optional. User's or bot's last name

no setter, inherited

mention → UserMention

Available on User, provided by the Mention extension

Example: When you want to mention a user in a message, you can use this extension to represent the mention instead of manually creating the mention URL.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

supportsInlineQueries → bool?

Optional. True, if the bot supports inline queries. Returned only in getMe.

no setter, inherited

username → String?

Optional. User's or bot's username

no setter, inherited

Methods

getChannelId() → ID?

Available on User, provided by the GetUserChatID extension

Gets the chat's ChannelID from the username

getId() → ChatID

Available on User, provided by the GetUserChatID extension

Returns the ChatID of the chat.

isTheSameChat(ID chatId) → bool

Available on User, provided by the GetUserChatID extension

Returns true if the chatId passed matches the current chat's ID.

mentionWith(String text, {ParseMode parseMode = ParseMode.html}) → UserMention

Available on User, provided by the Mention extension

Returns a UserMention object with the passed text and parseMode.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes this User to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited