Sign in results
Generated reference for ovok_sdk: sign in results.
- Stable unknown
- Release candidate since 0.1.0-rc.4
- Development since 0.1.0-dev.23+d339d81
ClinicianInvite
final class ClinicianInvite implements RegisterResultThe project routed the email to a clinician invitation; no one is signed in.
Constructors
ClinicianInvite.new
ClinicianInvite()The registration ended in a clinician invitation.
LoginResult
sealed class LoginResultWhat ovok.auth.login and ovok.auth.verifyMfa return.
MfaChallenge
class MfaChallengeHand it back to verifyMfa: it carries the PKCE verifier the token exchange needs.
Constructors
MfaChallenge.new
MfaChallenge({
required ProfileType profileType,
required String loginId,
required String codeVerifier,
})A challenge from a login that needs a second factor.
| Parameter | Type | Kind | Default |
|---|---|---|---|
profileType | ProfileType | required named | |
loginId | String | required named | |
codeVerifier | String | required named |
Properties
MfaChallenge.profileType
final ProfileType profileTypeThe profile type the login started with.
MfaChallenge.loginId
final String loginIdThe server's id for the pending login.
MfaChallenge.codeVerifier
final String codeVerifierThe PKCE verifier of the pending login.
MfaRequired
final class MfaRequired implements LoginResultThe login needs a second factor; pass challenge to
ovok.auth.verifyMfa with the user's code.
Constructors
MfaRequired.new
MfaRequired(MfaChallenge challenge)Wraps the pending challenge.
| Parameter | Type | Kind | Default |
|---|---|---|---|
challenge | MfaChallenge | positional |
Properties
MfaRequired.challenge
final MfaChallenge challengeThe challenge to hand back to ovok.auth.verifyMfa.
ProfileType
enum ProfileTypeThe kind of profile an account signs in or registers as.
Values
ProfileType.patient
static const ProfileType patientA FHIR Patient.
ProfileType.practitioner
static const ProfileType practitionerA FHIR Practitioner.
ProfileType.relatedPerson
static const ProfileType relatedPersonA FHIR RelatedPerson.
Constructors
ProfileType.new
ProfileType(String resourceType)| Parameter | Type | Kind | Default |
|---|---|---|---|
resourceType | String | positional |
Properties
ProfileType.resourceType
final String resourceTypeThe FHIR resource type the profile is stored as.
RegisterResult
sealed class RegisterResultWhat ovok.auth.register returns.
SignedIn
final class SignedIn implements LoginResult, RegisterResultThe user is signed in with session.
Constructors
SignedIn.new
SignedIn(Session session)Wraps the new session.
| Parameter | Type | Kind | Default |
|---|---|---|---|
session | Session | positional |
Properties
SignedIn.session
final Session sessionThe session that was started and stored.
Last updated on