class InputMediaDocument implements InputMediaInterface

Represents a general file to be sent.

Methods

__construct(string $type, string $media, InputFileInterface|string|null $thumb = null, string|null $caption = null, string|null $parse_mode = null, MessageEntity[]|null $caption_entities = null, bool|null $disable_content_type_detection = null)

No description

string
getType()

Type of the result, must be document.

string
getMedia()

File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://” to upload a new one using multipart/form-data under name. More information on Sending Files ».

InputFileInterface|string|null
getThumb()

Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files ».

string|null
getCaption()

Optional. Caption of the document to be sent, 0-1024 characters after entities parsing.

string|null
getParseMode()

Optional. Mode for parsing entities in the document caption. See formatting options for more details.

array|null
getCaptionEntities()

Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.

bool|null
getDisableContentTypeDetection()

Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album.

Details

at line 19
__construct(string $type, string $media, InputFileInterface|string|null $thumb = null, string|null $caption = null, string|null $parse_mode = null, MessageEntity[]|null $caption_entities = null, bool|null $disable_content_type_detection = null)

No description

Parameters

string $type
string $media
InputFileInterface|string|null $thumb
string|null $caption
string|null $parse_mode
MessageEntity[]|null $caption_entities
bool|null $disable_content_type_detection

at line 33
string getType()

Type of the result, must be document.

Return Value

string

at line 41
string getMedia()

File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://” to upload a new one using multipart/form-data under name. More information on Sending Files ».

Return Value

string

at line 51
InputFileInterface|string|null getThumb()

Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files ».

Return Value

InputFileInterface|string|null

at line 59
string|null getCaption()

Optional. Caption of the document to be sent, 0-1024 characters after entities parsing.

Return Value

string|null

at line 67
string|null getParseMode()

Optional. Mode for parsing entities in the document caption. See formatting options for more details.

Return Value

string|null

at line 77
array|null getCaptionEntities()

Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.

Return Value

array|null

at line 85
bool|null getDisableContentTypeDetection()

Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album.

Return Value

bool|null