Failure class sealed

Система ошибок приложения

Иерархия: Failure ├── NetworkFailure — проблемы соединения ├── HttpFailure — HTTP-ответы с ошибками (4xx / 5xx) ├── AuthFailure — аутентификация / авторизация ├── ValidationFailure — валидация данных ├── StorageFailure — SharedPreferences / SecureStorage / FileSystem ├── DatabaseFailure — локальная БД (Drift, Isar, SQLite) ├── CacheFailure — кэш ├── ParseFailure — парсинг / сериализация ├── PermissionFailure — разрешения ОС ├── PlatformFailure — MethodChannel / плагины / ОС ├── FileFailure — работа с файлами ├── LocationFailure — геолокация ├── NotificationFailure — push-уведомления ├── PaymentFailure — платежи ├── SyncFailure — синхронизация данных └── UnknownFailure — непредвиденные ошибки

Available extensions

• FailurePatterns
• FailureUserMessageX

Annotations

• @freezed

Constructors

Failure.auth({required AuthFailure type, String? message})

Ошибки аутентификации и авторизации

const

factory

Failure.cache({required CacheFailure type, String? key})

Ошибки кэша

const

factory

Failure.database({required DatabaseFailure type, String? message})

Ошибки локальной базы данных

const

factory

Failure.file({required FileFailure type, String? path, String? message})

Ошибки работы с файлами

const

factory

Failure.http({required HttpFailure type, int? statusCode, String? message, String? requestId, @Default.new({}) Map<String, List<String>> fieldErrors})

HTTP-ошибки (4xx / 5xx)

const

factory

Failure.location({required LocationFailure type, String? message})

Ошибки геолокации

const

factory

Failure.network({required NetworkFailure type, String? requestId})

Проблемы соединения

const

factory

Failure.notification({required NotificationFailure type, String? message})

Ошибки push-уведомлений

const

factory

Failure.parse({required ParseFailure type, String? field, String? message})

Ошибки парсинга / сериализации

const

factory

Failure.payment({required PaymentFailure type, String? message, String? transactionId})

Ошибки платежей

const

factory

Failure.permission({required PermissionFailure type, String? permission})

Ошибки разрешений ОС

const

factory

Failure.platform({required PlatformFailure type, String? details})

Ошибки платформы (MethodChannel, плагины, ОС)

const

factory

Failure.storage({required StorageFailure type, String? key, String? message})

Ошибки локального хранилища

const

factory

Failure.sync({required SyncFailure type, String? message})

Ошибки синхронизации данных

const

factory

Failure.unknown({Object? error, StackTrace? stackTrace, String? message})

Непредвиденная ошибка

const

factory

Failure.validation({required ValidationFailure type, String? field, String? message, @Default.new({}) Map<String, List<String>> fieldErrors})

Ошибки валидации данных

const

factory

Properties

code → String

Стабильный код (network.no_internet, http.unauthorized, …) для аналитики и crash-репортов.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

isRetryable → bool

Можно ли повторить запрос автоматически?

no setter

logCategory → String

Категория для логирования / аналитики

no setter

requiresLogout → bool

Требует ли выхода из аккаунта?

no setter

requiresSettings → bool

Требует ли открытия настроек устройства?

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

userMessage → String

Человеко-читаемое сообщение для UI (русский по умолчанию).

no setter

Methods

localizedMessage(FailureUserMessageCatalog catalog) → String

Available on Failure, provided by the FailureUserMessageX extension

Возвращает сообщение для UI из указанного каталога.

map<TResult extends Object?>({required TResult network(NetworkAppFailure value), required TResult http(HttpAppFailure value), required TResult auth(AuthAppFailure value), required TResult validation(ValidationAppFailure value), required TResult storage(StorageAppFailure value), required TResult database(DatabaseAppFailure value), required TResult cache(CacheAppFailure value), required TResult parse(ParseAppFailure value), required TResult permission(PermissionAppFailure value), required TResult platform(PlatformAppFailure value), required TResult file(FileAppFailure value), required TResult location(LocationAppFailure value), required TResult notification(NotificationAppFailure value), required TResult payment(PaymentAppFailure value), required TResult sync(SyncAppFailure value), required TResult unknown(UnknownAppFailure value)}) → TResult

Available on Failure, provided by the FailurePatterns extension

A switch-like method, using callbacks.

