class Document

This object represents a general file (as opposed to photos, voice messages and audio files).

Methods

__construct(string $file_id, string $file_unique_id, PhotoSize|null $thumb = null, string|null $file_name = null, string|null $mime_type = null, int|null $file_size = null)

No description

string
getFileId()

Identifier for this file, which can be used to download or reuse the file.

string
getFileUniqueId()

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.

PhotoSize|null
getThumb()

Optional. Document thumbnail as defined by sender.

string|null
getFileName()

Optional. Original filename as defined by sender.

string|null
getMimeType()

Optional. MIME type of the file as defined by sender.

int|null
getFileSize()

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.

Details

at line 18
__construct(string $file_id, string $file_unique_id, PhotoSize|null $thumb = null, string|null $file_name = null, string|null $mime_type = null, int|null $file_size = null)

No description

Parameters

string $file_id
string $file_unique_id
PhotoSize|null $thumb
string|null $file_name
string|null $mime_type
int|null $file_size

at line 31
string getFileId()

Identifier for this file, which can be used to download or reuse the file.

Return Value

string

at line 39
string getFileUniqueId()

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.

Return Value

string

at line 47
PhotoSize|null getThumb()

Optional. Document thumbnail as defined by sender.

Return Value

PhotoSize|null

at line 55
string|null getFileName()

Optional. Original filename as defined by sender.

Return Value

string|null

at line 63
string|null getMimeType()

Optional. MIME type of the file as defined by sender.

Return Value

string|null

at line 71
int|null getFileSize()

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.

Return Value

int|null