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

209 lines
6.9 KiB
Java
Raw Normal View History

2016-04-11 02:53:53 +02:00
package org.telegram.telegrambots.api.methods.send;
2016-01-14 01:14:53 +01:00
import com.fasterxml.jackson.core.type.TypeReference;
import org.telegram.telegrambots.api.methods.PartialBotApiMethod;
import org.telegram.telegrambots.api.objects.Message;
import org.telegram.telegrambots.api.objects.replykeyboard.ApiResponse;
2016-04-11 02:53:53 +02:00
import org.telegram.telegrambots.api.objects.replykeyboard.ReplyKeyboard;
import org.telegram.telegrambots.exceptions.TelegramApiRequestException;
import org.telegram.telegrambots.exceptions.TelegramApiValidationException;
2016-01-14 01:14:53 +01:00
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
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
*/
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";
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)
private String 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
2018-02-14 20:36:22 +01:00
private String parseMode; ///< Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.
2016-01-14 01:14:53 +01:00
private boolean isNewPhoto; ///< True if the photo must be uploaded from a file, file if it is a fileId
private String photoName; ///< Name of the photo
private File newPhotoFile; // New photo file
private InputStream newPhotoStream; // New photo stream
2016-01-14 01:14:53 +01:00
public SendPhoto() {
super();
}
public String getChatId() {
return chatId;
}
public SendPhoto setChatId(String chatId) {
2016-01-14 01:14:53 +01:00
this.chatId = chatId;
return this;
2016-01-14 01:14:53 +01:00
}
public SendPhoto setChatId(Long chatId) {
Objects.requireNonNull(chatId);
this.chatId = chatId.toString();
return this;
}
2016-01-14 01:14:53 +01:00
public String getPhoto() {
return photo;
}
public SendPhoto setPhoto(String photo) {
2016-04-11 02:53:53 +02:00
this.photo = photo;
this.isNewPhoto = false;
return this;
2016-04-11 02:53:53 +02:00
}
2016-01-14 01:14:53 +01:00
public String getCaption() {
return caption;
}
public SendPhoto setCaption(String caption) {
2016-01-14 01:14:53 +01:00
this.caption = caption;
return this;
2016-01-14 01:14:53 +01:00
}
public Integer getReplyToMessageId() {
return replyToMessageId;
2016-01-14 01:14:53 +01:00
}
public SendPhoto setReplyToMessageId(Integer replyToMessageId) {
this.replyToMessageId = replyToMessageId;
return this;
2016-01-14 01:14:53 +01:00
}
public ReplyKeyboard getReplyMarkup() {
return replyMarkup;
2016-01-14 01:14:53 +01:00
}
public SendPhoto setReplyMarkup(ReplyKeyboard replyMarkup) {
this.replyMarkup = replyMarkup;
return this;
2016-01-14 01:14:53 +01:00
}
public boolean isNewPhoto() {
return isNewPhoto;
}
public String getPhotoName() {
return photoName;
}
public File getNewPhotoFile() {
return newPhotoFile;
2016-01-14 01:14:53 +01:00
}
public InputStream getNewPhotoStream() {
return newPhotoStream;
}
2016-02-27 03:17:06 +01:00
public Boolean getDisableNotification() {
return disableNotification;
}
public SendPhoto enableNotification() {
2016-02-27 03:17:06 +01:00
this.disableNotification = false;
return this;
2016-02-27 03:17:06 +01:00
}
public SendPhoto disableNotification() {
2016-02-27 03:17:06 +01:00
this.disableNotification = true;
return this;
2016-02-27 03:17:06 +01:00
}
public SendPhoto setNewPhoto(File file) {
this.newPhotoFile = file;
2016-01-14 01:14:53 +01:00
this.isNewPhoto = true;
return this;
2016-01-14 01:14:53 +01:00
}
public SendPhoto setNewPhoto(String photoName, InputStream inputStream) {
Objects.requireNonNull(photoName, "photoName cannot be null!");
Objects.requireNonNull(inputStream, "inputStream cannot be null!");
this.photoName = photoName;
this.newPhotoStream = inputStream;
this.isNewPhoto = true;
return this;
}
2018-02-14 20:36:22 +01:00
public String getParseMode() {
return parseMode;
}
public SendPhoto setParseMode(String parseMode) {
this.parseMode = parseMode;
return this;
}
@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 {
if (chatId == null) {
throw new TelegramApiValidationException("ChatId parameter can't be empty", this);
}
if (isNewPhoto) {
if (newPhotoFile == null && newPhotoStream == null) {
throw new TelegramApiValidationException("Photo can't be empty", this);
}
if (newPhotoStream != null && (photoName == null || photoName.isEmpty())) {
throw new TelegramApiValidationException("Photo name can't be empty", this);
}
} else if (photo == null) {
throw new TelegramApiValidationException("Photo can't be empty", this);
}
if (replyMarkup != null) {
replyMarkup.validate();
}
}
@Override
public String toString() {
return "SendPhoto{" +
"chatId='" + chatId + '\'' +
", photo='" + photo + '\'' +
", caption='" + caption + '\'' +
2018-02-14 20:36:22 +01:00
", disableNotification=" + disableNotification +
", replyToMessageId=" + replyToMessageId +
", replyMarkup=" + replyMarkup +
2018-02-14 20:36:22 +01:00
", parseMode='" + parseMode + '\'' +
", isNewPhoto=" + isNewPhoto +
2018-02-14 20:36:22 +01:00
", photoName='" + photoName + '\'' +
", newPhotoFile=" + newPhotoFile +
", newPhotoStream=" + newPhotoStream +
'}';
}
2016-01-14 01:14:53 +01:00
}