Class User

constructor

• new User(user: TypeUser): User

• Parameters

  • user: TypeUser

  Returns User

Readonlyraw

Readonlytype

botActiveUsers

• get botActiveUsers(): null | number

• Number of bot's active users, if available

  Returns null | number

color

• get color(): ChatColors

• Color that should be used when rendering replies to their messages and web previews sent by them, as well as to render the chat title

  Returns ChatColors

customVerificationEmojiId

• get customVerificationEmojiId(): null | Long

• If non-null, this user was verified by a bot, and this field contains the ID of the custom emoji to display as the verification icon.

  Returns null | Long

dcId

• get dcId(): null | number

• User's or bot's assigned DC (data center). Available only in case the user has set a public profile photo.

  Note: this information is approximate; it is based on where Telegram stores a user profile pictures and does not by any means tell you the user location (i.e. a user might travel far away, but will still connect to its assigned DC). More info at Pyrogram FAQ.

  Returns null | number

displayName

• get displayName(): string

• User's display name.

  First name and last name if available, only first name otherwise.

  Returns string

emojiStatus

• get emojiStatus(): null | EmojiStatus

• User's emoji status, if any.

  Returns null | EmojiStatus

firstName

• get firstName(): string

• User's or bot's first name

  Returns string

hasMainApp

• get hasMainApp(): boolean

• Whether this bot has a main app

  Returns boolean

id

• get id(): number

• Unique identifier for this user or bot

  Returns number

inputPeer

• get inputPeer(): TypeInputPeer

• Get this user's input peer for advanced use-cases.

  Note: for min users, this method will return mtcute.dummyInputPeerMinUser, which is actually not a valid input peer. These are used to indicate that the user is incomplete, and a message reference is needed to resolve the peer.

  Such objects are handled by TelegramClient.resolvePeer method, so prefer using it whenever you need an input peer.

  Returns TypeInputPeer

isBot

• get isBot(): boolean

• Whether this user is a bot

  Returns boolean

isBotAttachmentMenuEnabled

• get isBotAttachmentMenuEnabled(): boolean

• Whether this bot offers an attachment menu web app, and we have it enabled

  Returns boolean

isBotEditable

• get isBotEditable(): boolean

• Whether this bot can be edited by the current user

  Returns boolean

isBotWithAttachmentMenu

• get isBotWithAttachmentMenu(): boolean

• Whether this bot offers an attachment menu web app

  Returns boolean

isBotWithHistory

• get isBotWithHistory(): boolean

• Whether this user is a bot that has access to all messages

  Returns boolean

isBotWithInlineGeo

• get isBotWithInlineGeo(): boolean

• Whether this bot can request geolocation when used in inline mode

  Returns boolean

isBotWithoutChats

• get isBotWithoutChats(): boolean

• Whether this user is a bot that can't be added to chats

  Returns boolean

isBusinessBot

• get isBusinessBot(): boolean

• Whether this user is a bot that can be connected to a Telegram Business account to receive its messages

  Returns boolean

isCloseFriend

• get isCloseFriend(): boolean

• Whether this user is in yout "close friends" list

  Returns boolean

isContact

• get isContact(): boolean

• Whether this user is in your contacts

  Returns boolean

isDeleted

• get isDeleted(): boolean

• Whether this user is deleted

  Returns boolean

isFake

• get isFake(): boolean

• Whether this user has been flagged for impersonation

  Returns boolean

isMin

• get isMin(): boolean

• Whether this user's information is incomplete.

  This usually only happens in large chats, where the server sometimes sends only a part of the user's information. Basic info like name and profile photo are always available, but other fields may be omitted despite being available.

  For a rough list of fields that may be missing, see the official docs.

  This currently only ever happens for non-bot users, so if you are building a normal bot, you can safely ignore this field.

  To fetch the "complete" user information, use one of these methods:

  • TelegramClient.getUsers
  • TelegramClient.getChat
  • TelegramClient.getFullChat.

  Learn more: Incomplete peers

  Returns boolean

isMutualContact

• get isMutualContact(): boolean

• Whether you both have each other's contact

  Returns boolean

isPremium

• get isPremium(): boolean

• Whether this user has Premium subscription

  Returns boolean

isPremiumRequired

• get isPremiumRequired(): boolean

• Whether Premium is required to contact this user

  Returns boolean

isRestricted

• get isRestricted(): boolean

