InlineQueryResultDocument class abstract

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.

Implemented types

• InlineQueryResult

Annotations

• @freezed

Constructors

InlineQueryResultDocument.new({@JsonKey(name: 'id') required String id, @JsonKey(name: 'type') @Default(InlineQueryResultType.document) InlineQueryResultType type, @JsonKey(name: 'title') required String title, @JsonKey(name: 'document_url') required String documentUrl, @JsonKey(name: 'mime_type') required String mimeType, @JsonKey(name: 'caption') String? caption, @JsonKey(name: 'parse_mode') ParseMode? parseMode, @JsonKey(name: 'caption_entities') List<MessageEntity>? captionEntities, @JsonKey(name: 'description') String? description, @JsonKey(name: 'reply_markup') InlineKeyboardMarkup? replyMarkup, @JsonKey(name: 'input_message_content') @InputMessageContentConverter() InputMessageContent? inputMessageContent, @JsonKey(name: 'thumbnail_url') String? thumbnailUrl, @JsonKey(name: 'thumbnail_width') int? thumbnailWidth, @JsonKey(name: 'thumbnail_height') int? thumbnailHeight})

Constructs an InlineQueryResultDocument object

const

factory

InlineQueryResultDocument.fromJson(Map<String, dynamic> json)

Constructs an InlineQueryResultDocument object from a JSON map

factory

Properties

caption → String?

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

no setter, inherited

captionEntities → List<MessageEntity>?

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

no setter, inherited

copyWith → $InlineQueryResultDocumentCopyWith<InlineQueryResultDocument>

Create a copy of InlineQueryResultDocument with the given fields replaced by the non-null parameter values.

no setter, inherited

description → String?

Optional. Short description of the result

no setter, inherited

documentUrl → String

A valid URL for the file

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → String

Unique identifier for this result, 1-64 Bytes

no setter, inherited

inputMessageContent → InputMessageContent?

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

no setter, inherited

mimeType → String

MIME type of the content of the file, either "application/pdf" or "application/zip"

no setter, inherited

parseMode → ParseMode?

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

no setter, inherited

replyMarkup → InlineKeyboardMarkup?

Optional. Inline keyboard attached to the message

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

thumbnailHeight → int?

Optional. Thumbnail height

no setter, inherited

thumbnailUrl → String?

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

no setter, inherited

thumbnailWidth → int?

Optional. Thumbnail width

no setter, inherited

title → String

Title for the result

no setter, inherited

type → InlineQueryResultType

Type of the result, always InlineQueryResultType.document

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes this InlineQueryResultDocument to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited