ForbiddenException class
Exception for HTTP 403 Forbidden errors.
Thrown when the authenticated user lacks permission to access a resource or perform an action. Common scenarios include:
- Accessing another customer's orders
- Attempting admin-only operations
- Account lacks required privileges
Unlike UnauthorizedException, the user is authenticated but not authorized.
Example:
if (response.statusCode == 403) {
throw ForbiddenException(
message: 'You cannot edit orders for other customers',
originalException: dioError,
);
}
- Inheritance
-
- Object
- AppException
- NetworkAppException
- ForbiddenException
Constructors
- ForbiddenException({String? message, DioException? originalException, String? errorCode, String? traceId})
-
Creates a ForbiddenException with an optional custom
message.const
Properties
- errorCode → String?
-
A machine-readable error code from the backend's
ErrorResponseenvelope (e.g.VALIDATION_ERROR,TOO_MANY_REQUESTS), ornullif the response body didn't match that schema.finalinherited - hashCode → int
-
The hash code for this object.
no setterinherited
- message → String
-
A human-readable description of the error.
finalinherited
- originalException → DioException?
-
The underlying Dio exception that caused this network error.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- traceId → String?
-
The backend's request-trace identifier from the
ErrorResponseenvelope, for correlating this error with server-side logs — ornullif the response body didn't match that schema.finalinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
The string representation of this exception, including Dio-level details.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited