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

117 lines
5.0 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
2022-01-02 00:06:28 +01:00
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.type.TypeReference;
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.Singular;
import lombok.ToString;
2018-07-08 01:41:21 +02:00
import org.telegram.telegrambots.meta.api.methods.PartialBotApiMethod;
2020-11-01 23:46:36 +01:00
import org.telegram.telegrambots.meta.api.objects.ApiResponse;
2018-07-27 00:27:26 +02:00
import org.telegram.telegrambots.meta.api.objects.InputFile;
2018-07-08 01:41:21 +02:00
import org.telegram.telegrambots.meta.api.objects.Message;
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.TelegramApiRequestException;
import org.telegram.telegrambots.meta.exceptions.TelegramApiValidationException;
2016-01-14 01:14:53 +01:00
import java.io.IOException;
2020-11-01 23:46:36 +01:00
import java.util.List;
import java.util.Objects;
2016-01-14 01:14:53 +01:00
/**
* @author Ruben Bermudez
* @version 1.0
2018-02-14 20:36:22 +01:00
* Use this method to send photos. On success, the sent Message is returned.
2016-01-14 01:14:53 +01:00
*/
2020-11-01 23:46:36 +01:00
@EqualsAndHashCode(callSuper = false)
@Getter
@Setter
@ToString
@RequiredArgsConstructor
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class SendPhoto extends PartialBotApiMethod<Message> {
2016-01-14 01:14:53 +01:00
public static final String PATH = "sendphoto";
public static final String CHATID_FIELD = "chat_id";
public static final String PHOTO_FIELD = "photo";
2016-05-10 18:39:36 +02:00
public static final String CAPTION_FIELD = "caption";
2016-02-27 03:17:06 +01:00
public static final String DISABLENOTIFICATION_FIELD = "disable_notification";
2016-04-11 02:53:53 +02:00
public static final String REPLYTOMESSAGEID_FIELD = "reply_to_message_id";
public static final String REPLYMARKUP_FIELD = "reply_markup";
2018-02-14 20:36:22 +01:00
public static final String PARSEMODE_FIELD = "parse_mode";
2020-11-01 23:46:36 +01:00
public static final String CAPTION_ENTITIES_FIELD = "caption_entities";
public static final String ALLOWSENDINGWITHOUTREPLY_FIELD = "allow_sending_without_reply";
2022-01-02 00:06:28 +01:00
public static final String PROTECTCONTENT_FIELD = "protect_content";
2018-02-14 20:36:22 +01:00
2020-11-01 23:46:36 +01:00
@NonNull
2016-04-11 02:53:53 +02:00
private String chatId; ///< Unique identifier for the chat to send the message to (Or username for channels)
2020-11-01 23:46:36 +01:00
@NonNull
2018-07-27 00:27:26 +02:00
private InputFile photo; ///< Photo to send. file_id as String to resend a photo that is already on the Telegram servers or URL to upload it
2016-04-11 02:53:53 +02:00
private String caption; ///< Optional Photo caption (may also be used when resending photos by file_id).
2017-03-27 00:49:08 +02:00
private Boolean disableNotification; ///< Optional. Sends the message silently. Users will receive a notification with no sound.
private Integer replyToMessageId; ///< Optional. If the message is a reply, ID of the original message
private ReplyKeyboard replyMarkup; ///< Optional. JSON-serialized object for a custom reply keyboard
2020-11-01 23:46:36 +01:00
private String parseMode; ///< Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.
@Singular
private List<MessageEntity> captionEntities; ///< Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
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
private Boolean protectContent; ///< Optional. Protects the contents of sent messages from forwarding and saving
2016-01-14 01:14:53 +01:00
2020-11-01 23:46:36 +01:00
public void enableNotification() {
2016-02-27 03:17:06 +01:00
this.disableNotification = false;
}
2020-11-01 23:46:36 +01:00
public void disableNotification() {
2016-02-27 03:17:06 +01:00
this.disableNotification = true;
2018-07-27 00:27:26 +02:00
}
2020-11-01 23:46:36 +01:00
public void setPhoto(InputFile photo) {
2018-07-27 00:27:26 +02:00
Objects.requireNonNull(photo, "photo cannot be null!");
this.photo = photo;
2018-02-14 20:36:22 +01:00
}
@Override
public Message deserializeResponse(String answer) throws TelegramApiRequestException {
try {
ApiResponse<Message> result = OBJECT_MAPPER.readValue(answer,
new TypeReference<ApiResponse<Message>>(){});
if (result.getOk()) {
return result.getResult();
} else {
throw new TelegramApiRequestException("Error sending photo", result);
}
} catch (IOException e) {
throw new TelegramApiRequestException("Unable to deserialize response", e);
}
}
@Override
public void validate() throws TelegramApiValidationException {
2021-04-26 21:55:00 +02:00
if (chatId == null || chatId.isEmpty()) {
throw new TelegramApiValidationException("ChatId parameter can't be empty", this);
}
2018-07-27 00:27:26 +02:00
if (photo == null) {
throw new TelegramApiValidationException("Photo parameter can't be empty", this);
}
2018-07-27 00:27:26 +02:00
2020-11-01 23:46:36 +01:00
if (parseMode != null && (captionEntities != null && !captionEntities.isEmpty()) ) {
throw new TelegramApiValidationException("Parse mode can't be enabled if Entities are provided", this);
}
2018-07-27 00:27:26 +02:00
photo.validate();
if (replyMarkup != null) {
replyMarkup.validate();
}
}
2016-01-14 01:14:53 +01:00
}