@gramio/keyboards@1.2.1

Built and signed on GitHub Actions

Built and signed on GitHub Actions

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
import type { TelegramForceReply } from "jsr:@gramio/types@^8.1.0";

/**
 * **ForceReply** builder
 *
 * 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](https://core.telegram.org/bots/features#privacy-mode).
 *
 * {@link https://core.telegram.org/bots/api/#forcereply | [Documentation]}
 */
export class ForceReplyKeyboard {
	options: { isSelective: boolean; placeholder: string | undefined; } = {
		isSelective: false,
		placeholder: undefined as string | undefined,
	};

	/**
	 * Use this parameter if you want to force reply from specific users only. Targets: 1) users that are \@mentioned in the *text* of the [Message](https://core.telegram.org/bots/api/#message) object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.
	 * @example
	 * ```ts
	 * new ForceReplyKeyboard().selective(); // to enable
	 * new ForceReplyKeyboard().selective(false); // to disable
	 * ```
	 */
	selective(isEnabled: boolean = true): this {
		this.options.isSelective = isEnabled;

		return this;
	}

	/**
	 * The placeholder to be shown in the input field when the reply is active; 1-64 characters
	 * @example
	 * ```ts
	 * new Keyboard().placeholder("some text"); // to enable
	 * new Keyboard().placeholder(); // to disable
	 * ```
	 */
	placeholder(value?: string): this {
		this.options.placeholder = value;

		return this;
	}

	/**
	 * Return {@link TelegramForceReply} as JSON
	 */
	build(): TelegramForceReply {
		return this.toJSON();
	}

	/**
	 * Serializing a class into an {@link TelegramForceReply} object (used by JSON.stringify)
	 */
	toJSON(): TelegramForceReply {
		return {
			force_reply: true,
			selective: this.options.isSelective,
			input_field_placeholder: this.options.placeholder,
		};
	}
}