simbot-component-telegram-type/love.forte.simbot.telegram.type/InputMediaDocument

InputMediaDocument

@Serializable
@SerialName(value = "document")
data class InputMediaDocument(val media: String, val thumbnail: String? = null, val caption: String? = null, val parseMode: String? = null, val captionEntities: List<MessageEntity>? = null, val disableContentTypeDetection: Boolean? = null) : InputMedia(source)

InputMediaDocument

Represents a general file to be sent.

(auto-generated)

Author

ForteScarlet

Constructors

Link copied to clipboard
constructor(media: String, thumbnail: String? = null, caption: String? = null, parseMode: String? = null, captionEntities: List<MessageEntity>? = null, disableContentTypeDetection: Boolean? = null)

Properties

Link copied to clipboard
val caption: String? = null

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

Link copied to clipboard
@SerialName(value = "caption_entities")
val captionEntities: List<MessageEntity>? = null

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

Link copied to clipboard
@SerialName(value = "disable_content_type_detection")
val disableContentTypeDetection: Boolean? = null

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.

Link copied to clipboard
val media: String

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 »

Link copied to clipboard
@SerialName(value = "parse_mode")
val parseMode: String? = null

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

Link copied to clipboard
val thumbnail: String? = null

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 »