Skip to content

export Class

ForumTopic ​

extends ​

ChatBase<ForumTopic, SerializedForumTopicPacket>

implements ​

SerializedForumTopicPacket

Constructor ​

ts
 new ForumTopic( client, packet )
ParameterTypeDescription
clientClient
packetSerializedForumTopicPacket

Properties ​

get chat : SuperGroupChat ​

get id : number ​

readonly client : Client ​

icon_color : number ​

icon_custom_emoji_id : string ​

message_thread_id : number ​

name : string ​

type : ForumType ​

Methods ​

asyncclose( ) ​

Close the current forum topic.

Returns: Promise<boolean>

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

asyncdelete( ) ​

Delete the current forum topic.

Returns: Promise<boolean>

asyncedit( name, icon_custom_emoji_id ) ​

ParameterTypeDescription
name?stringThe new name of the forum topic.
icon_custom_emoji_id?stringThe id of the new custom emoji of the forum topic.

Edit the current forum topic.

Returns: Promise<boolean>

asyncreopen( ) ​

Reopen the current forum topic.

Returns: Promise<boolean>

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>

asyncunpinAll( ) ​

Unpin all the messages of the current topic.

Returns: Promise<boolean>

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