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

169 lines
5.4 KiB
Java

package org.telegram.telegrambots.meta.api.methods.send;
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;
import lombok.experimental.Tolerate;
import org.telegram.telegrambots.meta.api.objects.InputFile;
import org.telegram.telegrambots.meta.api.objects.Message;
import org.telegram.telegrambots.meta.api.objects.MessageEntity;
import org.telegram.telegrambots.meta.api.objects.replykeyboard.ReplyKeyboard;
import org.telegram.telegrambots.meta.exceptions.TelegramApiRequestException;
import org.telegram.telegrambots.meta.exceptions.TelegramApiValidationException;
import java.util.List;
import java.util.Objects;
/**
* @author Ruben Bermudez
* @version 1.0
* Use this method to send photos. On success, the sent Message is returned.
*/
@EqualsAndHashCode(callSuper = false)
@Getter
@Setter
@ToString
@RequiredArgsConstructor
@NoArgsConstructor(force = true)
@AllArgsConstructor
@Builder
public class SendPhoto extends SendMediaBotMethod<Message> {
public static final String PATH = "sendphoto";
public static final String CHATID_FIELD = "chat_id";
public static final String MESSAGETHREADID_FIELD = "message_thread_id";
public static final String PHOTO_FIELD = "photo";
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";
public static final String PARSEMODE_FIELD = "parse_mode";
public static final String CAPTION_ENTITIES_FIELD = "caption_entities";
public static final String ALLOWSENDINGWITHOUTREPLY_FIELD = "allow_sending_without_reply";
public static final String PROTECTCONTENT_FIELD = "protect_content";
public static final String HASSPOILER_FIELD = "has_spoiler";
/**
* Unique identifier for the chat to send the message to (Or username for channels)
*/
@NonNull
private String chatId;
/**
* Unique identifier for the target message thread (topic) of the forum;
* for forum supergroups only
*/
private Integer messageThreadId;
/**
* Photo to send. file_id as String to resend a photo that is already on the Telegram servers or URL to upload it
*/
@NonNull
private InputFile photo;
/**
* Optional Photo caption (may also be used when resending photos by file_id).
*/
private String caption;
/**
* Optional. Sends the message silently. Users will receive a notification with no sound.
*/
private Boolean disableNotification;
/**
* Optional. If the message is a reply, ID of the original message
*/
private Integer replyToMessageId;
/**
* Optional. JSON-serialized object for a custom reply keyboard
*/
private ReplyKeyboard replyMarkup;
/**
* Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.
*/
private String parseMode;
/**
* Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
*/
@Singular
private List<MessageEntity> captionEntities;
/**
* Optional Pass True, if the message should be sent even if the specified replied-to message is not found
*/
private Boolean allowSendingWithoutReply;
/**
* Optional. Protects the contents of sent messages from forwarding and saving
*/
private Boolean protectContent;
/**
* Optional.
* Pass True if the photo must be covered with a spoiler animation
*/
private Boolean hasSpoiler;
@Tolerate
public void setChatId(@NonNull Long chatId) {
this.chatId = chatId.toString();
}
public void enableNotification() {
this.disableNotification = false;
}
public void disableNotification() {
this.disableNotification = true;
}
public void setPhoto(InputFile photo) {
Objects.requireNonNull(photo, "photo cannot be null!");
this.photo = photo;
}
@Override
public Message deserializeResponse(String answer) throws TelegramApiRequestException {
return deserializeResponse(answer, Message.class);
}
@Override
public void validate() throws TelegramApiValidationException {
if (chatId.isEmpty()) {
throw new TelegramApiValidationException("ChatId parameter can't be empty", this);
}
if (parseMode != null && (captionEntities != null && !captionEntities.isEmpty()) ) {
throw new TelegramApiValidationException("Parse mode can't be enabled if Entities are provided", this);
}
photo.validate();
if (replyMarkup != null) {
replyMarkup.validate();
}
}
@Override
public InputFile getFile() {
return photo;
}
@Override
public String getFileField() {
return PHOTO_FIELD;
}
@Override
public String getMethod() {
return PATH;
}
public static class SendPhotoBuilder {
@Tolerate
public SendPhotoBuilder chatId(@NonNull Long chatId) {
this.chatId = chatId.toString();
return this;
}
}
}