Skip to main content
Module

x/grammy_hydrate/deps.deno.ts>KeyboardButtonRequestUsers

Hydration plugin for API calls and context objects.
grammyjs/hydrate
Latest
interface KeyboardButtonRequestUsers
import { type KeyboardButtonRequestUsers } from "https://deno.land/x/grammy_hydrate@v1.4.1/deps.deno.ts";

This object defines the criteria used to request suitable users. The identifiers of the selected users will be shared with the bot when the corresponding button is pressed.

Properties

request_id: number

Signed 32-bit identifier of the request that will be received back in the UsersShared object. Must be unique within the message

optional
user_is_bot: boolean

Pass True to request bots, pass False to request regular users. If not specified, no additional restrictions are applied.

optional
user_is_premium: boolean

Pass True to request premium users, pass False to request non-premium users. If not specified, no additional restrictions are applied.

optional
max_quantity: boolean

The maximum number of users to be selected; 1-10. Defaults to 1.