Document
This object represents a general file (as opposed to photos, voice messages and audio files).
📝 Schema
Field | Type | Description |
---|---|---|
file_id | String | Identifier for this file, which can be used to download or reuse the file |
file_unique_id | String | 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. |
thumbnail | PhotoSize | Optional. Document thumbnail as defined by the sender |
file_name | String | Optional. Original filename as defined by the sender |
mime_type | String | Optional. MIME type of the file as defined by the sender |
file_size | Integer | 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. |
⚙️ Get methods
getFileId()
Retrieves the identifier for this file, which can be used to download or reuse the file.
$documentFileId = $documentObject->getFileId();
getFileUniqueId()
Retrieves the unique identifier for this file, which remains constant over time and across different bots.
$documentFileUniqueId = $documentObject->getFileUniqueId();
getThumbnail()
Retrieves the thumbnail of the document as a PhotoSize object, if available.
$documentThumbnail = $documentObject->getThumbnail();
getFileName()
Retrieves the original filename of the document, if available.
$documentFileName = $documentObject->getFileName();
getMimeType()
Retrieves the MIME type of the document, if available.
$documentMimeType = $documentObject->getMimeType();
getFileSize()
Retrieves the file size of the document in bytes, if available.
$documentFileSize = $documentObject->getFileSize();
➕ More
tip
For further information, refer to the official Bale documentation for more details.