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
Annotations
  • @Freezed(fromJson: true, toJson: true, unionKey: 'source', unionValueCase: FreezedUnionCase.snake)

Constructors

PassportElementError.dataField({@Default(PassportElementErrorSource.data) PassportElementErrorSource source, required PassportType type, required String message, @JsonKey(name: 'field_name') required String fieldName, @JsonKey(name: 'data_hash') required String dataHash})
Represents an error in data provided by the user
const
factory
PassportElementError.file({@JsonKey(name: 'source') @Default(PassportElementErrorSource.file) PassportElementErrorSource source, @JsonKey(name: 'type') required PassportType type, @JsonKey(name: 'message') required String message, @JsonKey(name: 'file_hash') required String fileHash})
Represents an error in a file
const
factory
PassportElementError.files({@JsonKey(name: 'source') @Default(PassportElementErrorSource.files) PassportElementErrorSource source, @JsonKey(name: 'type') required PassportType type, @JsonKey(name: 'message') required String message, @JsonKey(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(PassportElementErrorSource.frontSide) @JsonKey(name: 'source') PassportElementErrorSource source, @JsonKey(name: 'type') required PassportType type, @JsonKey(name: 'message') required String message, @JsonKey(name: 'file_hash') required String fileHash})
Represents an error in the front side of a document
const
factory
PassportElementError.reverseSide({@JsonKey(name: 'source') @Default(PassportElementErrorSource.reverseSide) PassportElementErrorSource source, @JsonKey(name: 'type') required PassportType type, @JsonKey(name: 'message') required String message, @JsonKey(name: 'file_hash') required String fileHash})
Represents an error in the reverse side of a document
const
factory
PassportElementError.selfie({@JsonKey(name: 'source') @Default(PassportElementErrorSource.selfie) PassportElementErrorSource source, @JsonKey(name: 'type') required PassportType type, @JsonKey(name: 'message') required String message, @JsonKey(name: 'file_hash') required String fileHash})
Represents an error in the selfie with a document
const
factory
PassportElementError.translationFile({@JsonKey(name: 'source') @Default(PassportElementErrorSource.translationFile) PassportElementErrorSource source, @JsonKey(name: 'type') required PassportType type, @JsonKey(name: 'message') required String message, @JsonKey(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(name: 'source') @Default(PassportElementErrorSource.translationFiles) PassportElementErrorSource source, @JsonKey(name: 'type') required PassportType type, @JsonKey(name: 'message') required String message, @JsonKey(name: 'file_hashes') required List<String> fileHashes})
Represents an error in the translated version of a document
const
factory
PassportElementError.unspecified({@JsonKey(name: 'source') @Default(PassportElementErrorSource.unspecified) PassportElementErrorSource source, @JsonKey(name: 'type') required PassportType type, @JsonKey(name: 'message') required String message, @JsonKey(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

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