Session

OvokReferenceCopy Anchor Link

class OvokReference

A FHIR reference such as Project/123, with an optional display name.

ConstructorsCopy Anchor Link

OvokReference.newCopy Anchor Link

OvokReference(String reference, {String? display})

Creates a reference to reference, labelled display.

OvokReference.fromJsonCopy Anchor Link

OvokReference.fromJson(Map<String, dynamic> json)

Reads a FHIR Reference object; a non-string display becomes null.

PropertiesCopy Anchor Link

OvokReference.referenceCopy Anchor Link

final String reference

The relative reference, such as Patient/123.

OvokReference.displayCopy Anchor Link

final String? display

The human-readable label, when the server sent one.

MethodsCopy Anchor Link

OvokReference.toJsonCopy Anchor Link

Map<String, Object?> toJson()

The FHIR Reference JSON this was read from.

Returns Map<String, Object?>.

SessionCopy Anchor Link

class Session

The signed-in user's tokens; stored with the same JSON keys as @ovok/core/next.

ConstructorsCopy Anchor Link

Session.newCopy Anchor Link

Session({
  required String accessToken,
  required String? refreshToken,
  required DateTime expiresAt,
  required OvokReference project,
  required OvokReference profile,
})

Creates a session from its parts; sign-in builds one for you.

Session.fromLoginCopy Anchor Link

Session.fromLogin(Map<String, dynamic> tokens, DateTime now)

Reads a login, register or social sign-in response.

PropertiesCopy Anchor Link

Session.accessTokenCopy Anchor Link

final String accessToken

The bearer token sent with each request.

Session.refreshTokenCopy Anchor Link

final String? refreshToken

Exchanged for a new accessToken; null when the sign-in issued none.

Session.expiresAtCopy Anchor Link

final DateTime expiresAt

When accessToken expires.

Session.projectCopy Anchor Link

final OvokReference project

The project (tenant) the user signed in to.

Session.profileCopy Anchor Link

final OvokReference profile

The signed-in user's profile resource, such as Patient/123.

Session.canRefreshCopy Anchor Link

bool get canRefresh

Whether the session holds a refresh token.

MethodsCopy Anchor Link

Session.fromJsonCopy Anchor Link

Session? fromJson(Object? json)

Null for anything but a complete stored session.

Returns Session?.

Session.isStaleAtCopy Anchor Link

bool isStaleAt(DateTime now)

Stale a minute early, so a token never expires between the check and the request.

Returns bool.

Session.refreshedWithCopy Anchor Link

Session refreshedWith(Map<String, dynamic> token, DateTime now)

Reads an /oauth2/token response; a missing refresh token keeps the current one.

Returns Session.

Session.toJsonCopy Anchor Link

Map<String, Object?> toJson()

The stored form, which Session.fromJson reads back.

Returns Map<String, Object?>.