PassportElementError class sealed

This object represents an error in the Telegram Passport element. It can be one of:

  • PassportElementErrorDataField
  • PassportElementErrorFrontSide
  • PassportElementErrorReverseSide
  • PassportElementErrorSelfie
  • PassportElementErrorFile
  • PassportElementErrorFiles
  • PassportElementErrorTranslationFile
  • PassportElementErrorTranslationFiles
  • PassportElementErrorUnspecified
Available extensions
Annotations
  • @Freezed.new(fromJson: true, toJson: true, unionKey: 'source', unionValueCase: FreezedUnionCase.snake)

Constructors

PassportElementError.dataField({@Default.new(PassportElementErrorSource.data) PassportElementErrorSource source, required PassportType type, required String message, @JsonKey.new(name: 'field_name') required String fieldName, @JsonKey.new(name: 'data_hash') required String dataHash})
Represents an error in data provided by the user
const
factory
PassportElementError.file({@JsonKey.new(name: 'source') @Default.new(PassportElementErrorSource.file) PassportElementErrorSource source, @JsonKey.new(name: 'type') required PassportType type, @JsonKey.new(name: 'message') required String message, @JsonKey.new(name: 'file_hash') required String fileHash})
Represents an error in a file
const
factory
PassportElementError.files({@JsonKey.new(name: 'source') @Default.new(PassportElementErrorSource.files) PassportElementErrorSource source, @JsonKey.new(name: 'type') required PassportType type, @JsonKey.new(name: 'message') required String message, @JsonKey.new(name: 'file_hashes') required List<String> fileHashes})
Represents an error in files
const
factory
PassportElementError.fromJson(Map<String, dynamic> json)
Creates a new instance of PassportElementError from a JSON object.
factory
PassportElementError.frontSide({@Default.new(PassportElementErrorSource.frontSide) @JsonKey.new(name: 'source') PassportElementErrorSource source, @JsonKey.new(name: 'type') required PassportType type, @JsonKey.new(name: 'message') required String message, @JsonKey.new(name: 'file_hash') required String fileHash})
Represents an error in the front side of a document
const
factory
PassportElementError.reverseSide({@JsonKey.new(name: 'source') @Default.new(PassportElementErrorSource.reverseSide) PassportElementErrorSource source, @JsonKey.new(name: 'type') required PassportType type, @JsonKey.new(name: 'message') required String message, @JsonKey.new(name: 'file_hash') required String fileHash})
Represents an error in the reverse side of a document
const
factory
PassportElementError.selfie({@JsonKey.new(name: 'source') @Default.new(PassportElementErrorSource.selfie) PassportElementErrorSource source, @JsonKey.new(name: 'type') required PassportType type, @JsonKey.new(name: 'message') required String message, @JsonKey.new(name: 'file_hash') required String fileHash})
Represents an error in the selfie with a document
const
factory
PassportElementError.translationFile({@JsonKey.new(name: 'source') @Default.new(PassportElementErrorSource.translationFile) PassportElementErrorSource source, @JsonKey.new(name: 'type') required PassportType type, @JsonKey.new(name: 'message') required String message, @JsonKey.new(name: 'file_hash') required String fileHash})
Represents an error in one of the files that constitute the translation of a document
const
factory
PassportElementError.translationFiles({@JsonKey.new(name: 'source') @Default.new(PassportElementErrorSource.translationFiles) PassportElementErrorSource source, @JsonKey.new(name: 'type') required PassportType type, @JsonKey.new(name: 'message') required String message, @JsonKey.new(name: 'file_hashes') required List<String> fileHashes})
Represents an error in the translated version of a document
const
factory
PassportElementError.unspecified({@JsonKey.new(name: 'source') @Default.new(PassportElementErrorSource.unspecified) PassportElementErrorSource source, @JsonKey.new(name: 'type') required PassportType type, @JsonKey.new(name: 'message') required String message, @JsonKey.new(name: 'element_hash') required String elementHash})
Represents an issue in an unspecified place
const
factory

Properties

copyWith → $PassportElementErrorCopyWith<PassportElementError>
Create a copy of PassportElementError with the given fields replaced by the non-null parameter values.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
message String
Error message
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
source PassportElementErrorSource
Error source, must be "data"
no setterinherited
type PassportType
The section of the user's Telegram Passport which has the error
no setterinherited

Methods

map<TResult extends Object?>({required TResult dataField(PassportElementErrorDataField value), required TResult frontSide(PassportElementErrorFrontSide value), required TResult reverseSide(PassportElementErrorReverseSide value), required TResult selfie(PassportElementErrorSelfie value), required TResult file(PassportElementErrorFile value), required TResult files(PassportElementErrorFiles value), required TResult translationFile(PassportElementErrorTranslationFile value), required TResult translationFiles(PassportElementErrorTranslationFiles value), required TResult unspecified(PassportElementErrorUnspecified value)}) → TResult

Available on PassportElementError, provided by the PassportElementErrorPatterns extension

A switch-like method, using callbacks.
mapOrNull<TResult extends Object?>({TResult? dataField(PassportElementErrorDataField value)?, TResult? frontSide(PassportElementErrorFrontSide value)?, TResult? reverseSide(PassportElementErrorReverseSide value)?, TResult? selfie(PassportElementErrorSelfie value)?, TResult? file(PassportElementErrorFile value)?, TResult? files(PassportElementErrorFiles value)?, TResult? translationFile(PassportElementErrorTranslationFile value)?, TResult? translationFiles(PassportElementErrorTranslationFiles value)?, TResult? unspecified(PassportElementErrorUnspecified value)?}) → TResult?

Available on PassportElementError, provided by the PassportElementErrorPatterns extension

A variant of map that fallback to returning null.
maybeMap<TResult extends Object?>({TResult dataField(PassportElementErrorDataField value)?, TResult frontSide(PassportElementErrorFrontSide value)?, TResult reverseSide(PassportElementErrorReverseSide value)?, TResult selfie(PassportElementErrorSelfie value)?, TResult file(PassportElementErrorFile value)?, TResult files(PassportElementErrorFiles value)?, TResult translationFile(PassportElementErrorTranslationFile value)?, TResult translationFiles(PassportElementErrorTranslationFiles value)?, TResult unspecified(PassportElementErrorUnspecified value)?, required TResult orElse()}) → TResult

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

Operators

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