• Whether this user has been restricted. Bots only. See restrictionReason for details

  Returns boolean

isScam

• get isScam(): boolean

• Whether this user has been flagged for scam

  Returns boolean

isSelf

• get isSelf(): boolean

• Whether this user is you yourself

  Returns boolean

isSupport

• get isSupport(): boolean

• Whether this user is part of the Telegram support team

  Returns boolean

isVerified

• get isVerified(): boolean

• Whether this user has been verified by Telegram

  Returns boolean

language

• get language(): null | string

• IETF language tag of the user's language

  Only available in some contexts

  Returns null | string

lastName

• get lastName(): null | string

• User's or bot's last name

  Returns null | string

lastOnline

• get lastOnline(): null | Date

• Last time this user was seen online. Only available if status is offline

  Returns null | Date

nextOffline

• get nextOffline(): null | Date

• Time when this user will automatically go offline. Only available if status is online

  Returns null | Date

phoneNumber

• get phoneNumber(): null | string

• User's phone number

  Returns null | string

photo

• get photo(): null | ChatPhoto

• User's or bot's current profile photo, if any. Suitable for downloads only

  Returns null | ChatPhoto

profileColors

• get profileColors(): null | ChatColors

• Color that should be used when rendering the header of the user's profile

  If null, a generic header should be used instead

  Returns null | ChatColors

restrictionReason

• get restrictionReason(): RawRestrictionReason[]

• Reason why this bot was restricted

  Returns RawRestrictionReason[]

restrictions

• get restrictions(): null | readonly RawRestrictionReason[]

• The list of reasons why this bot might be unavailable to some users. This field is available only in case isRestricted is true

  Returns null | readonly RawRestrictionReason[]

status

• get status(): UserStatus

• User's Last Seen & Online status

  Returns UserStatus

statusHiddenByMe

• get statusHiddenByMe(): boolean

• Whether user's online status is hidden because we have hidden our own online status from them, and we don't have Premium subscription.

  Returns boolean

storiesHidden

• get storiesHidden(): boolean

• Whether you have hidden (arhived) this user's stories

  Returns boolean

storiesMaxId

• get storiesMaxId(): number

• Maximum ID of stories this user has (or 0 if none)

  Returns number

storiesUnavailable

• get storiesUnavailable(): boolean

• Returns boolean

username

• get username(): null | string

• User's or bot's username

  Returns null | string

usernames

• get usernames(): null | readonly RawUsername[]

• User's or bot's usernames (including collectibles)

  Returns null | readonly RawUsername[]

mention

• mention(text?: null | string): string | MessageEntity

• Create a mention for the user.

  When available and text is omitted, this method will return @username. Otherwise, text mention is created.

  Use null as text (first parameter) to force create a text mention with display name, even if there is a username.

  Note: This method doesn't format anything on its own. Instead, it returns a MessageEntity that can later be used with html or md template tags

  Parameters

  • Optionaltext: null | string

    Text of the mention.

  Returns string | MessageEntity

  Example

  msg.replyText(html`Hello, ${msg.sender.mention()`)
  Copy

permanentMention

• permanentMention(text?: null | string): MessageEntity

• Create a permanent mention for this user.

  Permanent* means that this mention will also contain user's access hash, so even if the user changes their username or the client forgets about that user, it can still be mentioned.

  Telegram might change access hash in some cases, so it may not exactly be permanent. The only way to actually make it permanent is to send it as a message somewhere and load it from there if needed.

  Note that some users (particularly, users with hidden forwards) may not be mentioned like this outside the chats you have in common.

  This method is only needed when the result will be stored somewhere outside current mtcute instance (e.g. saved for later use), otherwise mention will be enough.

  Note: This method doesn't format anything on its own. Instead, it returns a MessageEntity that can later be used with html or md template tags

  Note: the resulting text can only be used by clients that support mtcute notation of permanent mention links (tg://user?id=123&hash=abc).

  Also note that these permanent mentions are only valid for current account, since peer access hashes are account-specific and can't be used on another account.

  Also note that for some users such mentions might not work at all due to privacy settings.

  Parameters

  • Optionaltext: null | string

    Mention text

  Returns MessageEntity

StaticparseStatus

• parseStatus(status?: TypeUserStatus, bot?: boolean): UserParsedStatus

• Parameters

  • Optionalstatus: TypeUserStatus
  • bot: boolean = false

  Returns UserParsedStatus