Class ReplyKeyboardMarkup
This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). See ReplyMarkupMaker for an easy way to create one of these
Inherited Members
Namespace: TelegramBotApi.Types.Markup
Assembly: TelegramBotApi.dll
Syntax
[JsonObject(MemberSerialization = MemberSerialization.OptIn, ItemNullValueHandling = NullValueHandling.Ignore)]
public class ReplyKeyboardMarkup : ReplyMarkupBase
Constructors
| Improve this Doc View SourceReplyKeyboardMarkup()
Initializes a new, empty instance of the ReplyKeyboardMarkup class
Declaration
public ReplyKeyboardMarkup()
ReplyKeyboardMarkup(KeyboardButton)
Initializes a new instance of the ReplyKeyboardMarkup class with only one button
Declaration
public ReplyKeyboardMarkup(KeyboardButton button)
Parameters
Type | Name | Description |
---|---|---|
KeyboardButton | button | The one button |
ReplyKeyboardMarkup(KeyboardButton[])
Initializes a new instance of the ReplyKeyboardMarkup class with only one row
Declaration
public ReplyKeyboardMarkup(KeyboardButton[] row)
Parameters
Type | Name | Description |
---|---|---|
KeyboardButton[] | row | The row of KeyboardButtons |
ReplyKeyboardMarkup(KeyboardButton[][])
Initializes a new instance of the ReplyKeyboardMarkup class with multiple rows
Declaration
public ReplyKeyboardMarkup(KeyboardButton[][] rows)
Parameters
Type | Name | Description |
---|---|---|
KeyboardButton[][] | rows | The rows of KeyboardButtons |
Properties
| Improve this Doc View SourceKeyboard
Array of button rows, each represented by an Array of KeyboardButton objects
Declaration
[JsonProperty(PropertyName = "keyboard", Required = Required.Always)]
public KeyboardButton[][] Keyboard { get; set; }
Property Value
Type | Description |
---|---|
KeyboardButton[][] |
OneTimeKeyboard
Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again. Defaults to false.
Declaration
[JsonProperty(PropertyName = "one_time_keyboard")]
public bool OneTimeKeyboard { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ResizeKeyboard
Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.
Declaration
[JsonProperty(PropertyName = "resize_keyboard")]
public bool ResizeKeyboard { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Selective
Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.
Declaration
[JsonProperty(PropertyName = "selective")]
public bool Selective { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Operators
| Improve this Doc View SourceImplicit(KeyboardButton to ReplyKeyboardMarkup)
Converts an InlineKeyboardButton to a markup
Declaration
public static implicit operator ReplyKeyboardMarkup(KeyboardButton button)
Parameters
Type | Name | Description |
---|---|---|
KeyboardButton | button | The button |
Returns
Type | Description |
---|---|
ReplyKeyboardMarkup |
Implicit(KeyboardButton[] to ReplyKeyboardMarkup)
Converts an InlineKeyboardButton row to a markup
Declaration
public static implicit operator ReplyKeyboardMarkup(KeyboardButton[] row)
Parameters
Type | Name | Description |
---|---|---|
KeyboardButton[] | row | The button row |
Returns
Type | Description |
---|---|
ReplyKeyboardMarkup |
Implicit(KeyboardButton[][] to ReplyKeyboardMarkup)
Converts InlineKeyboardButton rows to a markup
Declaration
public static implicit operator ReplyKeyboardMarkup(KeyboardButton[][] rows)
Parameters
Type | Name | Description |
---|---|---|
KeyboardButton[][] | rows | The button rows |
Returns
Type | Description |
---|---|
ReplyKeyboardMarkup |