TelegramBots/src/main/java/org/telegram/telegrambots/api/methods/send/SendDocument.java

158 lines
4.9 KiB
Java

package org.telegram.telegrambots.api.methods.send;
import org.telegram.telegrambots.api.objects.replykeyboard.ReplyKeyboard;
import java.io.File;
import java.io.InputStream;
import java.util.Objects;
/**
* @author Ruben Bermudez
* @version 1.0
* @brief Use this method to send general files. On success, the sent Message is returned.
* @date 20 of June of 2015
*/
public class SendDocument {
public static final String PATH = "senddocument";
public static final String CHATID_FIELD = "chat_id";
public static final String DOCUMENT_FIELD = "document";
public static final String CAPTION_FIELD = "caption";
public static final String DISABLENOTIFICATION_FIELD = "disable_notification";
public static final String REPLYTOMESSAGEID_FIELD = "reply_to_message_id";
public static final String REPLYMARKUP_FIELD = "reply_markup";
private String chatId; ///< Unique identifier for the chat to send the message to or Username for the channel to send the message to
private String 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
private String caption; ///< Optional. Document caption (may also be used when resending documents by file_id), 0-200 characters
/**
* Optional. Sends the message silently. iOS users will not receive a notification, Android
* users will receive a notification with no sound. Other apps coming soon
*/
private Boolean disableNotification;
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
private boolean isNewDocument; ///< True to upload a new document, false to use a fileId
private String documentName;
private File newDocumentFile; ///< New document file
private InputStream newDocumentStream; ///< New document stream
public SendDocument() {
super();
}
public String getChatId() {
return chatId;
}
public SendDocument setChatId(String chatId) {
this.chatId = chatId;
return this;
}
public String getDocument() {
return document;
}
/**
* 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) {
this.document = document;
this.isNewDocument = false;
return this;
}
/**
* Use this method to set the document to a new file
*
* @param file New document file
*/
public SendDocument setNewDocument(File file) {
this.document = file.getName();
this.isNewDocument = true;
this.newDocumentFile = file;
return this;
}
public SendDocument setNewDocument(String documentName, InputStream inputStream) {
Objects.requireNonNull(documentName, "documentName cannot be null!");
Objects.requireNonNull(inputStream, "inputStream cannot be null!");
this.documentName = documentName;
this.isNewDocument = true;
this.newDocumentStream = inputStream;
return this;
}
public boolean isNewDocument() {
return isNewDocument;
}
public String getDocumentName() {
return documentName;
}
public File getNewDocumentFile() {
return newDocumentFile;
}
public InputStream getNewDocumentStream() {
return newDocumentStream;
}
public Integer getReplyToMessageId() {
return replyToMessageId;
}
public SendDocument setReplyToMessageId(Integer replyToMessageId) {
this.replyToMessageId = replyToMessageId;
return this;
}
public Boolean getDisableNotification() {
return disableNotification;
}
public SendDocument enableNotification() {
this.disableNotification = false;
return this;
}
public SendDocument disableNotification() {
this.disableNotification = true;
return this;
}
public String getCaption() {
return caption;
}
public SendDocument setCaption(String caption) {
this.caption = caption;
return this;
}
public ReplyKeyboard getReplyMarkup() {
return replyMarkup;
}
public SendDocument setReplyMarkup(ReplyKeyboard replyMarkup) {
this.replyMarkup = replyMarkup;
return this;
}
@Override
public String toString() {
return "SendDocument{" +
"chatId='" + chatId + '\'' +
", document='" + document + '\'' +
", replyToMessageId=" + replyToMessageId +
", replyMarkup=" + replyMarkup +
", isNewDocument=" + isNewDocument +
'}';
}
}