Platform resources

AccountsResourceCopy Anchor Link

class AccountsResource

Accounts the signed-in user belongs to. Reached through ovok.accounts.

Every request throws an OvokException subclass when it fails.

ConstructorsCopy Anchor Link

AccountsResource.newCopy Anchor Link

AccountsResource(HttpClient _http)

Built by Ovok; use ovok.accounts instead.

MethodsCopy Anchor Link

AccountsResource.listCopy Anchor Link

Future<List<JsonMap>> list()

Lists the signed-in user's accounts. Calls GET accounts.

Returns Future<List<Map<String, dynamic>>>.

EmailResourceCopy Anchor Link

class EmailResource

The project's email setup. Reached through ovok.email.

Every request throws an OvokException subclass when it fails.

ConstructorsCopy Anchor Link

EmailResource.newCopy Anchor Link

EmailResource(HttpClient http)

Built by Ovok; use ovok.email instead.

PropertiesCopy Anchor Link

EmailResource.templatesCopy Anchor Link

final EmailTemplatesResource templates

The project's email templates.

EmailTemplatesResourceCopy Anchor Link

class EmailTemplatesResource

The project's email templates. Reached through ovok.email.templates.

ConstructorsCopy Anchor Link

EmailTemplatesResource.newCopy Anchor Link

EmailTemplatesResource(HttpClient _http)

Built by Ovok; use ovok.email.templates instead.

MethodsCopy Anchor Link

EmailTemplatesResource.listCopy Anchor Link

Future<JsonMap> list()

Lists the email templates. Calls GET v1/email/templates.

Returns Future<Map<String, dynamic>>.

I18nextResourceCopy Anchor Link

class I18nextResource

A language's strings as one i18next document.

Reached through ovok.localizations.i18next.

ConstructorsCopy Anchor Link

I18nextResource.newCopy Anchor Link

I18nextResource(HttpClient _http)

Built by Ovok; use ovok.localizations.i18next instead.

MethodsCopy Anchor Link

I18nextResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve(String language)

Retrieves language as an i18next document.

Calls GET localization/i18next/{language}.

Returns Future<Map<String, dynamic>>.

I18nextResource.updateCopy Anchor Link

Future<void> update(String language, JsonMap document)

Merges document into language.

Calls PATCH localization/i18next/{language}. The server queues the write (202), so a read right after may not show it yet.

Returns Future<void>.

InviteFlowResourceCopy Anchor Link

class InviteFlowResource

One invite kind: create sends it, accept redeems it at {path}/accept.

Reached through the fields of ovok.invites.

ConstructorsCopy Anchor Link

InviteFlowResource.newCopy Anchor Link

InviteFlowResource(HttpClient _http, String _path)

Built by Ovok; use a field of ovok.invites instead.

MethodsCopy Anchor Link

InviteFlowResource.createCopy Anchor Link

Future<JsonMap> create(JsonMap body)

Sends an invite. Calls POST {path}.

Returns Future<Map<String, dynamic>>.

InviteFlowResource.acceptCopy Anchor Link

Future<JsonMap> accept(JsonMap body)

Accepts an invite. Calls POST {path}/accept.

Returns Future<Map<String, dynamic>>.

InvitesResourceCopy Anchor Link

class InvitesResource

Invites between patients, practitioners and carers. Reached through ovok.invites.

Every request throws an OvokException subclass when it fails.

ConstructorsCopy Anchor Link

InvitesResource.newCopy Anchor Link

InvitesResource(HttpClient http, UserSession session)

Built by Ovok; use ovok.invites instead.

PropertiesCopy Anchor Link

InvitesResource.recordSharesCopy Anchor Link

final InviteFlowResource recordShares

A patient shares their record with a practitioner, or some codes with a carer.

Routes under v1/invites/record-share.

InvitesResource.careCopy Anchor Link

final InviteFlowResource care

A practitioner invites a patient into their care.

Routes under v1/invites/care.

InvitesResource.practitionersCopy Anchor Link

final InviteFlowResource practitioners

Practitioner invites; use recordShares instead.

Routes under v1/invites/practitioner, which sunset on 2026-12-01.

InvitesResource.patientsCopy Anchor Link

final InviteFlowResource patients

Patient invites; use care instead.

Routes under v1/invites/patient, which sunset on 2026-12-01.

MethodsCopy Anchor Link

InvitesResource.acceptCopy Anchor Link

Future<JsonMap> accept(JsonMap body)

Accepts a record share as a practitioner or a care invite as a patient.

Picks recordShares or care from the signed-in profile's type. Throws OvokConfigException when no Patient or Practitioner is signed in.

Returns Future<Map<String, dynamic>>.

