TDLightTelegramBots/telegrambots-meta/src/main/java/org/telegram/telegrambots/meta/api/objects/File.java

68 lines
2.3 KiB
Java
Raw Normal View History

2018-07-08 01:41:21 +02:00
package org.telegram.telegrambots.meta.api.objects;
2016-01-14 01:14:53 +01:00
import com.fasterxml.jackson.annotation.JsonProperty;
2020-11-01 23:46:36 +01:00
import lombok.AllArgsConstructor;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;
2018-07-08 01:41:21 +02:00
import org.telegram.telegrambots.meta.api.interfaces.BotApiObject;
2016-01-14 01:14:53 +01:00
import java.security.InvalidParameterException;
import java.text.MessageFormat;
2016-01-14 01:14:53 +01:00
/**
* This object represents a file ready to be downloaded
2016-01-14 01:14:53 +01:00
* @author Ruben Bermudez
* @version 1.0
*/
2020-11-01 23:46:36 +01:00
@EqualsAndHashCode(callSuper = false)
@Getter
@Setter
@ToString
@NoArgsConstructor
@AllArgsConstructor
public class File implements BotApiObject {
2019-12-31 03:36:57 +01:00
private static final String FILEID_FIELD = "file_id";
private static final String FILEUNIQUEID_FIELD = "file_unique_id";
2016-04-11 02:53:53 +02:00
private static final String FILE_SIZE_FIELD = "file_size";
private static final String FILE_PATH_FIELD = "file_path";
/**
* Identifier for this file, which can be used to download or reuse the file
*/
2019-12-31 03:36:57 +01:00
@JsonProperty(FILEID_FIELD)
private String fileId;
2019-12-31 03:36:57 +01:00
/**
* Unique identifier for this file, which is supposed to be the same over time and for different bots.
* Can't be used to download or reuse the file.
*/
@JsonProperty(FILEUNIQUEID_FIELD)
private String fileUniqueId;
2022-06-18 00:40:30 +02:00
/**
* Optional.
* File size in bytes.
* It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it.
* But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
*/
2016-01-14 01:14:53 +01:00
@JsonProperty(FILE_SIZE_FIELD)
2022-06-18 00:40:30 +02:00
private Long fileSize;
/**
* Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file.
*/
2016-01-14 01:14:53 +01:00
@JsonProperty(FILE_PATH_FIELD)
private String filePath;
2016-01-14 01:14:53 +01:00
public String getFileUrl(String botToken) {
return getFileUrl(botToken, filePath);
}
public static String getFileUrl(String botToken, String filePath) {
if (botToken == null || botToken.isEmpty()) {
throw new InvalidParameterException("Bot token can't be empty");
}
return MessageFormat.format("https://api.telegram.org/file/bot{0}/{1}", botToken, filePath);
}
2016-01-14 01:14:53 +01:00
}