Class User

Hierarchy (view full)

Constructors

constructor

Properties

firstName id inAttachmentMenu? isBot isPremium? language? lastName? username?

Accessors

client

Methods

_clone _patch _update equals fetch getProfilePhotos refundStarPayment setPassportErrors valueOf

Constructors

constructor

Properties

firstName

firstName: string

User's or bot's first name

id

id: string

Unique identifier for this user or bot.

OptionalinAttachmentMenu

inAttachmentMenu?: boolean

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

isBot

isBot: boolean

True, if this user is a bot

OptionalisPremium

isPremium?: boolean

True, if this user is a Telegram Premium user

Optionallanguage

language?: string

IETF language tag of the user's language

OptionallastName

lastName?: string

User's or bot's last name

Optionalusername

username?: string

User's or bot's username

Accessors

client

Methods

Protected_clone

_patch

  • _patch(data): User | UserFromGetMe

  • Parameters

    • data: User | UserFromGetMe

      represents a Telegram user or bot

    Returns User | UserFromGetMe

Protected_update

  • _update(data): Base
  • Protected

    Updates the current instance with new data and returns a clone of the updated instance

    Parameters

    • data: Record<string, any>

      The data to update the instance with

    Returns Base

    A clone of the updated instance

equals

  • equals(other): boolean

  • Checks if this user is equal to another user.

    Parameters

    Returns boolean

    True if both objects are instances of User and are equal based on key properties, otherwise false.

fetch

  • fetch(force?): Promise<User>

  • Fetches this user

    Parameters

    • Optionalforce: boolean

      Whether to skip the cache check and request the API

    Returns Promise<User>

getProfilePhotos

  • getProfilePhotos(offset?, limit?): Promise<UserProfilePhotos>

  • Use this method to get a list of profile pictures for a user.

    Parameters

    • Optionaloffset: number

      Sequential number of the first photo to be returned. By default, all photos are returned

    • Optionallimit: number

      Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100

    Returns Promise<UserProfilePhotos>

    Returns a UserProfilePhotos object.

refundStarPayment

  • refundStarPayment(telegramPaymentId): Promise<true>

  • Refunds a successful payment in Telegram Stars.

    Parameters

    • telegramPaymentId: string

      Telegram payment identifier

    Returns Promise<true>

    Returns True on success.

setPassportErrors

  • setPassportErrors(errors): Promise<true>

  • Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change).

    Parameters

    Returns Promise<true>

    Returns True on success.

valueOf

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods