pro.zackpollard.telegrambot.api.keyboards.ReplyKeyboardHide Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jtelegram-botapi Show documentation

The Java Telegram Bot API is a wrapper for the Telegram HTTP Bot API

There is a newer version: 1.6.5

package pro.zackpollard.telegrambot.api.keyboards;

import lombok.ToString;
import pro.zackpollard.telegrambot.api.chat.message.ReplyMarkupType;

/**
 * @author Zack Pollard
 */
@ToString
public class ReplyKeyboardHide implements Keyboard {

    private final boolean hide_keyboard = true;
    private boolean selective = false;

    private ReplyKeyboardHide(ReplyKeyboardHideBuilder builder) {

        this.selective = builder.selective;
    }

    /**
     * This builder will allow you to progressively construct this object.
     *
     * @return A ReplyKeyboardHideBuilder object used to construct the ReplyKeyboardHide object
     */
    public static ReplyKeyboardHideBuilder builder() {

        return new ReplyKeyboardHideBuilder();
    }

    /**
     * Gets whether the client is being requested to hide the custom keyboard
     *
     * @return True if the client is being requested to hide the custom keyboard, otherwise False
     */
    public boolean getHideKeyboard() {

        return hide_keyboard;
    }

    /**
     * Gets whether the reply markup will only show for selected users
     * 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.
     *
     * @return Selective option, default false
     */
    public boolean getSelective() {
        return selective;
    }

    /**
     * Gets the ReplyMarkupType for this ReplyMarkup object
     *
     * @return The ReplyMarkupType for this ReplyMarkup object
     */
    @Override
    public ReplyMarkupType getType() {
        return ReplyMarkupType.KEYBOARD_HIDE;
    }

    @ToString
    public static class ReplyKeyboardHideBuilder {

        private boolean selective = false;

        private ReplyKeyboardHideBuilder() {
        }

        /**
         * *Optional*
         * Sets whether the keyboard should be selective. Use this parameter if you want to hide keyboard for 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.
         *
         * @param selective True if the keyboard is selective, otherwise False
         *
         * @return The builder object
         */
        public ReplyKeyboardHideBuilder selective(boolean selective) {

            this.selective = selective;
            return this;
        }

        /**
         * Builds the ReplyKeyboardHide object
         *
         * @return A ReplyKeyboardHide object based on the previously provided values
         */
        public ReplyKeyboardHide build() {

            return new ReplyKeyboardHide(this);
        }
    }
}