Class GroupContext

Constructors

constructor

new GroupContext(ctx: BaseContext): GroupContext
Parameters
- ctx: BaseContext
Returns GroupContext
- Defined in core/context/group-context.ts:27

Methods

answerChatJoinRequestQuery

answerChatJoinRequestQuery(
result: "approve" | "decline" | "queue",
queryId?: string,
): Promise<boolean>
Process a received chat join request query
Parameters
- result: "approve" | "decline" | "queue"
  Outcome ('approve', 'decline', or 'queue')
- OptionalqueryId: string
  Optional query ID. If omitted, resolved from the update.
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:541

approveChatJoinRequest

approveChatJoinRequest(userId: number): Promise<boolean>
Approve a request to join the chat
Parameters
- userId: number
  User ID
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:558

ban

ban(
userId: number,
options?: Omit<BanChatMemberParams, "chat_id" | "user_id">,
): Promise<boolean>
Ban a user from the group.
Parameters
- userId: number
  User ID
- Optionaloptions: Omit<BanChatMemberParams, "chat_id" | "user_id">
  Additional parameters
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:214

banChatSenderChat

banChatSenderChat(
senderChatId: number,
options?: Omit<BanChatSenderChatParams, "chat_id" | "sender_chat_id">,
): Promise<boolean>
Ban a channel from posting comments/interacting
Parameters
- senderChatId: number
  Sender channel ID to ban
- Optionaloptions: Omit<BanChatSenderChatParams, "chat_id" | "sender_chat_id">
  Additional parameters
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:285

closeForumTopic

closeForumTopic(messageThreadId?: number): Promise<boolean>
Close an open forum topic
Parameters
- OptionalmessageThreadId: number
  Thread ID. If omitted, resolved from the update.
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:83

closeGeneralForumTopic

closeGeneralForumTopic(): Promise<boolean>
Close the general topic in a supergroup

Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:136

createForumTopic

createForumTopic(
name: string,
options?: Omit<CreateForumTopicParams, "chat_id" | "name">,
): Promise<ForumTopic>
Create a new forum topic in a supergroup
Parameters
- name: string
  Topic name
- Optionaloptions: Omit<CreateForumTopicParams, "chat_id" | "name">
  Additional parameters
Returns Promise<ForumTopic>
Promise<ForumTopic>
- Defined in core/context/group-context.ts:45

createInviteLink

createInviteLink(
options?: Omit<CreateChatInviteLinkParams, "chat_id">,
): Promise<ChatInviteLink>
Create an additional invite link
Parameters
- Optionaloptions: Omit<CreateChatInviteLinkParams, "chat_id">
  Additional parameters
Returns Promise<ChatInviteLink>
Promise<ChatInviteLink>
- Defined in core/context/group-context.ts:592

declineChatJoinRequest

declineChatJoinRequest(userId: number): Promise<boolean>
Decline a request to join the chat
Parameters
- userId: number
  User ID
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:570

deleteAllMessageReactions

deleteAllMessageReactions(userId?: number): Promise<boolean>
Delete up to 10,000 recent reactions added by a specific user in the group
Parameters
- OptionaluserId: number
  User ID whose reactions will be removed. If omitted, resolved from the update.
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:505

deleteForumTopic

deleteForumTopic(messageThreadId?: number): Promise<boolean>
Delete a forum topic and all its messages
Parameters
- OptionalmessageThreadId: number
  Thread ID. If omitted, resolved from the update.
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:111

deleteMessage

deleteMessage(messageId?: number): Promise<boolean>
Delete a message in the group
Parameters
- OptionalmessageId: number
  Message ID to delete. If omitted, resolved from the update.
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:686

deleteMessageReaction

deleteMessageReaction(userId: number, messageId?: number): Promise<boolean>
Delete reactions applied by a specific user on a message
Parameters
- userId: number
  User ID who put the reaction
- OptionalmessageId: number
  Message ID. If omitted, resolved from the update.
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:485

deleteMessages

deleteMessages(messageIds: number[]): Promise<boolean>
Delete multiple messages in the group
Parameters
- messageIds: number[]
  Array of message IDs
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:702

deletePhoto

deletePhoto(): Promise<boolean>
Delete the group photo

Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:383

deleteStickerSet

deleteStickerSet(): Promise<boolean>
Delete the collective sticker set for the supergroup

Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:405

editForumTopic

editForumTopic(
    name?: string,
    messageThreadId?: number,
    options?: Omit<
        EditForumTopicParams,
        "chat_id"
        | "message_thread_id"
        | "name",
    >,
): Promise<boolean>
Edit a forum topic
Parameters
- Optionalname: string
  Optional new topic name (0-128 characters). If omitted, the current name is kept.
- OptionalmessageThreadId: number
  Thread ID. If omitted, resolved from the update.
