Package io.micronaut.chatbots.telegram.api

Class ReplyKeyboardMarkup

java.lang.Object

io.micronaut.chatbots.telegram.api.ReplyKeyboardMarkup

public class ReplyKeyboardMarkup
extends java.lang.Object

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

See Also:

ReplyKeyboardMarkup

Constructor Summary

Constructors

Constructor	Description
ReplyKeyboardMarkup()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getInputFieldPlaceholder()
java.util.List<KeyboardButton>	getKeyboard()
java.lang.Boolean	getOneTimeKeyboard()
java.lang.Boolean	getResizeKeyboard()
java.lang.Boolean	getSelective()
void	setInputFieldPlaceholder(java.lang.String inputFieldPlaceholder)
void	setKeyboard(java.util.List<KeyboardButton> keyboard)
void	setOneTimeKeyboard(java.lang.Boolean oneTimeKeyboard)
void	setResizeKeyboard(java.lang.Boolean resizeKeyboard)
void	setSelective(java.lang.Boolean selective)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplyKeyboardMarkup

public ReplyKeyboardMarkup()

Method Detail

getKeyboard

@NonNull
public java.util.List<KeyboardButton> getKeyboard()

Returns:

Array of button rows, each represented by an Array of KeyboardButton objects.

setKeyboard

public void setKeyboard(@NonNull
                        java.util.List<KeyboardButton> keyboard)

Parameters:

keyboard - Array of button rows, each represented by an Array of KeyboardButton objects.

getResizeKeyboard

@Nullable
public java.lang.Boolean getResizeKeyboard()

Returns:

Requests clients to resize the keyboard vertically for optimal fit

setResizeKeyboard

public void setResizeKeyboard(@Nullable
                              java.lang.Boolean resizeKeyboard)

Parameters:

resizeKeyboard - Requests clients to resize the keyboard vertically for optimal fit

getOneTimeKeyboard

@Nullable
public java.lang.Boolean getOneTimeKeyboard()

Returns:

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

setOneTimeKeyboard

public void setOneTimeKeyboard(@Nullable
                               java.lang.Boolean oneTimeKeyboard)

Parameters:

oneTimeKeyboard - Requests clients to hide the keyboard as soon as it's been used.

getSelective

@Nullable
public java.lang.Boolean getSelective()

Returns:

Use this parameter if you want to show the keyboard to specific users only.

setSelective

public void setSelective(@Nullable
                         java.lang.Boolean selective)

Parameters:

selective - Use this parameter if you want to show the keyboard to specific users only.

getInputFieldPlaceholder

@Nullable
public java.lang.String getInputFieldPlaceholder()

Returns:

The placeholder to be shown in the input field when the keyboard is active; 1-64 characters.

setInputFieldPlaceholder

public void setInputFieldPlaceholder(@Nullable
                                     java.lang.String inputFieldPlaceholder)

Parameters:

inputFieldPlaceholder - The placeholder to be shown in the input field when the keyboard is active; 1-64 characters.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object