2016-04-11 02:53:53 +02:00
package org.telegram.telegrambots.api.methods.send ;
2016-01-14 01:14:53 +01:00
2016-11-17 02:41:12 +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 ;
2016-11-17 02:41:12 +01:00
import org.telegram.telegrambots.exceptions.TelegramApiRequestException ;
import org.telegram.telegrambots.exceptions.TelegramApiValidationException ;
2016-01-14 01:14:53 +01:00
2016-06-03 19:22:02 +02:00
import java.io.File ;
2016-11-17 02:41:12 +01:00
import java.io.IOException ;
2016-06-04 06:15:55 +02:00
import java.io.InputStream ;
2016-08-07 05:47:23 +02:00
import java.util.Objects ;
2016-06-03 19:22:02 +02:00
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
* /
2016-11-17 02:41:12 +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 " ;
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
2016-09-24 22:37:25 +02:00
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
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.
2016-06-20 20:50:03 +02:00
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
2016-06-03 19:22:02 +02:00
private boolean isNewDocument ; ///< True to upload a new document, false to use a fileId
2016-06-04 06:15:55 +02:00
private String documentName ;
2016-06-03 19:22:02 +02:00
private File newDocumentFile ; ///< New document file
2016-06-04 06:15:55 +02:00
private InputStream newDocumentStream ; ///< New document stream
2016-01-14 01:14:53 +01:00
public SendDocument ( ) {
super ( ) ;
}
public String getChatId ( ) {
return chatId ;
}
2016-04-12 21:25:54 +02:00
public SendDocument setChatId ( String chatId ) {
2016-01-14 01:14:53 +01:00
this . chatId = chatId ;
2016-04-12 21:25:54 +02:00
return this ;
2016-01-14 01:14:53 +01:00
}
2016-11-17 02:41:12 +01:00
public SendDocument setChatId ( Long chatId ) {
Objects . requireNonNull ( chatId ) ;
this . chatId = chatId . toString ( ) ;
return this ;
}
2016-01-14 01:14:53 +01:00
public String getDocument ( ) {
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
* /
2016-04-12 21:25:54 +02:00
public SendDocument setDocument ( String document ) {
2016-01-14 01:14:53 +01:00
this . document = document ;
this . isNewDocument = false ;
2016-04-12 21:25:54 +02:00
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
* /
2016-06-03 19:22:02 +02:00
public SendDocument setNewDocument ( File file ) {
2016-11-17 02:41:12 +01:00
Objects . requireNonNull ( file , " documentName cannot be null! " ) ;
2016-01-14 01:14:53 +01:00
this . isNewDocument = true ;
2016-06-03 19:22:02 +02:00
this . newDocumentFile = file ;
2016-04-12 21:25:54 +02:00
return this ;
2016-01-14 01:14:53 +01:00
}
2016-08-07 05:47:23 +02:00
public SendDocument setNewDocument ( String documentName , InputStream inputStream ) {
Objects . requireNonNull ( documentName , " documentName cannot be null! " ) ;
Objects . requireNonNull ( inputStream , " inputStream cannot be null! " ) ;
this . documentName = documentName ;
2016-06-04 06:15:55 +02:00
this . isNewDocument = true ;
this . newDocumentStream = inputStream ;
return this ;
}
2016-01-14 01:14:53 +01:00
public boolean isNewDocument ( ) {
return isNewDocument ;
}
2016-06-04 06:15:55 +02:00
public String getDocumentName ( ) {
return documentName ;
}
2016-06-03 19:22:02 +02:00
public File getNewDocumentFile ( ) {
return newDocumentFile ;
2016-01-14 01:14:53 +01:00
}
2016-06-04 06:15:55 +02:00
public InputStream getNewDocumentStream ( ) {
return newDocumentStream ;
}
2016-06-20 20:50:03 +02:00
public Integer getReplyToMessageId ( ) {
return replyToMessageId ;
2016-01-14 01:14:53 +01:00
}
2016-06-20 20:50:03 +02:00
public SendDocument setReplyToMessageId ( Integer replyToMessageId ) {
this . replyToMessageId = replyToMessageId ;
2016-04-12 21:25:54 +02:00
return this ;
2016-01-14 01:14:53 +01:00
}
2016-02-27 03:17:06 +01:00
public Boolean getDisableNotification ( ) {
return disableNotification ;
}
2016-04-12 22:26:59 +02:00
public SendDocument enableNotification ( ) {
2016-02-27 03:17:06 +01:00
this . disableNotification = false ;
2016-04-12 22:26:59 +02:00
return this ;
2016-02-27 03:17:06 +01:00
}
2016-04-12 22:26:59 +02:00
public SendDocument disableNotification ( ) {
2016-02-27 03:17:06 +01:00
this . disableNotification = true ;
2016-04-12 22:26:59 +02:00
return this ;
2016-02-27 03:17:06 +01:00
}
public String getCaption ( ) {
return caption ;
}
2016-04-12 21:25:54 +02:00
public SendDocument setCaption ( String caption ) {
2016-02-27 03:17:06 +01:00
this . caption = caption ;
2016-04-12 21:25:54 +02:00
return this ;
2016-02-27 03:17:06 +01:00
}
2016-06-20 20:50:03 +02:00
public ReplyKeyboard getReplyMarkup ( ) {
return replyMarkup ;
2016-01-14 01:14:53 +01:00
}
2016-06-20 20:50:03 +02:00
public SendDocument setReplyMarkup ( ReplyKeyboard replyMarkup ) {
this . replyMarkup = replyMarkup ;
2016-04-12 21:25:54 +02:00
return this ;
2016-01-14 01:14:53 +01:00
}
2016-03-08 20:17:07 +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 ;
}
2016-11-17 02:41:12 +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 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 ) ;
}
if ( isNewDocument ) {
if ( newDocumentFile = = null & & newDocumentStream = = null ) {
throw new TelegramApiValidationException ( " Document can't be empty " , this ) ;
}
if ( newDocumentStream ! = null & & ( documentName = = null | | documentName . isEmpty ( ) ) ) {
throw new TelegramApiValidationException ( " Document name can't be empty " , this ) ;
}
} else if ( document = = null ) {
throw new TelegramApiValidationException ( " Document can't be empty " , this ) ;
}
if ( replyMarkup ! = null ) {
replyMarkup . validate ( ) ;
}
}
2016-03-08 20:17:07 +01:00
@Override
public String toString ( ) {
return " SendDocument{ " +
" chatId=' " + chatId + '\'' +
" , document=' " + document + '\'' +
2018-02-14 20:36:22 +01:00
" , caption=' " + caption + '\'' +
" , disableNotification= " + disableNotification +
2016-06-20 20:50:03 +02:00
" , replyToMessageId= " + replyToMessageId +
" , replyMarkup= " + replyMarkup +
2018-02-14 20:36:22 +01:00
" , parseMode=' " + parseMode + '\'' +
2016-03-08 20:17:07 +01:00
" , isNewDocument= " + isNewDocument +
2018-02-14 20:36:22 +01:00
" , documentName=' " + documentName + '\'' +
" , newDocumentFile= " + newDocumentFile +
" , newDocumentStream= " + newDocumentStream +
2016-03-08 20:17:07 +01:00
'}' ;
}
2016-01-14 01:14:53 +01:00
}