- Optionaloptions: Omit<EditForumTopicParams, "chat_id" | "message_thread_id" | "name">
  Additional parameters
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:63

editGeneralForumTopic

editGeneralForumTopic(name: string): Promise<boolean>
Edit the general topic name in a supergroup
Parameters
- name: string
  New general topic name
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:125

editInviteLink

editInviteLink(
inviteLink: string,
options?: Omit<EditChatInviteLinkParams, "chat_id" | "invite_link">,
): Promise<ChatInviteLink>
Edit an invite link created by the bot
Parameters
- inviteLink: string
  Invite link to edit
- Optionaloptions: Omit<EditChatInviteLinkParams, "chat_id" | "invite_link">
  Additional parameters
Returns Promise<ChatInviteLink>
Promise<ChatInviteLink>
- Defined in core/context/group-context.ts:607

exportInviteLink

exportInviteLink(): Promise<string>
Export the group invite link

Returns Promise<string>
Promise<string>
- Defined in core/context/group-context.ts:581

getForumTopicIconStickers

getForumTopicIconStickers(): Promise<Sticker[]>
Get custom emoji stickers for forum topic icons

Returns Promise<Sticker[]>
Promise<Sticker[]>
- Defined in core/context/group-context.ts:200

hideGeneralForumTopic

hideGeneralForumTopic(): Promise<boolean>
Hide the general topic in a supergroup

Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:156

leave

leave(): Promise<boolean>
Leave the group.

Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:713

pin(
messageId?: number,
options?: Omit<PinChatMessageParams, "chat_id" | "message_id">,
): Promise<boolean>
Pin a message in the group header.
Parameters
- OptionalmessageId: number
  Message ID to pin (defaults to the current message if not specified)
- Optionaloptions: Omit<PinChatMessageParams, "chat_id" | "message_id">
  Additional parameters
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:640

promote

promote(
userId: number,
options?: Omit<PromoteChatMemberParams, "chat_id" | "user_id">,
): Promise<boolean>
Promote or demote a user in the group.
Parameters
- userId: number
  User ID
- Optionaloptions: Omit<PromoteChatMemberParams, "chat_id" | "user_id">
  Additional parameters
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:268

reopenForumTopic

reopenForumTopic(messageThreadId?: number): Promise<boolean>
Reopen a closed forum topic
Parameters
- OptionalmessageThreadId: number
  Thread ID. If omitted, resolved from the update.
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:97

reopenGeneralForumTopic

reopenGeneralForumTopic(): Promise<boolean>
Reopen the general topic in a supergroup

Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:146

restrict

restrict(
    userId: number,
    permissions: ChatPermissions,
    options?: Omit<
        RestrictChatMemberParams,
        "chat_id"
        | "user_id"
        | "permissions",
    >,
): Promise<boolean>
Restrict a user in the group.
Parameters
- userId: number
  User ID
- permissions: ChatPermissions
  New permissions
- Optionaloptions: Omit<RestrictChatMemberParams, "chat_id" | "user_id" | "permissions">
  Additional parameters
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:249

revokeInviteLink

revokeInviteLink(inviteLink: string): Promise<ChatInviteLink>
Revoke an invite link created by the bot
Parameters
- inviteLink: string
  Invite link to revoke
Returns Promise<ChatInviteLink>
Promise<ChatInviteLink>
- Defined in core/context/group-context.ts:623

sendChatJoinRequestWebApp

sendChatJoinRequestWebApp(webAppUrl: string, queryId?: string): Promise<boolean>
Show a Mini App to the user before deciding on their join request
Parameters
- webAppUrl: string
  Mini App URL to be opened
- OptionalqueryId: string
  Optional query ID. If omitted, resolved from the update.
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:523

sendDice

sendDice(
emoji?: string,
options?: Omit<SendDiceParams, "chat_id" | "emoji">,
): Promise<Message>
Send an interactive animated dice or other emoji games
Parameters
- Optionalemoji: string
  Emoji on which the dice throw animation is based (defaults to 🎲)
- Optionaloptions: Omit<SendDiceParams, "chat_id" | "emoji">
  Additional parameters
Returns Promise<Message>
Promise<Message>
- Defined in core/context/group-context.ts:444

sendPoll

sendPoll(
    question: string,
    options: string[] | InputPollOption[],
    params?: Omit<SendPollParams, "chat_id" | "question" | "options">,
): Promise<Message>
Send a poll/survey to the group
Parameters
- question: string
  Poll question
- options: string[] | InputPollOption[]
  Poll answer options (as strings or full InputPollOption objects)
- Optionalparams: Omit<SendPollParams, "chat_id" | "question" | "options">
  Additional parameters
Returns Promise<Message>
Promise<Message>
- Defined in core/context/group-context.ts:422

setAdministratorCustomTitle

