de.raysha.lib.telegram.bot.api.model.ForceReply 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 display a reply interface to the user
 * (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if
 * you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.
 *
 * Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions).
 * There could be two ways to create a new poll:
 *
 * Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2).
 * May be appealing for hardcore users but lacks modern day polish.
 * Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first
 * answer option', 'Great. Keep adding answer options, then send /done when you're ready'.
 *
 * The last option is definitely more attractive. And if you use ForceReply in your bot's questions,
 * it will receive the user's answers even if it only receives replies,
 * commands and mentions -- without any extra work for the user.
 */
public class ForceReply {
    /**
     * Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'
     */
    private Boolean force_reply;

    /**
     * Optional. Use this parameter if you want to force reply from 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 getForce_reply() {
        return force_reply;
    }

    public void setForce_reply(Boolean force_reply) {
        this.force_reply = force_reply;
    }

    public Boolean getSelective() {
        return selective;
    }

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

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