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( ) ​

Returns: Promise<boolean>

createMessageCollector( options ) ​

Creates a message collector to the current chat.

ParameterTypeDescription
optionsMessageCollectorOptionsThe options for the collector.

Returns: MessageCollector

asyncdelete( ) ​

Returns: Promise<boolean>

asyncedit( name, icon_custom_emoji_id ) ​

ParameterTypeDescription
name?string
icon_custom_emoji_id?string

Returns: Promise<boolean>

asyncreopen( ) ​

Returns: Promise<boolean>

asyncsend( method, packet, form_data ) ​

Sends a message to the current channel.

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

Returns: Promise<Message>

asyncsendInvoice( id ) ​

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

ParameterTypeDescription
idstringThe id of the invoice.

Returns: Promise<void | Message>

asyncsendText( text ) ​

Sends a text message to the current chat.

ParameterTypeDescription
textstringThe text content of the message.

Returns: Promise<Message>

asyncunpinAll( ) ​

Returns: Promise<boolean>