FreshNext<T extends TokenProtocol> class

Inheritance

• Object
• Fresh<T>
• FreshNext

Constructors

FreshNext({required TokenHeaderBuilder<T> tokenHeader, required TokenStorage<T> tokenStorage, required RefreshToken<T> refreshToken, ShouldRefresh? shouldRefresh, ShouldRefreshBeforeRequest<T>? shouldRefreshBeforeRequest, Dio? httpClient})

Properties

authenticationStatus → Stream<AuthenticationStatus>

Returns a Stream<AuthenticationStatus> which can be used to get notified of changes to the authentication state based on the presence/absence of a token.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

token → Future<T?>

Returns the current token.

no setter, inherited

tokenStorage ← TokenStorage<T>

Setter for the TokenStorage instance.

no getter, inherited

Methods

clearToken() → Future<void>

Clears token storage and updates the AuthenticationStatus to AuthenticationStatus.unauthenticated.

inherited

close() → Future<void>

Closes Fresh StreamController.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onError(DioError err, ErrorInterceptorHandler handler) → Future

The callback will be executed on error.

inherited

onRequest(RequestOptions options, RequestInterceptorHandler handler) → Future

The callback will be executed before the request is initiated.

override

onResponse(Response response, ResponseInterceptorHandler handler) → Future

The callback will be executed on success. If you want to continue the response, call handler.next.

inherited

revokeToken() → Future<void>

Delete the storaged token. and emit the AuthenticationStatus.unauthenticated if authenticationStatus not is AuthenticationStatus.unauthenticated This method should be called when the token is no longer valid.

inherited

setToken(T? token) → Future<void>

Sets the internal token to the provided token and updates the AuthenticationStatus accordingly.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

oAuth2({required TokenStorage<OAuth2TokenNext> tokenStorage, required RefreshToken<OAuth2TokenNext> refreshToken, ShouldRefresh? shouldRefresh, TokenHeaderBuilder<OAuth2TokenNext>? tokenHeader}) → FreshNext<OAuth2TokenNext>

A constructor that returns a Fresh interceptor that uses an OAuth2Token token.

override