Very Popular
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267import { KeyboardButton, InlineKeyboardButton, LoginUrl } from '../platform.ts'
/** * Use this class to simplify building a keyboard (something like this: * https://core.telegram.org/bots#keyboards). * * ```ts * // Build a keyboard: * const keyboard = new Keyboard() * .text('A').text('B').row() * .text('C').text('D') * * // Now you can either pass it directly: * ctx.reply('text', { * reply_markup: keyboard * }) * // Or if you need to specify more options in `reply_markup`: * ctx.reply('text', { * reply_markup: { * parse_mode: 'HTML', * keyboard: keyboard.build(), // note the `build` call * } * }) * ``` */export class Keyboard { /** * The nested array that holds the keyboard. It will be extended every time * you call one of the provided methods. */ public readonly keyboard: KeyboardButton[][] = [[]]
/** * Allows you to add your own `KeyboardButton` objects if you already have * them for some reason. You most likely want to call one of the other * methods. * * @param buttons the buttons to add */ add(...buttons: KeyboardButton[]) { this.keyboard[this.keyboard.length - 1]?.push(...buttons) return this } /** * Adds a 'line break'. Call this method to make sure that the next added * buttons will be on a new row. * * You may pass a number of `KeyboardButton` objects if you already have the * instances for some reason. You most likely don't want to pass any * arguments to `row`. * * @param buttons a number of buttons to add to the next row */ row(...buttons: KeyboardButton[]) { this.keyboard.push(buttons) return this } /** * Adds a new text button. This button will simply send the given text as a * text message back to your bot if a user clicks on it. * * @param text the text to display */ text(text: string) { return this.add({ text }) } /** * Adds a new contact request button. The user's phone number will be sent * as a contact when the button is pressed. Available in private chats only. * * @param text the text to display */ requestContact(text: string) { return this.add({ text, request_contact: true }) } /** * Adds a new location request button. The user's current location will be * sent when the button is pressed. Available in private chats only. * * @param text the text to display */ requestLocation(text: string) { return this.add({ text, request_location: true }) } /** * Adds a new poll request button. The user will be asked to create a poll * and send it to the bot when the button is pressed. Available in private * chats only. * * @param text the text to display * @param type the type of permitted polls to create, omit if the user may send a poll of any type */ requestPoll(text: string, type?: 'quiz' | 'regular') { return this.add({ text, request_poll: { type } }) } /** * Return the resulting keyboard that was built. May be called in the end if * necessary so you can specify more options in `reply_markup`. */ build() { return this.keyboard }}
/** * Use this class to simplify building an inline keyboard (something like this: * https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating). * * ```ts * // Build an inline keyboard: * const keyboard = new InlineKeyboard() * .text('A').text('B', 'callack-data').row() * .text('C').text('D').row() * .url('Telegram', 'telegram.org') * * // Now you can either pass it directly: * ctx.reply('text', { * reply_markup: keyboard * }) * // Or if you need to specify more options in `reply_markup`: * ctx.reply('text', { * reply_markup: { * parse_mode: 'HTML', * inline_keyboard: keyboard.build(), // note the `build` call * } * }) * ``` */export class InlineKeyboard { /** * The nested array that holds the inline keyboard. It will be extended * every time you call one of the provided methods. */ public readonly inline_keyboard: InlineKeyboardButton[][] = [[]]
/** * Allows you to add your own `InlineKeyboardButton` objects if you already * have them for some reason. You most likely want to call one of the other * methods. * * @param buttons the buttons to add */ add(...buttons: InlineKeyboardButton[]) { this.inline_keyboard[this.inline_keyboard.length - 1]?.push(...buttons) return this } /** * Adds a 'line break'. Call this method to make sure that the next added * buttons will be on a new row. * * You may pass a number of `InlineKeyboardButton` objects if you already * have the instances for some reason. You most likely don't want to pass * any arguments to `row`. * * @param buttons a number of buttons to add to the next row */ row(...buttons: InlineKeyboardButton[]) { this.inline_keyboard.push(buttons) return this } /** * Adds a new URL button. Telegram clients will open the provided URL when * the button is pressed. * * @param text the text to display * @param url HTTP or tg:// url to be opened when button is pressed */ url(text: string, url: string) { return this.add({ text, url }) } /** * Adds a new login button. This can be used as a replacement for the * Telegram Login Widget. You must specify an HTTP URL used to automatically * authorize the user. * * @param text the text to display * @param loginUrl the login URL as string or `LoginUrl` object */ login(text: string, loginUrl: string | LoginUrl) { return this.add({ text, login_url: typeof loginUrl === 'string' ? { url: loginUrl } : loginUrl, }) } /** * Adds a new callback query button. The button contains a text and a custom * payload. This payload will be sent back to your bot when the button is * pressed. If you omit the payload, the display text will be sent back to * your bot. * * Your bot will receive an update every time a user presses any of the text * buttons. You can listen to these updates like this: * ```ts * bot.on('callback_query:data', ctx => { ... }) * ``` * * @param text the text to display * @param data the callback data to send back to your bot (default = text) */ text(text: string, data = text) { return this.add({ text, callback_data: data }) } /** * Adds a new inline query button. Telegram clients will let the user pick a * chat when this button is pressed. This will start an inline query. The * selected chat will be prefilled with the name of your bot. You may * provide a text that is specified along with it. * * Your bot will in turn receive updates for inline queries. You can listen * to inline query updates like this: * ```ts * bot.on('inline_query', ctx => { ... }) * ``` * * @param text the text to display * @param query the (optional) inline query string to prefill */ switchInline(text: string, query = '') { return this.add({ text, switch_inline_query: query }) } /** * Adds a new inline query button that act on the current chat. The selected * chat will be prefilled with the name of your bot. You may provide a text * that is specified along with it. This will start an inline query. * * Your bot will in turn receive updates for inline queries. You can listen * to inline query updates like this: * ```ts * bot.on('inline_query', ctx => { ... }) * ``` * * @param text the text to display * @param query the (optional) inline query string to prefill */ switchInlineCurrent(text: string, query = '') { return this.add({ text, switch_inline_query_current_chat: query }) } /** * Adds a new game query button, confer https://core.telegram.org/bots/api#games * * This type of button must always be the first button in the first row. * * @param text the text to display */ game(text: string) { return this.add({ text, callback_game: {} }) } /** * Adds a new payment button, confer https://core.telegram.org/bots/api#payments * * This type of button must always be the first button in the first row. * * @param text the text to display */ pay(text: string) { return this.add({ text, pay: true }) } /** * Return the resulting inline keyboard that was built. May be called in the * end if necessary so you can specify more options in `reply_markup`. */ build() { return this.inline_keyboard }}