setAdministratorCustomTitle(
userId: number,
customTitle: string,
): Promise<boolean>
Set a custom title for an administrator promoted by the bot
Parameters
- userId: number
  Admin user ID
- customTitle: string
  Custom title (max 16 characters)
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:314

setDescription

setDescription(description: string): Promise<boolean>
Change the description of the group
Parameters
- description: string
  New group description
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:360

setMessageReaction

setMessageReaction(
    reaction: ReactionType[],
    messageId?: number,
    options?: { is_big?: boolean },
): Promise<boolean>
Set a reaction or emoji on a message
Parameters
- reaction: ReactionType[]
  List of reaction types to apply
- OptionalmessageId: number
  Message ID. If omitted, resolved from the update.
- Optionaloptions: { is_big?: boolean }
  Additional parameters
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:462

setPermissions

setPermissions(
permissions: ChatPermissions,
options?: { use_independent_chat_permissions?: boolean },
): Promise<boolean>
Set default chat permissions for all users
Parameters
- permissions: ChatPermissions
  Default permissions
- Optionaloptions: { use_independent_chat_permissions?: boolean }
  Additional parameters (e.g. use_independent_chat_permissions)
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:328

setPhoto

setPhoto(photo: InputFile): Promise<boolean>
Change the photo of the group
Parameters
- photo: InputFile
  New group photo
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:372

setStickerSet

setStickerSet(stickerSetName: string): Promise<boolean>
Set a collective sticker set for the supergroup
Parameters
- stickerSetName: string
  Sticker set name
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:394

setTitle

setTitle(title: string): Promise<boolean>
Change the title of the group
Parameters
- title: string
  New group title
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:348

unban

unban(
userId: number,
options?: Omit<UnbanChatMemberParams, "chat_id" | "user_id">,
): Promise<boolean>
Unban a user from the group.
Parameters
- userId: number
  User ID
- Optionaloptions: Omit<UnbanChatMemberParams, "chat_id" | "user_id">
  Additional parameters
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:231

unbanChatSenderChat

unbanChatSenderChat(senderChatId: number): Promise<boolean>
Unban a previously banned channel
Parameters
- senderChatId: number
  Sender channel ID to unban
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:301

unhideGeneralForumTopic

unhideGeneralForumTopic(): Promise<boolean>
Unhide the general topic in a supergroup

Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:166

unpin

unpin(messageId?: number): Promise<boolean>
Unpin a message in the group.
Parameters
- OptionalmessageId: number
  Optional Message ID to unpin. If not specified, the latest pinned message is unpinned.
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:660

unpinAll

unpinAll(): Promise<boolean>
Unpin all pinned messages in the group

Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:675

unpinAllForumTopicMessages

unpinAllForumTopicMessages(messageThreadId?: number): Promise<boolean>
Unpin all messages in a forum topic
Parameters
- OptionalmessageThreadId: number
  Thread ID. If omitted, resolved from the update.
Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:177

unpinAllGeneralForumTopicMessages

unpinAllGeneralForumTopicMessages(): Promise<boolean>
Unpin all messages in the general topic

Returns Promise<boolean>
Promise<boolean>
- Defined in core/context/group-context.ts:190

Class GroupContext

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns GroupContext

Methods

answerChatJoinRequestQuery

Parameters

Returns Promise<boolean>

approveChatJoinRequest

Parameters

Returns Promise<boolean>

ban

Parameters

Returns Promise<boolean>

banChatSenderChat

Parameters

Returns Promise<boolean>

closeForumTopic

Parameters

Returns Promise<boolean>

closeGeneralForumTopic

Returns Promise<boolean>

createForumTopic

Parameters

Returns Promise<ForumTopic>

createInviteLink

Parameters

Returns Promise<ChatInviteLink>

declineChatJoinRequest

Parameters

Returns Promise<boolean>

deleteAllMessageReactions

Parameters

Returns Promise<boolean>

deleteForumTopic

Parameters

Returns Promise<boolean>

deleteMessage

Parameters

Returns Promise<boolean>

deleteMessageReaction

Parameters

Returns Promise<boolean>

deleteMessages

Parameters

Returns Promise<boolean>

deletePhoto

Returns Promise<boolean>

deleteStickerSet

Returns Promise<boolean>

editForumTopic

Parameters

Returns Promise<boolean>

editGeneralForumTopic

Parameters

Returns Promise<boolean>

editInviteLink

Parameters

Returns Promise<ChatInviteLink>

exportInviteLink

Returns Promise<string>

getForumTopicIconStickers

Returns Promise<Sticker[]>

hideGeneralForumTopic

Returns Promise<boolean>

leave

Returns Promise<boolean>

pin

Parameters

Returns Promise<boolean>

promote

Parameters

Returns Promise<boolean>

reopenForumTopic

Parameters

Returns Promise<boolean>