de.raysha.lib.telegram.bot.api.model.ReplyKeyboardHide Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bot-api Show documentation

This is an java library for the Telegram-Bot-API. The Bot-API is an HTTP-based interface created for developers keen on building bots for Telegram.

There is a newer version: 2.1

Show newest version

package de.raysha.lib.telegram.bot.api.model;

import org.codehaus.jackson.map.annotate.JsonSerialize;

/**
 * Upon receiving a message with this object, Telegram clients will hide the current custom
 * keyboard and display the default letter-keyboard. By default, custom keyboards are
 * displayed until a new keyboard is sent by a bot. An exception is made for one-time
 * keyboards that are hidden immediately after the user presses a button
 * ({@link ReplyKeyboardMarkup}).
 *
 * Example: A user votes in a poll, bot returns confirmation message in reply to the vote and
 * hides keyboard for that user, while still showing the keyboard with poll options to users
 * who haven't voted yet.
 */
public class ReplyKeyboardHide {
    /**
     * Requests clients to hide the custom keyboard
     */
    private Boolean hide_keyboard;

    /**
     * Optional. 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.
     */
    @JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)
    private Boolean selective;

    public Boolean getHide_keyboard() {
        return hide_keyboard;
    }

    public void setHide_keyboard(Boolean hide_keyboard) {
        this.hide_keyboard = hide_keyboard;
    }

    public Boolean getSelective() {
        return selective;
    }

    public void setSelective(Boolean selective) {
        this.selective = selective;
    }

    @Override
    public String toString() {
        return "ReplyKeyboardHide{" +
                "hide_keyboard=" + hide_keyboard +
                ", selective=" + selective +
                '}';
    }
}