Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/grammy_types/markup.ts

Type declarations of the Telegram Bot API.
Go to Latest
import * as grammyTypes from "https://deno.land/x/grammy_types@v3.5.1/markup.ts";

Interfaces

A placeholder, currently holds no information. Use BotFather to set up your game.

This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.

Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.

This object represents an inline keyboard that appears right next to the message it belongs to.

This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.

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

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.

This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in. Telegram apps support these buttons as of version 5.7.

This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).

Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).

This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.

Describes a Web App.

Type Aliases

This object represents one button of an inline keyboard. You must use exactly one of the optional fields.

This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_users, request_chat, request_contact, request_location, and request_poll are mutually exclusive.