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
Available extensions
Annotations
  • @freezed

Constructors

InlineQueryResultDocument({@JsonKey.new(name: 'id') required String id, @JsonKey.new(name: 'type') @Default.new(InlineQueryResultType.document) InlineQueryResultType type, @JsonKey.new(name: 'title') required String title, @JsonKey.new(name: 'document_url') required String documentUrl, @JsonKey.new(name: 'mime_type') required String mimeType, @JsonKey.new(name: 'caption') String? caption, @JsonKey.new(name: 'parse_mode') ParseMode? parseMode, @JsonKey.new(name: 'caption_entities') List<MessageEntity>? captionEntities, @JsonKey.new(name: 'description') String? description, @JsonKey.new(name: 'reply_markup') InlineKeyboardMarkup? replyMarkup, @JsonKey.new(name: 'input_message_content') @InputMessageContentConverter() InputMessageContent? inputMessageContent, @JsonKey.new(name: 'thumbnail_url') String? thumbnailUrl, @JsonKey.new(name: 'thumbnail_width') int? thumbnailWidth, @JsonKey.new(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 setterinherited
captionEntities → List<MessageEntity>?
Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
no setterinherited
copyWith → $InlineQueryResultDocumentCopyWith<InlineQueryResultDocument>
Create a copy of InlineQueryResultDocument with the given fields replaced by the non-null parameter values.
no setterinherited
description → String?
Optional. Short description of the result
no setterinherited
documentUrl → String
A valid URL for the file
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String
Unique identifier for this result, 1-64 Bytes
no setterinherited
inputMessageContent → InputMessageContent?
Optional. Content of the message to be sent instead of the file
no setterinherited
mimeType → String
MIME type of the content of the file, either "application/pdf" or "application/zip"
no setterinherited
parseMode → ParseMode?
Optional. Mode for parsing entities in the document caption. See formatting options for more details.
no setterinherited
replyMarkup → InlineKeyboardMarkup?
Optional. Inline keyboard attached to the message
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
thumbnailHeight → int?
Optional. Thumbnail height
no setterinherited
thumbnailUrl → String?
Optional. URL of the thumbnail (JPEG only) for the file
no setterinherited
thumbnailWidth → int?
Optional. Thumbnail width
no setterinherited
title → String
Title for the result
no setterinherited
type → InlineQueryResultType
Type of the result, always InlineQueryResultType.document
no setterinherited

Methods

map<TResult extends Object?>(TResult $default(_InlineQueryResultDocument value)) → TResult

Available on InlineQueryResultDocument, provided by the InlineQueryResultDocumentPatterns extension

A switch-like method, using callbacks.
mapOrNull<TResult extends Object?>(TResult? $default(_InlineQueryResultDocument value)?) → TResult?

Available on InlineQueryResultDocument, provided by the InlineQueryResultDocumentPatterns extension

A variant of map that fallback to returning null.
maybeMap<TResult extends Object?>(TResult $default(_InlineQueryResultDocument value)?, {required TResult orElse()}) → TResult

Available on InlineQueryResultDocument, provided by the InlineQueryResultDocumentPatterns extension

A variant of map that fallback to returning orElse.
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