LocalesResourceCopy Anchor Link

class LocalesResource

Languages the project offers. Reached through ovok.locales.

Every request throws an OvokException subclass when it fails.

ConstructorsCopy Anchor Link

LocalesResource.newCopy Anchor Link

LocalesResource(HttpClient _http)

Built by Ovok; use ovok.locales instead.

MethodsCopy Anchor Link

LocalesResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve()

Retrieves the project's locales. Calls GET locales.

Returns Future<Map<String, dynamic>>.

LocalesResource.updateCopy Anchor Link

Future<JsonMap> update(JsonMap locales)

Updates the project's locales. Calls PATCH locales.

Returns Future<Map<String, dynamic>>.

LocalizationsResourceCopy Anchor Link

class LocalizationsResource

Translated strings, by language and key. Reached through ovok.localizations.

Every request throws an OvokException subclass when it fails.

ConstructorsCopy Anchor Link

LocalizationsResource.newCopy Anchor Link

LocalizationsResource(HttpClient http)

Built by Ovok; use ovok.localizations instead.

PropertiesCopy Anchor Link

LocalizationsResource.i18nextCopy Anchor Link

final I18nextResource i18next

Whole-language documents in i18next format.

MethodsCopy Anchor Link

LocalizationsResource.listCopy Anchor Link

Future<JsonMap> list(String language, [QueryParams query = const {}])

Lists the strings of language. Calls GET localization/{language}.

Returns Future<Map<String, dynamic>>.

LocalizationsResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve(String language, String key)

Retrieves one string. Calls GET localization/{language}/{key}.

Returns Future<Map<String, dynamic>>.

LocalizationsResource.updateCopy Anchor Link

Future<JsonMap> update(
  String language,
  String key,
  JsonMap body,
)

Updates one string. Calls PUT localization/{language}/{key}.

Returns Future<Map<String, dynamic>>.

LocalizationsResource.deleteCopy Anchor Link

Future<void> delete(String language, String key)

Deletes one string. Calls DELETE localization/{language}/{key}.

Returns Future<void>.

ProjectFeaturesResourceCopy Anchor Link

class ProjectFeaturesResource

Features enabled on the current project. Reached through ovok.projects.features.

ConstructorsCopy Anchor Link

ProjectFeaturesResource.newCopy Anchor Link

ProjectFeaturesResource(HttpClient _http)

Built by Ovok; use ovok.projects.features instead.

MethodsCopy Anchor Link

ProjectFeaturesResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve()

Retrieves the project's features. Calls GET v1/projects/me/features.

Returns Future<Map<String, dynamic>>.

ProjectFeaturesResource.updateCopy Anchor Link

Future<JsonMap> update(List<String> features)

Sets the project's features. Calls PATCH v1/projects/me/features.

Returns Future<Map<String, dynamic>>.

ProjectMembersResourceCopy Anchor Link

class ProjectMembersResource

Memberships of the current project. Reached through ovok.projects.members.

ConstructorsCopy Anchor Link

ProjectMembersResource.newCopy Anchor Link

ProjectMembersResource(HttpClient _http)

Built by Ovok; use ovok.projects.members instead.

MethodsCopy Anchor Link

ProjectMembersResource.listCopy Anchor Link

Future<Page<JsonMap>> list([QueryParams query = const {}])

Lists the project's members. Calls GET v1/projects/me/members with query.

Returns Future<Page<Map<String, dynamic>>>.

ProjectMembersResource.inviteCopy Anchor Link

Future<JsonMap> invite(JsonMap body)

Invites a member into the project. Calls POST v1/projects/me/members.

Returns Future<Map<String, dynamic>>.

ProjectMembersResource.updateCopy Anchor Link

Future<JsonMap> update(String membershipId, JsonMap body)

Updates a membership.

Calls PATCH v1/projects/me/members/{membershipId}.

Returns Future<Map<String, dynamic>>.

ProjectMembersResource.removeCopy Anchor Link

Future<JsonMap> remove(String membershipId)

Removes a member from the project.

Calls DELETE v1/projects/me/members/{membershipId}.

Returns Future<Map<String, dynamic>>.

ProjectSettingsResourceCopy Anchor Link

class ProjectSettingsResource

Settings of the current project. Reached through ovok.projects.settings.

ConstructorsCopy Anchor Link

ProjectSettingsResource.newCopy Anchor Link

ProjectSettingsResource(HttpClient _http)

Built by Ovok; use ovok.projects.settings instead.

MethodsCopy Anchor Link

ProjectSettingsResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve()

Retrieves the project's settings. Calls GET v1/project/settings.

Returns Future<Map<String, dynamic>>.

ProjectSettingsResource.updateCopy Anchor Link

