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

157 lines
5.7 KiB
Java
Raw Normal View History

2018-07-08 01:41:21 +02:00
package org.telegram.telegrambots.meta.api.methods.send;
2016-01-14 01:14:53 +01:00
import com.fasterxml.jackson.annotation.JsonProperty;
2019-06-08 21:33:28 +02:00
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
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;
2018-07-08 01:41:21 +02:00
import org.telegram.telegrambots.meta.api.methods.ParseMode;
2022-06-16 19:57:41 +02:00
import org.telegram.telegrambots.meta.api.methods.botapimethods.BotApiMethodMessage;
2020-11-01 23:46:36 +01:00
import org.telegram.telegrambots.meta.api.objects.MessageEntity;
2018-07-08 01:41:21 +02:00
import org.telegram.telegrambots.meta.api.objects.replykeyboard.ReplyKeyboard;
import org.telegram.telegrambots.meta.exceptions.TelegramApiValidationException;
2016-01-14 01:14:53 +01:00
2020-11-01 23:46:36 +01:00
import java.util.List;
2017-05-03 01:40:55 +02:00
2016-01-14 01:14:53 +01:00
/**
* @author Ruben Bermudez
* @version 1.0
2017-05-03 01:40:55 +02:00
* Use this method to send text messages. On success, the sent Message is returned.
2016-01-14 01:14:53 +01:00
*/
2020-11-01 23:46:36 +01:00
@SuppressWarnings("unused")
@EqualsAndHashCode(callSuper = false)
@Getter
@Setter
@ToString
@RequiredArgsConstructor
@NoArgsConstructor
@AllArgsConstructor
@Builder
2022-06-16 19:36:20 +02:00
public class SendMessage extends BotApiMethodMessage {
2016-01-14 01:14:53 +01:00
public static final String PATH = "sendmessage";
2016-04-11 02:53:53 +02:00
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";
2016-04-11 02:53:53 +02:00
private static final String TEXT_FIELD = "text";
private static final String PARSEMODE_FIELD = "parse_mode";
private static final String DISABLEWEBPAGEPREVIEW_FIELD = "disable_web_page_preview";
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 ENTITIES_FIELD = "entities";
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";
@JsonProperty(CHATID_FIELD)
2020-11-01 23:46:36 +01:00
@NonNull
2016-01-14 01:14:53 +01:00
private String chatId; ///< Unique identifier for the chat to send the message to (Or username for channels)
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;
@JsonProperty(TEXT_FIELD)
2020-11-01 23:46:36 +01:00
@NonNull
2016-01-14 01:14:53 +01:00
private String text; ///< Text of the message to be sent
@JsonProperty(PARSEMODE_FIELD)
2016-01-14 01:14:53 +01:00
private String parseMode; ///< Optional. Send Markdown, if you want Telegram apps to show bold, italic and URL text in your bot's message.
@JsonProperty(DISABLEWEBPAGEPREVIEW_FIELD)
2016-01-14 01:14:53 +01:00
private Boolean disableWebPagePreview; ///< Optional. Disables link previews for links in this message
@JsonProperty(DISABLENOTIFICATION_FIELD)
2017-03-27 00:49:08 +02:00
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)
2019-06-08 21:33:28 +02:00
@JsonDeserialize()
private ReplyKeyboard replyMarkup; ///< Optional. JSON-serialized object for a custom reply keyboard
2020-11-01 23:46:36 +01:00
@JsonProperty(ENTITIES_FIELD)
private List<MessageEntity> entities; ///< Optional. List of special entities that appear in message text, which can be specified instead of parse_mode
@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
2016-01-14 01:14:53 +01: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 disableWebPagePreview() {
2016-04-11 02:53:53 +02:00
disableWebPagePreview = true;
}
2020-11-01 23:46:36 +01:00
public void enableWebPagePreview() {
2016-04-11 02:53:53 +02:00
disableWebPagePreview = null;
}
2020-11-01 23:46:36 +01:00
public void enableNotification() {
2016-04-11 02:53:53 +02:00
this.disableNotification = null;
2016-02-27 03:17:06 +01:00
}
2020-11-01 23:46:36 +01:00
public void disableNotification() {
2016-02-27 03:17:06 +01:00
this.disableNotification = true;
}
2020-11-01 23:46:36 +01:00
public void enableMarkdown(boolean enable) {
2016-01-14 01:14:53 +01:00
if (enable) {
2016-04-11 02:53:53 +02:00
this.parseMode = ParseMode.MARKDOWN;
2016-01-14 01:14:53 +01:00
} else {
this.parseMode = null;
2016-01-20 20:19:27 +01:00
}
}
2020-11-01 23:46:36 +01:00
public void enableHtml(boolean enable) {
2016-01-20 20:19:27 +01:00
if (enable) {
2016-04-11 02:53:53 +02:00
this.parseMode = ParseMode.HTML;
2016-01-20 20:19:27 +01:00
} else {
this.parseMode = null;
2016-01-14 01:14:53 +01:00
}
}
2020-11-01 23:46:36 +01:00
public void enableMarkdownV2(boolean enable) {
2019-12-31 11:40:34 +01:00
if (enable) {
this.parseMode = ParseMode.MARKDOWNV2;
} else {
this.parseMode = null;
}
}
2016-01-14 01:14:53 +01:00
@Override
public String getMethod() {
2016-01-14 01:14:53 +01:00
return PATH;
}
@Override
public void validate() throws TelegramApiValidationException {
2022-06-14 22:20:22 +02:00
if (chatId.isEmpty()) {
throw new TelegramApiValidationException("ChatId parameter can't be empty", this);
}
2022-06-14 22:20:22 +02:00
if (text.isEmpty()) {
throw new TelegramApiValidationException("Text parameter can't be empty", this);
}
2020-11-01 23:46:36 +01:00
if (parseMode != null && (entities != null && !entities.isEmpty()) ) {
throw new TelegramApiValidationException("Parse mode can't be enabled if Entities are provided", this);
}
if (replyMarkup != null) {
replyMarkup.validate();
2016-01-14 01:14:53 +01:00
}
}
2022-06-14 22:20:22 +02:00
public static class SendMessageBuilder {
@Tolerate
public SendMessageBuilder chatId(@NonNull Long chatId) {
this.chatId = chatId.toString();
return this;
}
}
2016-01-14 01:14:53 +01:00
}