Provides the authentication key for the client, with a method to refresh it.
- Implemented types
Properties
-
authHeaderValue
→ Future<
String?> -
A valid authentication header value. Should be used for all requests.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
refreshAuthKey(
{bool force = false}) → Future< RefreshAuthKeyResult> -
Refreshes the authentication key and returns the result of the operation.
If the refresh is successful, should return RefreshAuthKeyResult.success
to retry requests that failed due to authentication errors. Be sure to
annotate the refresh endpoint with @unauthenticatedClientCall to avoid a
deadlock on the authHeaderValue getter on a refresh call. If the
forceparameter is set to true, the refresh should be performed regardless of skip conditions that the provider might have. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited