Document class abstract

This object represents a general file (as opposed to photos, voice messages and audio files).

Available extensions
Annotations
  • @freezed

Constructors

Document({@JsonKey.new(name: 'file_id') required String fileId, @JsonKey.new(name: 'file_unique_id') required String fileUniqueId, @JsonKey.new(name: 'thumbnail') PhotoSize? thumbnail, @JsonKey.new(name: 'file_name') String? fileName, @JsonKey.new(name: 'mime_type') String? mimeType, @JsonKey.new(name: 'file_size') int? fileSize})
Creates a general file
const
factory
Document.fromJson(Map<String, dynamic> json)
Creates a Document from a JSON map
factory

Properties

copyWith → $DocumentCopyWith<Document>
Create a copy of Document with the given fields replaced by the non-null parameter values.
no setterinherited
fileId String
Identifier for this file, which can be used to download or reuse the file
no setterinherited
fileName String?
Optional. Original filename as defined by sender
no setterinherited
fileSize int?
Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
no setterinherited
fileUniqueId String
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
mimeType String?
Optional. MIME type of the file as defined by sender
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
thumbnail PhotoSize?
Optional. Thumbnail of the album cover to which the music file belongs
no setterinherited

Methods

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

Available on Document, provided by the DocumentPatterns extension

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

Available on Document, provided by the DocumentPatterns extension

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

Available on Document, provided by the DocumentPatterns 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 Document to a JSON map.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited