Skip to content

export Class

GroupChat ​

extends ​

BaseGroupChat

Constructor ​

ts
new GroupChat( client, packet )
ParameterTypeDescription
clientClient
packetChatPacket

Properties ​

get partial : boolean ​

readonly client : Client ​

id : number ​

invites : ChatInviteLinksManager ​

last_message_id? : number ​

members : MembersManager ​

message_thread_id? : number ​

messages : MessagesManager ​

photo? : ChatPhoto ​

requests : ChatRequestsManager ​

type : "channel" | "group" | "supergroup" ​

Methods ​

asyncadministrators( ) ​

Returns: Promise<Member[]>

createMessageCollector( options ) ​

Creates a message collector to the current chat.

ParameterTypeDescription
optionsMessageCollectorOptionsThe options for the collector.

Returns: MessageCollector

asyncdeletePhoto( ) ​

Returns: Promise<boolean>

asyncdeleteStickerSet( ) ​

Returns: Promise<boolean>

asyncfetch( ) ​

Returns: Promise<boolean | BaseChat>

asyncleave( ) ​

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>

asyncsetDescription( description ) ​

ParameterTypeDescription
descriptionstring

Returns: Promise<boolean>

asyncsetPhoto( photo, form ) ​

ParameterTypeDescription
photoInputFile
form?FormData

Returns: Promise<boolean>

asyncsetStrickerSet( sticker_set_name ) ​

ParameterTypeDescription
sticker_set_namestring

Returns: Promise<boolean>

asyncsetTitle( title ) ​

ParameterTypeDescription
titlestring

Returns: Promise<boolean>