Package io.github.natanimn.telebof.types.inline

Class InlineQueryResultDocument

java.lang.Object

io.github.natanimn.telebof.types.inline.InlineQueryResultDocument

All Implemented Interfaces:

InlineQueryResult, Serializable

public class InlineQueryResultDocument
extends Object

Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use setInputMessageContent(io.github.natanimn.telebof.types.input.InputTextMessageContent) to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.

Since:

3 March 2025

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InlineQueryResultDocument(String id, String documentUrl, String title, MimeType mimeType)	Required

Method Summary

Modifier and Type	Method	Description
InlineQueryResultDocument	setCaption(String caption)	Optional
InlineQueryResultDocument	setCaptionEntities(MessageEntity[] captionEntities)	Optional
InlineQueryResultDocument	setDescription(String description)	Optional
InlineQueryResultDocument	setInputMessageContent(InputTextMessageContent inputMessageContent)	Optional
InlineQueryResultDocument	setParseMode(ParseMode parseMode)	Optional
InlineQueryResultDocument	setReplyMarkup(InlineKeyboardMarkup replyMarkup)	Optional
InlineQueryResultDocument	setThumbnailHeight(Integer thumbnailHeight)	Optional
InlineQueryResultDocument	setThumbnailUrl(String thumbnailUrl)	Optional
InlineQueryResultDocument	setThumbnailWidth(Integer thumbnailWidth)	Optional

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InlineQueryResultDocument

public InlineQueryResultDocument(String id,
 String documentUrl,
 String title,
 MimeType mimeType)

Required

Parameters:

id - Unique identifier for this result, 1-64 bytes

documentUrl - A valid URL for the file

title - Title for the result

mimeType - MIME type of the content of the file, either MimeType.PDF or MimeType.ZIP

Method Details

setThumbnailUrl

public InlineQueryResultDocument setThumbnailUrl(String thumbnailUrl)

Optional

Parameters:

thumbnailUrl - URL of the thumbnail (JPEG only) for the file

Returns:

InlineQueryResultDocument

setThumbnailWidth

public InlineQueryResultDocument setThumbnailWidth(Integer thumbnailWidth)

Optional

Parameters:

thumbnailWidth - Thumbnail Width

Returns:

InlineQueryResultDocument

setThumbnailHeight

public InlineQueryResultDocument setThumbnailHeight(Integer thumbnailHeight)

Optional

Parameters:

thumbnailHeight - Thumbnail height

Returns:

InlineQueryResultDocument

setDescription

public InlineQueryResultDocument setDescription(String description)

Optional

Parameters:

description - Short description of the result

Returns:

InlineQueryResultDocument

setInputMessageContent

public InlineQueryResultDocument setInputMessageContent(InputTextMessageContent inputMessageContent)

Optional

Parameters:

inputMessageContent - Content of the message to be sent instead of the media(photo, audio, voice, etc)

Returns:

InlineQueryMediaResult

setReplyMarkup

public InlineQueryResultDocument setReplyMarkup(InlineKeyboardMarkup replyMarkup)

Optional

Parameters:

replyMarkup - Inline keyboard attached to the message

Returns:

InlineQueryMediaResult

setCaption

public InlineQueryResultDocument setCaption(String caption)

Optional

Parameters:

caption - Caption of the photo to be sent, 0-1024 characters after entities parsing

Returns:

InlineQueryMediaResult

setCaptionEntities

public InlineQueryResultDocument setCaptionEntities(MessageEntity[] captionEntities)

Optional

Parameters:

captionEntities - List of special entities that appear in the caption, which can be specified instead of setParseMode(io.github.natanimn.telebof.enums.ParseMode)

Returns:

InlineQueryMediaResult

setParseMode

public InlineQueryResultDocument setParseMode(ParseMode parseMode)

Optional

Parameters:

parseMode - Mode for parsing entities in the caption

Returns:

InlineQueryMediaResult