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 inputMessageContent(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

Field Summary

Fields

Modifier and Type	Field	Description
String	caption
List<MessageEntity>	caption_entities
String	id
InputTextMessageContent	input_message_content
String	parse_mode
InlineKeyboardMarkup	reply_markup
String	type

Constructor Summary

Constructors

Constructor	Description
InlineQueryResultDocument(String id, String document_url, String title, MimeType mime_type)	Required

Method Summary

Modifier and Type	Method	Description
InlineQueryResultDocument	caption(String caption)	Optional
InlineQueryResultDocument	captionEntities(MessageEntity[] caption_entities)	Optional
InlineQueryResultDocument	description(String description)	Optional
InlineQueryResultDocument	inputMessageContent(InputTextMessageContent input_message_content)	Optional
InlineQueryResultDocument	parseMode(ParseMode parse_mode)	Optional
InlineQueryResultDocument	replyMarkup(InlineKeyboardMarkup keyboard)	Optional
InlineQueryResultDocument	thumbnailHeight(int thumbnail_height)	Optional
InlineQueryResultDocument	thumbnailUrl(String thumbnail_url)	Optional
InlineQueryResultDocument	thumbnailWidth(int thumbnail_width)	Optional

Methods inherited from class java.lang.Object

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

Field Details

type

public String type

id

public String id

caption

public String caption

parse_mode

public String parse_mode

caption_entities

public List<MessageEntity> caption_entities

input_message_content

public InputTextMessageContent input_message_content

reply_markup

public InlineKeyboardMarkup reply_markup

Constructor Details

InlineQueryResultDocument

public InlineQueryResultDocument(String id,
 String document_url,
 String title,
 MimeType mime_type)

Required

Parameters:

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

document_url - A valid URL for the file

title - Title for the result

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

Method Details

thumbnailUrl

public InlineQueryResultDocument thumbnailUrl(String thumbnail_url)

Optional

Parameters:

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

Returns:

InlineQueryResultDocument

thumbnailWidth

public InlineQueryResultDocument thumbnailWidth(int thumbnail_width)

Optional

Parameters:

thumbnail_width - Thumbnail Width

Returns:

InlineQueryResultDocument

thumbnailHeight

public InlineQueryResultDocument thumbnailHeight(int thumbnail_height)

Optional

Parameters:

thumbnail_height - Thumbnail height

Returns:

InlineQueryResultDocument

description

public InlineQueryResultDocument description(String description)

Optional

Parameters:

description - hort description of the result

Returns:

InlineQueryResultDocument

inputMessageContent

public InlineQueryResultDocument inputMessageContent(InputTextMessageContent input_message_content)

Optional

Parameters:

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

Returns:

T

replyMarkup

public InlineQueryResultDocument replyMarkup(InlineKeyboardMarkup keyboard)

Optional

Parameters:

keyboard - Inline keyboard attached to the message

Returns:

T

caption

public InlineQueryResultDocument caption(String caption)

Optional

Parameters:

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

Returns:

T

captionEntities

public InlineQueryResultDocument captionEntities(MessageEntity[] caption_entities)

Optional

Parameters:

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

Returns:

T

parseMode

public InlineQueryResultDocument parseMode(ParseMode parse_mode)

Optional

Parameters:

parse_mode - Mode for parsing entities in the caption

Returns:

T