AuthOptions class
Configuration options for authentication handling.
Constructors
-
AuthOptions.new({bool useSecureStorage = true, String refreshTokenEndpoint = '', String refreshTokenParameterName = '', RefreshTokenStrategy refreshTokenExecutionType = RefreshTokenStrategy.responseAndRetry, List<
String> ignoreAuthForPaths = const [], String resolveJwt(dynamic response)?, String resolveRefreshToken(dynamic response)?, dynamic refreshTokenBodyBuilder(String jwt, String refreshToken)?, Map<String, dynamic> ? refreshTokenHeadersBuilder(String jwt, String refreshToken)?}) -
Constructor to initialize the AuthOptions class with default values.
const
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
-
ignoreAuthForPaths
→ List<
String> -
List of paths that do not require authentication.
final
- refreshTokenBodyBuilder → dynamic Function(String jwt, String refreshToken)?
-
Function to build the body for the refresh token request.
final
- refreshTokenEndpoint → String
-
The endpoint for refreshing tokens.
final
- refreshTokenExecutionType → RefreshTokenStrategy
-
Strategy for handling refresh token requests.
final
-
refreshTokenHeadersBuilder
→ Map<
String, dynamic> ? Function(String jwt, String refreshToken)? -
Function to build headers for the refresh token request.
final
- refreshTokenParameterName → String
-
Parameter name used for the refresh token in requests.
final
- resolveJwt → String Function(dynamic response)?
-
Function to extract the JWT from the response.
final
- resolveRefreshToken → String Function(dynamic response)?
-
Function to extract the refresh token from the response.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- useSecureStorage → bool
-
Indicates whether to use secure storage for sensitive tokens.
final
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