mapOrNull<TResult extends Object?>({TResult? network(NetworkAppFailure value)?, TResult? http(HttpAppFailure value)?, TResult? auth(AuthAppFailure value)?, TResult? validation(ValidationAppFailure value)?, TResult? storage(StorageAppFailure value)?, TResult? database(DatabaseAppFailure value)?, TResult? cache(CacheAppFailure value)?, TResult? parse(ParseAppFailure value)?, TResult? permission(PermissionAppFailure value)?, TResult? platform(PlatformAppFailure value)?, TResult? file(FileAppFailure value)?, TResult? location(LocationAppFailure value)?, TResult? notification(NotificationAppFailure value)?, TResult? payment(PaymentAppFailure value)?, TResult? sync(SyncAppFailure value)?, TResult? unknown(UnknownAppFailure value)?}) → TResult?

Available on Failure, provided by the FailurePatterns extension

A variant of map that fallback to returning null.

maybeMap<TResult extends Object?>({TResult network(NetworkAppFailure value)?, TResult http(HttpAppFailure value)?, TResult auth(AuthAppFailure value)?, TResult validation(ValidationAppFailure value)?, TResult storage(StorageAppFailure value)?, TResult database(DatabaseAppFailure value)?, TResult cache(CacheAppFailure value)?, TResult parse(ParseAppFailure value)?, TResult permission(PermissionAppFailure value)?, TResult platform(PlatformAppFailure value)?, TResult file(FileAppFailure value)?, TResult location(LocationAppFailure value)?, TResult notification(NotificationAppFailure value)?, TResult payment(PaymentAppFailure value)?, TResult sync(SyncAppFailure value)?, TResult unknown(UnknownAppFailure value)?, required TResult orElse()}) → TResult

Available on Failure, provided by the FailurePatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>({TResult network(NetworkFailure type, String? requestId)?, TResult http(HttpFailure type, int? statusCode, String? message, String? requestId, Map<String, List<String>> fieldErrors)?, TResult auth(AuthFailure type, String? message)?, TResult validation(ValidationFailure type, String? field, String? message, Map<String, List<String>> fieldErrors)?, TResult storage(StorageFailure type, String? key, String? message)?, TResult database(DatabaseFailure type, String? message)?, TResult cache(CacheFailure type, String? key)?, TResult parse(ParseFailure type, String? field, String? message)?, TResult permission(PermissionFailure type, String? permission)?, TResult platform(PlatformFailure type, String? details)?, TResult file(FileFailure type, String? path, String? message)?, TResult location(LocationFailure type, String? message)?, TResult notification(NotificationFailure type, String? message)?, TResult payment(PaymentFailure type, String? message, String? transactionId)?, TResult sync(SyncFailure type, String? message)?, TResult unknown(Object? error, StackTrace? stackTrace, String? message)?, required TResult orElse()}) → TResult

Available on Failure, provided by the FailurePatterns extension

A variant of when that fallback to an orElse callback.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>({required TResult network(NetworkFailure type, String? requestId), required TResult http(HttpFailure type, int? statusCode, String? message, String? requestId, Map<String, List<String>> fieldErrors), required TResult auth(AuthFailure type, String? message), required TResult validation(ValidationFailure type, String? field, String? message, Map<String, List<String>> fieldErrors), required TResult storage(StorageFailure type, String? key, String? message), required TResult database(DatabaseFailure type, String? message), required TResult cache(CacheFailure type, String? key), required TResult parse(ParseFailure type, String? field, String? message), required TResult permission(PermissionFailure type, String? permission), required TResult platform(PlatformFailure type, String? details), required TResult file(FileFailure type, String? path, String? message), required TResult location(LocationFailure type, String? message), required TResult notification(NotificationFailure type, String? message), required TResult payment(PaymentFailure type, String? message, String? transactionId), required TResult sync(SyncFailure type, String? message), required TResult unknown(Object? error, StackTrace? stackTrace, String? message)}) → TResult

Available on Failure, provided by the FailurePatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>({TResult? network(NetworkFailure type, String? requestId)?, TResult? http(HttpFailure type, int? statusCode, String? message, String? requestId, Map<String, List<String>> fieldErrors)?, TResult? auth(AuthFailure type, String? message)?, TResult? validation(ValidationFailure type, String? field, String? message, Map<String, List<String>> fieldErrors)?, TResult? storage(StorageFailure type, String? key, String? message)?, TResult? database(DatabaseFailure type, String? message)?, TResult? cache(CacheFailure type, String? key)?, TResult? parse(ParseFailure type, String? field, String? message)?, TResult? permission(PermissionFailure type, String? permission)?, TResult? platform(PlatformFailure type, String? details)?, TResult? file(FileFailure type, String? path, String? message)?, TResult? location(LocationFailure type, String? message)?, TResult? notification(NotificationFailure type, String? message)?, TResult? payment(PaymentFailure type, String? message, String? transactionId)?, TResult? sync(SyncFailure type, String? message)?, TResult? unknown(Object? error, StackTrace? stackTrace, String? message)?}) → TResult?

Available on Failure, provided by the FailurePatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited