ApiException class

Exception representing HTTP / API-layer failures. Enriches context with normalized HTTP status metadata.

Inheritance
Annotations

Constructors

ApiException({required HttpStatusCodeInfo httpStatusInfo, String? endpoint, String? method, Map<String, dynamic> requestHeaders = const {}, Object? requestBody, Map<String, dynamic> responseHeaders = const {}, Object? responseBody, String? userMessage, String? devMessage, Object? cause, StackTrace? stack, Map<String, dynamic> metadata = const {}, Severity? severity, bool isReportable = true})
Creates an API exception enriched with normalized HTTP status metadata.

Properties

cause → Object?
Original underlying error, if any.
finalinherited
devMessage → String
Developer-friendly details, safe for logs and tools.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
httpStatusInfo → HttpStatusCodeInfo
Normalized view of status code + semantic flags.
final
isReportable → bool
Whether this exception should be reported automatically.
finalinherited
metadata → Map<String, dynamic>
Additional diagnostic data related to this exception.
finalinherited
props → List<Object?>
The list of properties that will be used to determine whether two instances are equal.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
severity → Severity
How serious this exception is.
finalinherited
stack → StackTrace?
Capture location. Defaults to StackTrace.current when not provided.
finalinherited
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited
userMessage → String
Human-friendly text appropriate for end-users.
finalinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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