InlineQueryResultDocument class
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
Constructors
-
InlineQueryResultDocument({required String title, required String documentUrl, required String mimeType, required String id, String? caption, ParseMode? parseMode, List<
MessageEntity> ? captionEntities, String? description, InlineKeyboardMarkup? replyMarkup, InputMessageContent? inputMessageContent, String? thumbnailUrl, int? thumbnailWidth, int? thumbnailHeight}) -
Constructs an InlineQueryResultDocument object
const
-
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
final
-
captionEntities
→ List<
MessageEntity> ? -
Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
final
- description → String?
-
Optional. Short description of the result
final
- documentUrl → String
-
A valid URL for the file
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
Unique identifier for this result, 1-64 Bytes
final
- inputMessageContent → InputMessageContent?
-
Optional. Content of the message to be sent instead of the file
final
- mimeType → String
-
MIME type of the content of the file, either “application/pdf” or “application/zip”
final
- parseMode → ParseMode?
-
Optional. Mode for parsing entities in the document caption. See formatting options for more details.
final
- replyMarkup → InlineKeyboardMarkup?
-
Optional. Inline keyboard attached to the message
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- thumbnailHeight → int?
-
Optional. Thumbnail height
final
- thumbnailUrl → String?
-
Optional. URL of the thumbnail (JPEG only) for the file
final
- thumbnailWidth → int?
-
Optional. Thumbnail width
final
- title → String
-
Title for the result
final
- type → InlineQueryResultType
-
Type of the result, always InlineQueryResultType.document
no setteroverride
Methods
-
copyWith(
{String? id, String? title, String? caption, ParseMode? parseMode, List< MessageEntity> ? captionEntities, String? documentUrl, String? mimeType, String? description, InlineKeyboardMarkup? replyMarkup, InputMessageContent? inputMessageContent, String? thumbnailUrl, int? thumbnailWidth, int? thumbnailHeight}) → InlineQueryResultDocument - Copy method
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
Converts an InlineQueryResultDocument object to a JSON map
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited