InputMedia.document constructor

const InputMedia.document({
  1. @JsonKey(name: 'type') @Default(InputMediaType.document) InputMediaType type,
  2. @JsonKey(name: 'media') @InputFileConverter() required InputFile media,
  3. @JsonKey(name: 'thumbnail') @InputFileConverter() InputFile? thumbnail,
  4. @JsonKey(name: 'caption') String? caption,
  5. @JsonKey(name: 'parse_mode') ParseMode? parseMode,
  6. @JsonKey(name: 'caption_entities') List<MessageEntity>? captionEntities,
  7. @JsonKey(name: 'disable_content_type_detection') bool? disableContentTypeDetection,
})

Represents a document to be sent.

Implementation

const factory InputMedia.document({
  /// Type of input media.
  @JsonKey(name: 'type')
  @Default(InputMediaType.document)
  final InputMediaType type,

  /// The file to send
  @JsonKey(name: 'media')
  @InputFileConverter()
  required final InputFile media,

  /// Optional. Thumbnail of the file sent; can be ignored if thumbnail
  /// generation for the file is supported server-side.
  @JsonKey(name: 'thumbnail')
  @InputFileConverter()
  final InputFile? thumbnail,

  /// Optional. Caption of the document to be sent, 0-1024 characters after
  /// entities parsing
  @JsonKey(name: 'caption') final String? caption,

  /// Optional. Mode for parsing entities in the document caption. See
  /// formatting options for more details.
  @JsonKey(name: 'parse_mode') final ParseMode? parseMode,

  /// Optional. List of special entities that appear in the caption, which can
  /// be specified instead of parse_mode
  @JsonKey(name: 'caption_entities')
  final List<MessageEntity>? captionEntities,

  /// Optional. Disables automatic server-side content type detection for
  /// files uploaded using multipart/form-data. Always True, if the document
  /// is sent as part of an album.
  @JsonKey(name: 'disable_content_type_detection')
  final bool? disableContentTypeDetection,
}) = InputMediaDocument;