Skip to content

export Class

User ​

extends ​

ChatBase<User, UserPacket>

implements ​

UserPacket

Constructor ​

ts
 new User( client, packet )
ParameterTypeDescription
clientClient
packetUserPacket

Properties ​

added_to_attachment_menu? : boolean ​

can_connect_to_business? : boolean ​

can_read_all_group_messages? : boolean ​

readonly client : Client ​

first_name? : string ​

has_main_web_app? : boolean ​

id : number ​

is_bot? : boolean ​

is_premium? : boolean ​

language_code? : string ​

last_name? : string ​

message_thread_id? : number ​

supports_inline_queries? : boolean ​

username? : string ​

Methods ​

asyncboosts( chat_id ) ​

ParameterTypeDescription
chat_idnumber

Returns: Promise<boolean | ChatBoost[]>

createCallbackCollector( options ) ​

ParameterTypeDescription
options?CallbackCollectorOptionsThe options for the collector.

Creates a callback query collector to the current chat.

Returns: CallbackCollector

createMessageCollector( options ) ​

ParameterTypeDescription
options?MessageCollectorOptionsThe options for the collector.

Creates a message collector to the current chat.

Returns: MessageCollector

asyncgetProfilePhotos( offset, limit ) ​

ParameterTypeDescription
offset?number
limit?number

Returns: Promise<UserProfilePhotos>

asyncsend( method, packet, form ) ​

ParameterTypeDescription
methodMessagePayloadMethodThe method of the message.
packetMessagePayloadThe packet of what the message will contain.
form?FormDataBuilderThe form data for uploading media, see also File .

Sends a message to the current channel.

Returns: Promise<false | Message>

asyncsendInvoice( id ) ​

ParameterTypeDescription
idstringThe id of the invoice.

Sends the stored invoice with the id to the current chat.

Returns: Promise<null | Message>

asyncsendText( text ) ​

ParameterTypeDescription
textstringThe text content of the message.

Sends a text message to the current chat.

Returns: Promise<false | Message>

A modern, powerful library for building your Telegram bots, with seamless support for both JavaScript and Typescript.