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

217 lines
7.4 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.core.type.TypeReference;
2018-07-08 01:41:21 +02:00
import org.telegram.telegrambots.meta.api.methods.PartialBotApiMethod;
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;
import org.telegram.telegrambots.meta.api.objects.replykeyboard.ApiResponse;
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.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 general files. On success, the sent Message is returned.
2016-01-14 01:14:53 +01:00
*/
public class SendDocument extends PartialBotApiMethod<Message> {
2016-01-14 01:14:53 +01:00
public static final String PATH = "senddocument";
public static final String CHATID_FIELD = "chat_id";
public static final String DOCUMENT_FIELD = "document";
2016-02-27 03:17:06 +01:00
public static final String CAPTION_FIELD = "caption";
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";
2018-07-27 00:27:26 +02:00
public static final String THUMB_FIELD = "thumb";
2018-02-14 20:36:22 +01:00
2016-04-11 02:53:53 +02:00
private String chatId; ///< Unique identifier for the chat to send the message to or Username for the channel to send the message to
2018-07-27 00:27:26 +02:00
private InputFile document; ///< File file to send. file_id as String to resend a file that is already on the Telegram servers or Url to upload it
2016-04-11 02:53:53 +02:00
private String caption; ///< Optional. Document caption (may also be used when resending documents by file_id), 0-200 characters
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.
2018-07-27 00:27:26 +02:00
/**
* Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size.
* A thumbnails width and height should not exceed 90.
* Ignored if the file is not uploaded using multipart/form-data.
* Thumbnails cant be reused and can be only uploaded as a new file, so you can pass attach://<file_attach_name>”
* if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
*/
private InputFile thumb;
2016-01-14 01:14:53 +01:00
public SendDocument() {
super();
}
public String getChatId() {
return chatId;
}
public SendDocument 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 SendDocument setChatId(Long chatId) {
Objects.requireNonNull(chatId);
this.chatId = chatId.toString();
return this;
}
2018-07-27 00:27:26 +02:00
public InputFile getDocument() {
2016-01-14 01:14:53 +01:00
return document;
}
2016-06-09 22:52:08 +02:00
/**
* Use this method to set the document to an document existing in Telegram system
*
* @param document File_id of the document to send
* @note The file_id must have already been received or sent by your bot
*/
public SendDocument setDocument(String document) {
2018-07-27 00:27:26 +02:00
this.document = new InputFile(document);
return this;
2016-01-14 01:14:53 +01:00
}
2016-06-09 22:52:08 +02:00
/**
* Use this method to set the document to a new file
*
* @param file New document file
*/
2018-07-27 00:27:26 +02:00
public SendDocument setDocument(File file) {
Objects.requireNonNull(file, "documentName cannot be null!");
2018-07-27 00:27:26 +02:00
this.document = new InputFile(file, file.getName());
return this;
2016-01-14 01:14:53 +01:00
}
2018-07-27 00:27:26 +02:00
public SendDocument setDocument(InputFile document) {
Objects.requireNonNull(document, "document cannot be null!");
this.document = document;
return this;
}
2018-07-27 00:27:26 +02:00
public SendDocument setDocument(String documentName, InputStream inputStream) {
Objects.requireNonNull(documentName, "documentName cannot be null!");
Objects.requireNonNull(inputStream, "inputStream cannot be null!");
this.document = new InputFile(inputStream, documentName);
return this;
}
public Integer getReplyToMessageId() {
return replyToMessageId;
2016-01-14 01:14:53 +01:00
}
public SendDocument setReplyToMessageId(Integer replyToMessageId) {
this.replyToMessageId = replyToMessageId;
return this;
2016-01-14 01:14:53 +01:00
}
2016-02-27 03:17:06 +01:00
public Boolean getDisableNotification() {
return disableNotification;
}
public SendDocument enableNotification() {
2016-02-27 03:17:06 +01:00
this.disableNotification = false;
return this;
2016-02-27 03:17:06 +01:00
}
public SendDocument disableNotification() {
2016-02-27 03:17:06 +01:00
this.disableNotification = true;
return this;
2016-02-27 03:17:06 +01:00
}
public String getCaption() {
return caption;
}
public SendDocument setCaption(String caption) {
2016-02-27 03:17:06 +01:00
this.caption = caption;
return this;
2016-02-27 03:17:06 +01:00
}
public ReplyKeyboard getReplyMarkup() {
return replyMarkup;
2016-01-14 01:14:53 +01:00
}
public SendDocument setReplyMarkup(ReplyKeyboard replyMarkup) {
this.replyMarkup = replyMarkup;
return this;
2016-01-14 01:14:53 +01:00
}
2018-02-14 20:36:22 +01:00
public String getParseMode() {
return parseMode;
}
public SendDocument setParseMode(String parseMode) {
this.parseMode = parseMode;
return this;
}
2018-07-27 00:27:26 +02:00
public InputFile getThumb() {
return thumb;
}
public SendDocument setThumb(InputFile thumb) {
this.thumb = thumb;
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 document", 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);
}
2018-07-27 00:27:26 +02:00
if (document == null) {
throw new TelegramApiValidationException("Document parameter can't be empty", this);
}
document.validate();
if (thumb != null) {
thumb.validate();
}
if (replyMarkup != null) {
replyMarkup.validate();
}
}
@Override
public String toString() {
return "SendDocument{" +
"chatId='" + chatId + '\'' +
2018-07-27 00:27:26 +02:00
", document=" + document +
2018-02-14 20:36:22 +01:00
", caption='" + caption + '\'' +
", disableNotification=" + disableNotification +
", replyToMessageId=" + replyToMessageId +
", replyMarkup=" + replyMarkup +
2018-02-14 20:36:22 +01:00
", parseMode='" + parseMode + '\'' +
2018-07-27 00:27:26 +02:00
", thumb=" + thumb +
'}';
}
2016-01-14 01:14:53 +01:00
}