com.antonioaltieri.telegram.botapi.types

Class ReplyKeyboardMarkup.Builder

java.lang.Object

com.antonioaltieri.telegram.botapi.types.ReplyKeyboardMarkup.Builder

Enclosing class:

ReplyKeyboardMarkup

public static class ReplyKeyboardMarkup.Builder
extends java.lang.Object

A convenience Builder for this class. An example:

 ReplyKeyboardMarkup markup = new ReplyKeyboardMarkup.Builder()
                                          .row("A", "B", "C")
                                          .row("D")
                                          .row("E", "F")
                                          .build();
 
 

Constructor Summary

Constructors

Constructor and Description
ReplyKeyboardMarkup.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
ReplyKeyboardMarkup.Builder	add(int width, java.lang.String... buttons) Adds all buttons with a maximum width per row.
ReplyKeyboardMarkup	build() Builds the ReplyKeyboardMarkup object.
ReplyKeyboardMarkup.Builder	row(java.lang.String... buttons) Adds a row of "buttons" to the keyboard.
ReplyKeyboardMarkup.Builder	setOneTimeKeyboard() Requests clients to hide the keyboard as soon as it's been used.
ReplyKeyboardMarkup.Builder	setResizeKeyboard() Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons).
ReplyKeyboardMarkup.Builder	setSelective() Use this parameter if you want to show the keyboard to specific users only.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReplyKeyboardMarkup.Builder

public ReplyKeyboardMarkup.Builder()

Method Detail

row

public ReplyKeyboardMarkup.Builder row(java.lang.String... buttons)

Adds a row of "buttons" to the keyboard.

Parameters:

buttons - the row of buttons, represented as a String array.

Returns:

This Builder instance, to allow method chaining.

add

public ReplyKeyboardMarkup.Builder add(int width,
                              java.lang.String... buttons)

Adds all buttons with a maximum width per row.

Parameters:

width - The maximum amount of buttons per row.

buttons - The buttons to add.

Returns:

This Builder instance, to allow method chaining.

setResizeKeyboard

public ReplyKeyboardMarkup.Builder setResizeKeyboard()

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.

Returns:

This Builder instance, to allow method chaining.

setOneTimeKeyboard

public ReplyKeyboardMarkup.Builder setOneTimeKeyboard()

Requests clients to hide the keyboard as soon as it's been used. Defaults to false.

Returns:

This Builder instance, to allow method chaining.

setSelective

public ReplyKeyboardMarkup.Builder setSelective()

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.

Returns:

This Builder instance, to allow method chaining.

build

public ReplyKeyboardMarkup build()

Builds the ReplyKeyboardMarkup object.

Returns:

The freshly created ReplyKeyboardMarkup