Future<JsonMap> update(String key, bool enabled)

Turns the on/off setting key on or off.

Calls PUT v1/project/settings/{key} with {enabled}.

Returns Future<Map<String, dynamic>>.

ProjectSettingsResource.updateTextCopy Anchor Link

Future<JsonMap> updateText(String key, String? value)

Sets the text setting key to value; null clears it.

Calls PUT v1/project/settings/values/{key} with {value}.

Returns Future<Map<String, dynamic>>.

ProjectsResourceCopy Anchor Link

class ProjectsResource

Projects, their members, settings and features. Reached through ovok.projects.

Every request throws an OvokException subclass when it fails.

ConstructorsCopy Anchor Link

ProjectsResource.newCopy Anchor Link

ProjectsResource(HttpClient http)

Built by Ovok; use ovok.projects instead.

PropertiesCopy Anchor Link

ProjectsResource.membersCopy Anchor Link

final ProjectMembersResource members

Members of the current project.

ProjectsResource.settingsCopy Anchor Link

final ProjectSettingsResource settings

Settings of the current project.

ProjectsResource.featuresCopy Anchor Link

final ProjectFeaturesResource features

Features enabled on the current project.

MethodsCopy Anchor Link

ProjectsResource.listCopy Anchor Link

Future<Page<JsonMap>> list([QueryParams query = const {}])

Lists the projects the caller administers, wherever they are signed in.

Calls GET v1/projects with query; the Page fetches later pages.

Returns Future<Page<Map<String, dynamic>>>.

SharingInvitesResourceCopy Anchor Link

class SharingInvitesResource

Sharing invites. Reached through ovok.sharing.invites.

ConstructorsCopy Anchor Link

SharingInvitesResource.newCopy Anchor Link

SharingInvitesResource(HttpClient _http)

Built by Ovok; use ovok.sharing.invites instead.

MethodsCopy Anchor Link

SharingInvitesResource.createCopy Anchor Link

Future<JsonMap> create(JsonMap body)

Creates a sharing invite. Calls POST v1/patient-sharing/invites.

Returns Future<Map<String, dynamic>>.

SharingInvitesResource.redeemCopy Anchor Link

Future<JsonMap> redeem(JsonMap body)

Redeems a sharing invite.

Calls POST v1/patient-sharing/invites/redeem.

Returns Future<Map<String, dynamic>>.

SharingResourceCopy Anchor Link

class SharingResource

A patient's record sharing. Reached through ovok.sharing.

Every request throws an OvokException subclass when it fails.

ConstructorsCopy Anchor Link

SharingResource.newCopy Anchor Link

SharingResource(HttpClient http)

Built by Ovok; use ovok.sharing instead.

PropertiesCopy Anchor Link

SharingResource.invitesCopy Anchor Link

final SharingInvitesResource invites

Sharing invites the patient sends and redeems.

SharingResource.sharesCopy Anchor Link

final SharingSharesResource shares

Shares the patient has given and received.

SharingResource.settingsCopy Anchor Link

final SharingSettingsResource settings

The patient's sharing settings.

SharingSettingsResourceCopy Anchor Link

class SharingSettingsResource

The patient's sharing settings. Reached through ovok.sharing.settings.

ConstructorsCopy Anchor Link

SharingSettingsResource.newCopy Anchor Link

SharingSettingsResource(HttpClient _http)

Built by Ovok; use ovok.sharing.settings instead.

MethodsCopy Anchor Link

SharingSettingsResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve()

Retrieves the sharing settings. Calls GET v1/patient-sharing/settings.

Returns Future<Map<String, dynamic>>.

SharingSettingsResource.updateCopy Anchor Link

Future<JsonMap> update(JsonMap settings)

Replaces the sharing settings. Calls PUT v1/patient-sharing/settings.

Returns Future<Map<String, dynamic>>.

SharingSharesResourceCopy Anchor Link

class SharingSharesResource

Shares given and received. Reached through ovok.sharing.shares.

ConstructorsCopy Anchor Link

SharingSharesResource.newCopy Anchor Link

SharingSharesResource(HttpClient _http)

Built by Ovok; use ovok.sharing.shares instead.

MethodsCopy Anchor Link

SharingSharesResource.listCopy Anchor Link

Future<JsonMap> list()

Lists the shares. Calls GET v1/patient-sharing/shares.

practitioners, relatedPersons and received are always lists, empty when an older server leaves them out.

Returns Future<Map<String, dynamic>>.

SharingSharesResource.revokeCopy Anchor Link

Future<void> revoke(String consentId)

Revokes the share recorded by consentId.

Calls DELETE v1/patient-sharing/shares/{consentId}.

Returns Future<void>.