TDLightTelegramBots/telegrambots-meta/src/main/java/org/telegram/telegrambots/meta/api/methods/send/SendDice.java

125 lines
4.6 KiB
Java
Raw Normal View History

2020-04-01 10:10:13 +02:00
package org.telegram.telegrambots.meta.api.methods.send;
import com.fasterxml.jackson.annotation.JsonProperty;
2020-11-01 23:46:36 +01:00
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.NonNull;
import lombok.RequiredArgsConstructor;
import lombok.Setter;
import lombok.ToString;
2022-06-14 22:20:22 +02:00
import lombok.experimental.Tolerate;
2022-06-16 19:57:41 +02:00
import org.telegram.telegrambots.meta.api.methods.botapimethods.BotApiMethodMessage;
2020-04-01 10:10:13 +02:00
import org.telegram.telegrambots.meta.api.objects.replykeyboard.ReplyKeyboard;
import org.telegram.telegrambots.meta.exceptions.TelegramApiValidationException;
2020-06-04 23:18:36 +02:00
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
2020-04-01 10:10:13 +02:00
/**
* @author Ruben Bermudez
* @version 4.7
2020-06-04 23:18:36 +02:00
* Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
2020-04-01 10:10:13 +02:00
*/
2020-11-01 23:46:36 +01:00
@EqualsAndHashCode(callSuper = false)
@Getter
@Setter
@ToString
@RequiredArgsConstructor
@NoArgsConstructor
@AllArgsConstructor
@Builder
2022-06-16 19:36:20 +02:00
public class SendDice extends BotApiMethodMessage {
2021-03-09 11:59:28 +01:00
private static final List<String> VALIDEMOJIS = Collections.unmodifiableList(Arrays.asList("🎲", "🎯", "🏀", "", "🎳", "🎰"));
2020-06-04 23:18:36 +02:00
2020-04-01 10:10:13 +02:00
public static final String PATH = "sendDice";
private static final String CHATID_FIELD = "chat_id";
2022-11-08 19:33:50 +01:00
private static final String MESSAGETHREADID_FIELD = "message_thread_id";
2020-04-24 10:03:23 +02:00
private static final String EMOJI_FIELD = "emoji";
2020-04-01 10:10:13 +02:00
private static final String DISABLENOTIFICATION_FIELD = "disable_notification";
private static final String REPLYTOMESSAGEID_FIELD = "reply_to_message_id";
private static final String REPLYMARKUP_FIELD = "reply_markup";
2020-11-01 23:46:36 +01:00
private static final String ALLOWSENDINGWITHOUTREPLY_FIELD = "allow_sending_without_reply";
2022-01-02 00:06:28 +01:00
private static final String PROTECTCONTENT_FIELD = "protect_content";
2020-04-01 10:10:13 +02:00
/**
* Unique identifier for the target chat or username of the target channel (in the format @channelusername)
*/
2020-04-01 10:10:13 +02:00
@JsonProperty(CHATID_FIELD)
2020-11-01 23:46:36 +01:00
@NonNull
private String chatId;
2022-11-08 19:33:50 +01:00
/**
* Unique identifier for the target message thread (topic) of the forum;
* for forum supergroups only
*/
@JsonProperty(MESSAGETHREADID_FIELD)
private Integer messageThreadId;
2020-06-04 23:18:36 +02:00
/**
2021-03-09 11:59:28 +01:00
* Optional.
*
2020-11-01 23:46:36 +01:00
* Emoji on which the dice throw animation is based.
2021-03-09 11:59:28 +01:00
*
* Currently, must be one of 🎲, 🎯, 🏀, , 🎳, or 🎰.
*
* Dice can have values 1-6 for 🎲, 🎯 and 🎳, values 1-5 for 🏀 and , and values 1-64 for 🎰.
*
2020-11-01 23:46:36 +01:00
* Defaults to 🎲
2020-06-04 23:18:36 +02:00
*/
2020-04-24 10:03:23 +02:00
@JsonProperty(EMOJI_FIELD)
2020-06-04 23:18:36 +02:00
private String emoji;
2020-04-01 10:10:13 +02:00
@JsonProperty(DISABLENOTIFICATION_FIELD)
private Boolean disableNotification; ///< Optional. Sends the message silently. Users will receive a notification with no sound.
@JsonProperty(REPLYTOMESSAGEID_FIELD)
private Integer replyToMessageId; ///< Optional. If the message is a reply, ID of the original message
@JsonProperty(REPLYMARKUP_FIELD)
private ReplyKeyboard replyMarkup; ///< Optional. JSON-serialized object for a custom reply keyboard
2020-11-01 23:46:36 +01:00
@JsonProperty(ALLOWSENDINGWITHOUTREPLY_FIELD)
private Boolean allowSendingWithoutReply; ///< Optional. Pass True, if the message should be sent even if the specified replied-to message is not found
2022-01-02 00:06:28 +01:00
@JsonProperty(PROTECTCONTENT_FIELD)
private Boolean protectContent; ///< Optional. Protects the contents of sent messages from forwarding and saving
2020-04-01 10:10:13 +02:00
2022-06-14 22:20:22 +02:00
@Tolerate
public void setChatId(@NonNull Long chatId) {
this.chatId = chatId.toString();
}
2020-11-01 23:46:36 +01:00
public void enableNotification() {
2020-04-01 10:10:13 +02:00
this.disableNotification = false;
}
2020-11-01 23:46:36 +01:00
public void disableNotification() {
2020-04-01 10:10:13 +02:00
this.disableNotification = true;
2020-04-24 10:03:23 +02:00
}
2020-04-01 10:10:13 +02:00
@Override
public String getMethod() {
return PATH;
}
@Override
public void validate() throws TelegramApiValidationException {
2022-06-14 22:20:22 +02:00
if (chatId.isEmpty()) {
2020-04-01 10:10:13 +02:00
throw new TelegramApiValidationException("ChatId parameter can't be empty", this);
}
2020-06-04 23:18:36 +02:00
if (emoji != null && !VALIDEMOJIS.contains(emoji)) {
2020-11-01 23:46:36 +01:00
throw new TelegramApiValidationException("Only \"\uD83C\uDFB2\", \"\uD83C\uDFAF\", \"\uD83C\uDFC0\", \"\", \"\uD83C\uDFB0\" are allowed in Emoji field ", this);
2020-04-24 10:03:23 +02:00
}
2020-04-01 10:10:13 +02:00
if (replyMarkup != null) {
replyMarkup.validate();
}
}
2022-06-14 22:20:22 +02:00
public static class SendDiceBuilder {
@Tolerate
public SendDiceBuilder chatId(@NonNull Long chatId) {
this.chatId = chatId.toString();
return this;
}
}
2020-04-01 10:10:13 +02:00
}