2018-07-27 00:27:26 +02:00
package org.telegram.telegrambots.meta.api.methods.send ;
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 ;
2022-06-14 22:20:22 +02:00
import lombok.experimental.Tolerate ;
2018-07-27 00:27:26 +02:00
import org.telegram.telegrambots.meta.api.methods.PartialBotApiMethod ;
import org.telegram.telegrambots.meta.api.objects.InputFile ;
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-27 00:27:26 +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 ;
2020-11-01 23:46:36 +01:00
import java.util.List ;
2018-07-27 00:27:26 +02:00
/ * *
* @author Ruben Bermudez
* @version 4 . 0 . 0
* Use this method to send animation files ( GIF or H . 264 / MPEG - 4 AVC video without sound ) .
* On success , the sent Message is returned .
*
* Bots can currently send animation files of up to 50 MB in size , this limit may be changed in the future .
* /
2020-11-01 23:46:36 +01:00
@EqualsAndHashCode ( callSuper = false )
@Getter
@Setter
@ToString
@RequiredArgsConstructor
@NoArgsConstructor
@AllArgsConstructor
@Builder
2018-07-27 00:27:26 +02:00
public class SendAnimation extends PartialBotApiMethod < Message > {
public static final String PATH = " sendAnimation " ;
public static final String CHATID_FIELD = " chat_id " ;
2022-11-08 19:33:50 +01:00
public static final String MESSAGETHREADID_FIELD = " message_thread_id " ;
2018-07-27 00:27:26 +02:00
public static final String ANIMATION_FIELD = " animation " ;
public static final String DURATION_FIELD = " duration " ;
public static final String WIDTH_FIELD = " width " ;
public static final String HEIGHT_FIELD = " height " ;
public static final String CAPTION_FIELD = " caption " ;
public static final String PARSEMODE_FIELD = " parse_mode " ;
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 " ;
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 " ;
2022-01-02 00:06:28 +01:00
public static final String PROTECTCONTENT_FIELD = " protect_content " ;
2018-07-27 00:27:26 +02:00
2020-11-01 23:46:36 +01:00
@NonNull
2018-07-27 00:27:26 +02:00
private String chatId ; ///< Unique identifier for the chat to send the message to (Or username for channels)
/ * *
* Animation to send . Pass a file_id as String to send an animation that exists on the
* Telegram servers ( recommended ) , pass an HTTP URL as a String for Telegram to get an animation
* from the Internet , or upload a new animation using multipart / form - data .
* /
2022-11-08 19:33:50 +01:00
/ * *
* Unique identifier for the target message thread ( topic ) of the forum ;
* for forum supergroups only
* /
private Integer messageThreadId ;
2020-11-01 23:46:36 +01:00
@NonNull
2018-07-27 00:27:26 +02:00
private InputFile animation ;
private Integer duration ; ///< Optional. Duration of sent animation in seconds
2018-11-06 15:35:55 +01:00
private String caption ; ///< Optional. Animation caption (may also be used when resending videos by file_id).
2018-07-27 00:27:26 +02:00
private Integer width ; ///< Optional. Animation width
2018-11-06 15:35:55 +01:00
private Integer height ; ///< Optional. Animation height
2018-07-27 00:27:26 +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-08-21 22:27:54 +02: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
2022-01-02 00:06:28 +01:00
private Boolean protectContent ; ///< Optional. Protects the contents of sent messages from forwarding and saving
2018-07-27 00:27:26 +02:00
2022-06-14 22:20:22 +02:00
@Tolerate
public void setChatId ( @NonNull Long chatId ) {
this . chatId = chatId . toString ( ) ;
}
2020-11-01 23:46:36 +01:00
public void enableNotification ( ) {
2018-07-27 00:27:26 +02:00
this . disableNotification = false ;
}
2020-11-01 23:46:36 +01:00
public void disableNotification ( ) {
2018-07-27 00:27:26 +02:00
this . disableNotification = true ;
}
@Override
public Message deserializeResponse ( String answer ) throws TelegramApiRequestException {
2022-06-16 19:36:20 +02:00
return deserializeResponse ( answer , Message . class ) ;
2018-07-27 00:27:26 +02:00
}
@Override
public void validate ( ) throws TelegramApiValidationException {
2022-06-14 22:20:22 +02:00
if ( chatId . isEmpty ( ) ) {
2018-07-27 00:27:26 +02:00
throw new TelegramApiValidationException ( " ChatId 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
animation . validate ( ) ;
if ( replyMarkup ! = null ) {
replyMarkup . validate ( ) ;
}
if ( thumb ! = null ) {
thumb . validate ( ) ;
}
}
2022-06-14 22:20:22 +02:00
public static class SendAnimationBuilder {
@Tolerate
public SendAnimationBuilder chatId ( @NonNull Long chatId ) {
this . chatId = chatId . toString ( ) ;
return this ;
}
}
2018-07-27 00:27:26 +02:00
}