InlineQueryResultDocument

data class InlineQueryResultDocument(id: String, title: String, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, documentUrl: String, mimeType: String, description: String?, replyMarkup: InlineKeyboardMarkup?, inputMessageContent: InputMessageContent?, thumbUrl: String?, thumbWidth: Int?, thumbHeight: Int?, type: String) : InlineQueryResult

Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method. Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.

Parameters

id

Unique identifier for this result, 1-64 bytes

title

Title for the result

caption

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

parseMode

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

captionEntities

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

documentUrl

A valid URL for the file

mimeType

Mime type of the content of the file, either “application/pdf” or “application/zip”

description

Optional. Short description of the result

replyMarkup

Optional. Inline keyboard attached to the message

inputMessageContent

Optional. Content of the message to be sent instead of the file

thumbUrl

Optional. URL of the thumbnail (jpeg only) for the file

thumbWidth

Optional. Thumbnail width

thumbHeight

Optional. Thumbnail height

type

Type of the result, must be document

Constructors

InlineQueryResultDocument
Link copied to clipboard
common
fun InlineQueryResultDocument(id: String, title: String, caption: String? = null, parseMode: String? = null, captionEntities: List<MessageEntity> = emptyList(), documentUrl: String, mimeType: String, description: String? = null, replyMarkup: InlineKeyboardMarkup? = null, inputMessageContent: InputMessageContent? = null, thumbUrl: String? = null, thumbWidth: Int? = null, thumbHeight: Int? = null, type: String)
Unique identifier for this result, 1-64 bytes

Functions

component1
Link copied to clipboard
common
operator fun component1(): String
component10
Link copied to clipboard
common
operator fun component10(): InputMessageContent?
component11
Link copied to clipboard
common
operator fun component11(): String?
component12
Link copied to clipboard
common
operator fun component12(): Int?
component13
Link copied to clipboard
common
operator fun component13(): Int?
component14
Link copied to clipboard
common
operator fun component14(): String
component2
Link copied to clipboard
common
operator fun component2(): String
component3
Link copied to clipboard
common
operator fun component3(): String?
component4
Link copied to clipboard
common
operator fun component4(): String?
component5
Link copied to clipboard
common
operator fun component5(): List<MessageEntity>
component6
Link copied to clipboard
common
operator fun component6(): String
component7
Link copied to clipboard
common
operator fun component7(): String
component8
Link copied to clipboard
common
operator fun component8(): String?
component9
Link copied to clipboard
common
operator fun component9(): InlineKeyboardMarkup?
copy
Link copied to clipboard
common
fun copy(id: String, title: String, caption: String? = null, parseMode: String? = null, captionEntities: List<MessageEntity> = emptyList(), documentUrl: String, mimeType: String, description: String? = null, replyMarkup: InlineKeyboardMarkup? = null, inputMessageContent: InputMessageContent? = null, thumbUrl: String? = null, thumbWidth: Int? = null, thumbHeight: Int? = null, type: String): InlineQueryResultDocument
equals
Link copied to clipboard
common
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
common
open override fun hashCode(): Int
toString
Link copied to clipboard
common
open override fun toString(): String

Properties

caption
Link copied to clipboard
common
val caption: String? = null
Optional.
captionEntities
Link copied to clipboard
common
val captionEntities: List<MessageEntity>
Optional.
description
Link copied to clipboard
common
val description: String? = null
Optional.
documentUrl
Link copied to clipboard
common
val documentUrl: String
A valid URL for the file
id
Link copied to clipboard
common
val id: String
Unique identifier for this result, 1-64 bytes
inputMessageContent
Link copied to clipboard
common
val inputMessageContent: InputMessageContent? = null
Optional.
mimeType
Link copied to clipboard
common
val mimeType: String
Mime type of the content of the file, either “application/pdf” or “application/zip”
parseMode
Link copied to clipboard
common
val parseMode: String? = null
Optional.
replyMarkup
Link copied to clipboard
common
val replyMarkup: InlineKeyboardMarkup? = null
Optional.
thumbHeight
Link copied to clipboard
common
val thumbHeight: Int? = null
Optional.
thumbUrl
Link copied to clipboard
common
val thumbUrl: String? = null
Optional.
thumbWidth
Link copied to clipboard
common
val thumbWidth: Int? = null
Optional.
title
Link copied to clipboard
common
val title: String
Title for the result
type
Link copied to clipboard
common
val type: String
Type of the result, must be document