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 ;
2016-11-17 02:41:12 +01:00
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
2016-11-17 02:41:12 +01:00
import java.io.IOException ;
2020-11-01 23:46:36 +01:00
import java.util.List ;
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
* /
2020-11-01 23:46:36 +01:00
@EqualsAndHashCode ( callSuper = false )
@Getter
@Setter
@ToString
@RequiredArgsConstructor
@NoArgsConstructor
@AllArgsConstructor
@Builder
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 " ;
2018-07-27 00:27:26 +02:00
public static final String THUMB_FIELD = " thumb " ;
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 " ;
2021-01-02 17:51:25 +01:00
public static final String DISABLECONTENTTYPEDETECTION_FIELD = " disable_content_type_detection " ;
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 the channel to send the message to
2020-11-01 23:46:36 +01:00
@NonNull
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.
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
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.
2018-07-27 00:27:26 +02:00
/ * *
2020-11-01 23:46:36 +01:00
* Optional .
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 .
2019-04-08 02:43:46 +02:00
* A thumbnail ’ s width and height should not exceed 320 .
2018-07-27 00:27:26 +02:00
* Ignored if the file is not uploaded using multipart / form - data .
* Thumbnails can ’ t 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 ;
2020-11-01 23:46:36 +01:00
@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
2021-01-02 17:51:25 +01:00
private Boolean disableContentTypeDetection ; ///< Optional Disables automatic server-side content type detection for files uploaded using multipart/form-data
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
}
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 {
2021-04-26 21:55:00 +02:00
if ( chatId = = null | | chatId . isEmpty ( ) ) {
2016-11-17 02:41:12 +01:00
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 ) ;
}
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
document . validate ( ) ;
if ( thumb ! = null ) {
thumb . validate ( ) ;
2016-11-17 02:41:12 +01:00
}
if ( replyMarkup ! = null ) {
replyMarkup . validate ( ) ;
}
}
2016-01-14 01:14:53 +01:00
}