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

192 lines
5.4 KiB
Java
Raw Normal View History

2016-04-11 02:53:53 +02:00
package org.telegram.telegrambots.api.methods.send;
2016-01-14 01:14:53 +01:00
2016-04-11 02:53:53 +02:00
import org.telegram.telegrambots.api.objects.replykeyboard.ReplyKeyboard;
2016-01-14 01:14:53 +01:00
import java.io.File;
import java.io.InputStream;
2016-01-14 01:14:53 +01:00
/**
* @author Ruben Bermudez
* @version 1.0
* @brief Use this method to send photos. On success, the sent Message is returned.
* @date 20 of June of 2015
*/
public class SendPhoto {
public static final String PATH = "sendphoto";
public static final String CHATID_FIELD = "chat_id";
public static final String PHOTO_FIELD = "photo";
2016-05-10 18:39:36 +02:00
public static final String CAPTION_FIELD = "caption";
2016-02-27 03:17:06 +01:00
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";
private String chatId; ///< Unique identifier for the chat to send the message to (Or username for channels)
private String photo; ///< Photo to send. file_id as String to resend a photo that is already on the Telegram servers
private String caption; ///< Optional Photo caption (may also be used when resending photos by file_id).
2016-02-27 03:17:06 +01:00
/**
2016-04-11 02:53:53 +02:00
* 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
2016-02-27 03:17:06 +01:00
*/
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
2016-01-14 01:14:53 +01:00
private boolean isNewPhoto; ///< True if the photo must be uploaded from a file, file if it is a fileId
private String photoName; ///< Name of the photo
private File newPhotoFile; // New photo file
private InputStream newPhotoStream; // New photo stream
2016-01-14 01:14:53 +01:00
public SendPhoto() {
super();
}
public String getChatId() {
return chatId;
}
public SendPhoto setChatId(String chatId) {
2016-01-14 01:14:53 +01:00
this.chatId = chatId;
return this;
2016-01-14 01:14:53 +01:00
}
public String getPhoto() {
return photo;
}
public SendPhoto setPhoto(String photo) {
2016-04-11 02:53:53 +02:00
this.photo = photo;
this.isNewPhoto = false;
return this;
2016-04-11 02:53:53 +02:00
}
2016-01-14 01:14:53 +01:00
public String getCaption() {
return caption;
}
public SendPhoto setCaption(String caption) {
2016-01-14 01:14:53 +01:00
this.caption = caption;
return this;
2016-01-14 01:14:53 +01:00
}
public Integer getReplyToMessageId() {
return replyToMessageId;
2016-01-14 01:14:53 +01:00
}
public SendPhoto setReplyToMessageId(Integer replyToMessageId) {
this.replyToMessageId = replyToMessageId;
return this;
2016-01-14 01:14:53 +01:00
}
public ReplyKeyboard getReplyMarkup() {
return replyMarkup;
2016-01-14 01:14:53 +01:00
}
public SendPhoto setReplyMarkup(ReplyKeyboard replyMarkup) {
this.replyMarkup = replyMarkup;
return this;
2016-01-14 01:14:53 +01:00
}
/**
* @deprecated Use {@link #getReplyToMessageId()} instead.
*/
@Deprecated
public Integer getReplayToMessageId() {
return getReplyToMessageId();
}
/**
* @deprecated Use {@link #setReplyToMessageId(Integer)} instead.
*/
@Deprecated
public SendPhoto setReplayToMessageId(Integer replyToMessageId) {
return setReplyToMessageId(replyToMessageId);
}
/**
* @deprecated Use {@link #getReplyMarkup()} instead.
*/
@Deprecated
public ReplyKeyboard getReplayMarkup() {
return getReplyMarkup();
}
/**
* @deprecated Use {@link #setReplyMarkup(ReplyKeyboard)} instead.
*/
@Deprecated
public SendPhoto setReplayMarkup(ReplyKeyboard replyMarkup) {
return setReplyMarkup(replyMarkup);
}
2016-01-14 01:14:53 +01:00
public boolean isNewPhoto() {
return isNewPhoto;
}
public String getPhotoName() {
return photoName;
}
public File getNewPhotoFile() {
return newPhotoFile;
2016-01-14 01:14:53 +01:00
}
public InputStream getNewPhotoStream() {
return newPhotoStream;
}
2016-02-27 03:17:06 +01:00
public Boolean getDisableNotification() {
return disableNotification;
}
public SendPhoto enableNotification() {
2016-02-27 03:17:06 +01:00
this.disableNotification = false;
return this;
2016-02-27 03:17:06 +01:00
}
public SendPhoto disableNotification() {
2016-02-27 03:17:06 +01:00
this.disableNotification = true;
return this;
2016-02-27 03:17:06 +01:00
}
2016-06-09 22:52:08 +02:00
/**
* Use this method to set the photo to a new file
*
* @param photo Path to the new file in your server
* @param photoName Name of the file itself
*
* @deprecated use {@link #setNewPhoto(File)} or {@link #setNewPhoto(InputStream)} instead.
*/
@Deprecated
public SendPhoto setNewPhoto(String photo, String photoName) {
this.photo = photo;
this.isNewPhoto = true;
this.photoName = photoName;
return this;
}
public SendPhoto setNewPhoto(File file) {
this.photo = file.getName();
this.newPhotoFile = file;
2016-01-14 01:14:53 +01:00
this.isNewPhoto = true;
return this;
2016-01-14 01:14:53 +01:00
}
public SendPhoto setNewPhoto(InputStream inputStream) {
this.newPhotoStream = inputStream;
this.isNewPhoto = true;
return this;
}
@Override
public String toString() {
return "SendPhoto{" +
"chatId='" + chatId + '\'' +
", photo='" + photo + '\'' +
", caption='" + caption + '\'' +
", replyToMessageId=" + replyToMessageId +
", replyMarkup=" + replyMarkup +
", isNewPhoto=" + isNewPhoto +
'}';
}
2016-01-14 01:14:53 +01:00
}