Keyboard | /convenience/keyboard.ts | grammy@v1.31.0

method Keyboard.requestUsers

import { Keyboard } from "https://dotland.deno.dev/x/grammy@v1.31.0/convenience/keyboard.ts";

requestUsers(

text: string,

requestId: number,

options?: Omit<KeyboardButtonRequestUsers, "request_id">,

): KeyboardButton.RequestUsersButton

Creates a new request users button. When the user presses the button, a list of suitable users will be opened. Tapping on any number of users will send their identifiers to the bot in a “users_shared” service message. Available in private chats only.

Parameters

text: string

The text to display

requestId: number

A signed 32-bit identifier of the request

optional

options: Omit<KeyboardButtonRequestUsers, "request_id"> = [UNSUPPORTED]

Options object for further requirements

Returns

KeyboardButton.RequestUsersButton