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

70 lines
2.2 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
/**
2020-11-01 23:46:36 +01:00
* This object represents a general file (as opposed to photos and audio files).
2016-01-14 01:14:53 +01:00
* Telegram users can send files of any type of up to 1.5 GB in size.
* @author Ruben Bermudez
* @version 1.0
2016-01-14 01:14:53 +01:00
*/
2020-11-01 23:46:36 +01:00
@EqualsAndHashCode(callSuper = false)
@Getter
@Setter
@ToString
@NoArgsConstructor
@AllArgsConstructor
public class Document implements BotApiObject {
2016-01-14 01:14:53 +01:00
2016-04-11 02:53:53 +02:00
private static final String FILEID_FIELD = "file_id";
2019-12-31 03:36:57 +01:00
private static final String FILEUNIQUEID_FIELD = "file_unique_id";
2016-04-11 02:53:53 +02:00
private static final String THUMB_FIELD = "thumb";
private static final String FILENAME_FIELD = "file_name";
private static final String MIMETYPE_FIELD = "mime_type";
private static final String FILESIZE_FIELD = "file_size";
/**
* Identifier for this file, which can be used to download or reuse the file
*/
2016-01-14 01:14:53 +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;
/**
* Document thumbnail as defined by sender
*/
2016-01-14 01:14:53 +01:00
@JsonProperty(THUMB_FIELD)
private PhotoSize thumb;
/**
* Optional.
* Original filename as defined by sender
*/
2016-01-14 01:14:53 +01:00
@JsonProperty(FILENAME_FIELD)
private String fileName;
/**
* Optional.
* Mime type of a file as defined by sender
*/
2016-01-14 01:14:53 +01:00
@JsonProperty(MIMETYPE_FIELD)
private String mimeType;
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(FILESIZE_FIELD)
2022-06-18 00:40:30 +02:00
private Long fileSize;
2016-01-14 01:14:53 +01:00
}