OidcToken class

Represents a serializable token.

The only thing required for this token is its creationTime, which represents the reference date of the expiresIn duration.

Annotations

@JsonSerializable.new(createFactory: true, createToJson: true, explicitToJson: true, includeIfNull: false, createFieldMap: true)

Constructors

OidcToken({required DateTime creationTime, List<String>? scope, String? accessToken, String? tokenType, String? idToken, Duration? expiresIn, String? refreshToken, Map<String, dynamic>? extra, String? sessionState})
OidcToken.fromJson(Map<String, dynamic> src): factory
OidcToken.fromResponse(OidcTokenResponse response, {required String? sessionState, DateTime? creationTime, Duration? overrideExpiresIn}): factory

accessToken ↔ String?: OPTIONAL.
getter/setter pair
creationTime ↔ DateTime: Store when this token was originally created.
getter/setter pair
expiresIn ↔ Duration?: RECOMMENDED.
getter/setter pair
extra ↔ Map<String, dynamic>?: getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
idToken ↔ String?: REQUIRED, in the OIDC spec.
getter/setter pair
isOidc → bool: no setter
refreshToken ↔ String?: OPTIONAL.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
scope ↔ List<String>?: getter/setter pair
sessionState ↔ String?: The received session state.
getter/setter pair
tokenType ↔ String?: REQUIRED.
getter/setter pair

calculateExpiresAt({DateTime? overrideCreationTime}) → DateTime?: Calculates the expiry date of the access token from expiresIn and overrideCreationTime.
calculateExpiresInFromNow({DateTime? now, DateTime? overrideCreationTime}) → Duration?
isAccessTokenAboutToExpire({DateTime? now, DateTime? overrideCreationTime, Duration tolerance = const Duration(minutes: 1)}) → bool: Returns true if access token expired or is about to expire.
isAccessTokenExpired({DateTime? now, DateTime? overrideCreationTime}) → bool: Returns true if access token expired or is about to expire.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>: Returns a serializable json representation of this token.
toString() → String: A string representation of this object.
inherited