Module

x/grammy/types.ts>KeyboardButtonRequestChat

The Telegram Bot Framework.
grammyjs/grammY
Very Popular
Latest
interface KeyboardButtonRequestChat
import { type KeyboardButtonRequestChat } from "https://dotland.deno.dev/x/grammy@v1.31.0/types.ts";

This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate.

Properties

request_id: number

Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message

chat_is_channel: boolean

Pass True to request a channel chat, pass False to request a group or a supergroup chat.

optional
chat_is_forum: boolean

Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied.

optional
chat_has_username: boolean

Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied.

optional
chat_is_created: boolean

Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.

optional
user_administrator_rights: ChatAdministratorRights

An object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.

optional
bot_administrator_rights: ChatAdministratorRights

An object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied.

optional
bot_is_member: boolean

Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.

optional
request_title: boolean

Pass True to request the chat's title

optional
request_username: boolean

Pass True to request the chat's username

optional
request_photo: boolean

Pass True to request the chat's photo