Slim resource

NotificationTargetKindCopy Anchor Link

enum NotificationTargetKind

The kind of notification a note is attached to; see SlimNotificationNotesResource.list.

ValuesCopy Anchor Link

NotificationTargetKind.oobCopy Anchor Link

static const NotificationTargetKind oob

An out-of-bed notification.

NotificationTargetKind.alarmCopy Anchor Link

static const NotificationTargetKind alarm

A device alarm.

NotificationTargetKind.medicalCopy Anchor Link

static const NotificationTargetKind medical

A medical episode.

NotificationTargetKind.alertCopy Anchor Link

static const NotificationTargetKind alert

A raw alert.

SlimAlarmsResourceCopy Anchor Link

class SlimAlarmsResource

Device alarms. Reached through ovok.slim.notifications.alarms.

ConstructorsCopy Anchor Link

SlimAlarmsResource.newCopy Anchor Link

SlimAlarmsResource(HttpClient _http)

Built by SlimNotificationsResource; use ovok.slim.notifications.alarms instead.

MethodsCopy Anchor Link

SlimAlarmsResource.listCopy Anchor Link

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

Lists alarms. Calls GET v1/slim/notifications/alarms.

Returns Future<Map<String, dynamic>>.

SlimAlarmsResource.recentCopy Anchor Link

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

Lists recent alarms. Calls GET v1/slim/notifications/recent/alarms.

Returns Future<Map<String, dynamic>>.

SlimAlarmsResource.acknowledgeCopy Anchor Link

Future<JsonMap> acknowledge(String notificationId)

Acknowledges an alarm. Calls PATCH v1/slim/notifications/{notificationId}/ack; safe to retry.

Returns Future<Map<String, dynamic>>.

SlimChangeHistoryResourceCopy Anchor Link

class SlimChangeHistoryResource

The change history of Slim resources. Reached through ovok.slim.changeHistory.

ConstructorsCopy Anchor Link

SlimChangeHistoryResource.newCopy Anchor Link

SlimChangeHistoryResource(HttpClient _http)

Built by SlimResource; use ovok.slim.changeHistory instead.

MethodsCopy Anchor Link

SlimChangeHistoryResource.listCopy Anchor Link

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

Lists changes. Calls GET v1/slim/change-history.

query filters the list; types is sent as repeated types[] and other lists repeat their key. Its page (0-based) is the first page loaded.

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

SlimChildProjectsResourceCopy Anchor Link

class SlimChildProjectsResource

Child projects. Reached through ovok.slim.projects.children.

ConstructorsCopy Anchor Link

SlimChildProjectsResource.newCopy Anchor Link

SlimChildProjectsResource(HttpClient _http)

Built by SlimProjectsResource; use ovok.slim.projects.children instead.

MethodsCopy Anchor Link

SlimChildProjectsResource.listCopy Anchor Link

Future<JsonMap> list()

Lists child projects. Calls GET v1/slim/project/child.

Returns Future<Map<String, dynamic>>.

SlimChildProjectsResource.createCopy Anchor Link

Future<JsonMap> create(JsonMap body)

Creates a child project from body. Calls POST v1/slim/project/child.

Returns Future<Map<String, dynamic>>.

SlimChildProjectsResource.deleteCopy Anchor Link

Future<JsonMap> delete(String subProjectId)

Deletes a child project. Calls DELETE v1/slim/project/child/{subProjectId}.

Returns Future<Map<String, dynamic>>.

SlimDevicesResourceCopy Anchor Link

class SlimDevicesResource

Devices in the Slim care API. Reached through ovok.slim.devices.

Identical live, liveTelemetry and telemetry reads made at the same time by the same signed-in user share one request.

ConstructorsCopy Anchor Link

SlimDevicesResource.newCopy Anchor Link

SlimDevicesResource(HttpClient http, [UserSession? session])

Built by SlimResource; use ovok.slim.devices instead.

MethodsCopy Anchor Link

SlimDevicesResource.listCopy Anchor Link

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

Lists devices. Calls GET v1/slim/device.

query filters the list; its page (0-based) is the first page loaded. The returned Page fetches the following pages.

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

SlimDevicesResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve(String deviceId)

Retrieves one device. Calls GET v1/slim/device/{deviceId}.

Returns Future<Map<String, dynamic>>.

SlimDevicesResource.createCopy Anchor Link

Future<JsonMap> create(JsonMap body)

Creates a device from body. Calls POST v1/slim/device.

Returns Future<Map<String, dynamic>>.

SlimDevicesResource.updateCopy Anchor Link

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

Replaces a device with body. Calls PUT v1/slim/device/{deviceId}.

Returns Future<Map<String, dynamic>>.

SlimDevicesResource.deleteCopy Anchor Link

Future<void> delete(String deviceId)

Deletes a device. Calls DELETE v1/slim/device/{deviceId}.

Returns Future<void>.

SlimDevicesResource.assignToProjectCopy Anchor Link

Future<JsonMap> assignToProject(JsonMap body)

Assigns devices to a project as body describes. Calls PUT v1/slim/device/assign/project.

Returns Future<Map<String, dynamic>>.

SlimDevicesResource.liveCopy Anchor Link

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

Lists devices with their live state. Calls GET v1/slim/device/live.

query filters the list; its page (0-based) is the first page loaded. Throws OvokValidationException before sending when count is not an integer from 1 to 100.

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

SlimDevicesResource.liveTelemetryCopy Anchor Link

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

Retrieves live telemetry keyed by device. Calls GET v1/slim/device/live/telemetry.

Throws OvokValidationException before sending when count in query is not an integer from 1 to 100.

Returns Future<Map<String, dynamic>>.

SlimDevicesResource.telemetryCopy Anchor Link

Future<JsonMap> telemetry(String deviceId)

Retrieves one device's telemetry. Calls GET v1/slim/telemetry/{deviceId}.

Returns Future<Map<String, dynamic>>.

SlimDevicesResource.effectiveObservationIdsCopy Anchor Link

Future<JsonMap> effectiveObservationIds(String deviceId)

Retrieves the IDs of the Observations in effect for one device. Calls GET v1/slim/telemetry/{deviceId}/effectiveIds.

Returns Future<Map<String, dynamic>>.

SlimDevicesResource.effectiveObservationIdsByDeviceCopy Anchor Link

Future<JsonMap> effectiveObservationIdsByDevice()

Retrieves the IDs of the Observations in effect, keyed by device. Calls GET v1/slim/telemetry/effectiveIds.

Returns Future<Map<String, dynamic>>.

SlimDevicesResource.lastObservationIdsCopy Anchor Link

Future<JsonMap> lastObservationIds(String deviceId)

Retrieves the IDs of one device's latest Observations. Calls GET v1/slim/telemetry/{deviceId}/lastIds.

Returns Future<Map<String, dynamic>>.

SlimDevicesResource.lastObservationIdsByDeviceCopy Anchor Link

Future<JsonMap> lastObservationIdsByDevice()

Retrieves the IDs of the latest Observations, keyed by device. Calls GET v1/slim/telemetry/lastIds.

Returns Future<Map<String, dynamic>>.

SlimExportsResourceCopy Anchor Link

class SlimExportsResource

PDF exports. Reached through ovok.slim.exports.

ConstructorsCopy Anchor Link

SlimExportsResource.newCopy Anchor Link

SlimExportsResource(HttpClient _http)

Built by SlimResource; use ovok.slim.exports instead.

MethodsCopy Anchor Link

SlimExportsResource.patientPdfCopy Anchor Link

Future<JsonMap> patientPdf(JsonMap body)

Exports a resident report as a PDF, as body describes. Calls POST v1/slim/export/pdf.

Returns Future<Map<String, dynamic>>.

SlimLocationsResourceCopy Anchor Link

class SlimLocationsResource

Locations such as rooms and beds. Reached through ovok.slim.locations.

ConstructorsCopy Anchor Link

SlimLocationsResource.newCopy Anchor Link

SlimLocationsResource(HttpClient _http)

Built by SlimResource; use ovok.slim.locations instead.

MethodsCopy Anchor Link

SlimLocationsResource.listCopy Anchor Link

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

Lists locations. Calls GET v1/slim/location.

query filters the list; its page (0-based) is the first page loaded. The returned Page fetches the following pages.

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

SlimLocationsResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve(String locationId)

Retrieves one location. Calls GET v1/slim/location/{locationId}.

Returns Future<Map<String, dynamic>>.

SlimLocationsResource.createCopy Anchor Link

Future<JsonMap> create(JsonMap body)

Creates a location from body. Calls POST v1/slim/location.

Returns Future<Map<String, dynamic>>.

SlimLocationsResource.updateCopy Anchor Link

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

Replaces a location with body. Calls PUT v1/slim/location/{locationId}.

Returns Future<Map<String, dynamic>>.

SlimLocationsResource.deleteCopy Anchor Link

Future<void> delete(String locationId)

Deletes a location. Calls DELETE v1/slim/location/{locationId}.

Returns Future<void>.

SlimMedicalNotificationsResourceCopy Anchor Link

class SlimMedicalNotificationsResource

Medical notification episodes. Reached through ovok.slim.notifications.medical.

ConstructorsCopy Anchor Link

SlimMedicalNotificationsResource.newCopy Anchor Link

SlimMedicalNotificationsResource(HttpClient _http)

Built by SlimNotificationsResource; use ovok.slim.notifications.medical instead.

MethodsCopy Anchor Link

SlimMedicalNotificationsResource.listCopy Anchor Link

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

Lists medical episodes. Calls GET v1/slim/notifications/medical.

query filters the list; a cursor in it starts from that page. The returned Page follows nextCursor and has no total. Fails with OvokValidationException before sending when codes is not a list of 1 to 32 LOINC codes or PI.

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

SlimMedicalNotificationsResource.recentCopy Anchor Link

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

Lists recent medical episodes. Calls GET v1/slim/notifications/recent/medical.

Returns Future<Map<String, dynamic>>.

SlimMedicalNotificationsResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve(String episodeId)

Retrieves one medical episode. Calls GET v1/slim/notifications/medical/{episodeId}.

Returns Future<Map<String, dynamic>>.

SlimMedicalNotificationsResource.acknowledgeCopy Anchor Link

Future<JsonMap> acknowledge(String episodeId)

Acknowledges a medical episode. Calls POST v1/slim/notifications/medical/{episodeId}/ack; safe to retry.

Returns Future<Map<String, dynamic>>.

SlimNotificationNotesResourceCopy Anchor Link

class SlimNotificationNotesResource

Notes on notifications. Reached through ovok.slim.notifications.notes.

ConstructorsCopy Anchor Link

SlimNotificationNotesResource.newCopy Anchor Link

SlimNotificationNotesResource(HttpClient _http)

Built by SlimNotificationsResource; use ovok.slim.notifications.notes instead.

MethodsCopy Anchor Link

SlimNotificationNotesResource.listCopy Anchor Link

Future<JsonMap> list(NotificationTargetKind kind, String targetId)

Lists the notes on one notification of kind. Calls GET v1/slim/notifications/{oob|alarms|medical|raw-alerts}/{targetId}/notes.

Returns Future<Map<String, dynamic>>.

SlimNotificationNotesResource.createCopy Anchor Link

Future<JsonMap> create(JsonMap body)

Creates a note from body. Calls POST v1/slim/notifications/notes.

Returns Future<Map<String, dynamic>>.

SlimNotificationNotesResource.updateCopy Anchor Link

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

Replaces a note with body. Calls PUT v1/slim/notifications/notes/{noteId}.

Returns Future<Map<String, dynamic>>.

SlimNotificationNotesResource.patchCopy Anchor Link

Future<JsonMap> patch(String noteId, JsonMap body)

Changes the fields of a note in body. Calls PATCH v1/slim/notifications/notes/{noteId}.

Returns Future<Map<String, dynamic>>.

SlimNotificationNotesResource.deleteCopy Anchor Link

Future<void> delete(String noteId)

Deletes a note. Calls DELETE v1/slim/notifications/notes/{noteId}.

Returns Future<void>.

SlimNotificationsResourceCopy Anchor Link

class SlimNotificationsResource

Notifications in the Slim care API. Reached through ovok.slim.notifications.

ConstructorsCopy Anchor Link

SlimNotificationsResource.newCopy Anchor Link

SlimNotificationsResource(HttpClient http)

Built by SlimResource; use ovok.slim.notifications instead.

PropertiesCopy Anchor Link

SlimNotificationsResource.alarmsCopy Anchor Link

final SlimAlarmsResource alarms

Device alarms.

SlimNotificationsResource.outOfBedCopy Anchor Link

final SlimOutOfBedResource outOfBed

Out-of-bed notifications.

SlimNotificationsResource.medicalCopy Anchor Link

final SlimMedicalNotificationsResource medical

Medical notification episodes.

SlimNotificationsResource.notesCopy Anchor Link

final SlimNotificationNotesResource notes

Notes on notifications.

MethodsCopy Anchor Link

SlimNotificationsResource.listCopy Anchor Link

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

Lists notifications of every kind. Calls GET v1/slim/notifications.

Returns Future<Map<String, dynamic>>.

SlimNotificationsResource.recentCopy Anchor Link

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

Lists recent notifications of every kind. Calls GET v1/slim/notifications/recent.

Returns Future<Map<String, dynamic>>.

SlimOrganizationsResourceCopy Anchor Link

class SlimOrganizationsResource

Organizations. Reached through ovok.slim.organizations.

ConstructorsCopy Anchor Link

SlimOrganizationsResource.newCopy Anchor Link

SlimOrganizationsResource(HttpClient _http)

Built by SlimResource; use ovok.slim.organizations instead.

MethodsCopy Anchor Link

SlimOrganizationsResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve(String organizationId)

Retrieves one organization. Calls GET v1/slim/organization/{organizationId}.

Returns Future<Map<String, dynamic>>.

SlimOrganizationsResource.createCopy Anchor Link

Future<JsonMap> create(JsonMap body)

Creates an organization from body. Calls POST v1/slim/organization.

Returns Future<Map<String, dynamic>>.

SlimOrganizationsResource.updateCopy Anchor Link

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

Replaces an organization with body. Calls PUT v1/slim/organization/{organizationId}.

Returns Future<Map<String, dynamic>>.

SlimOrganizationsResource.deleteCopy Anchor Link

Future<void> delete(String organizationId)

Deletes an organization. Calls DELETE v1/slim/organization/{organizationId}.

Returns Future<void>.

SlimOutOfBedResourceCopy Anchor Link

class SlimOutOfBedResource

Out-of-bed notifications. Reached through ovok.slim.notifications.outOfBed.

ConstructorsCopy Anchor Link

SlimOutOfBedResource.newCopy Anchor Link

SlimOutOfBedResource(HttpClient _http)

Built by SlimNotificationsResource; use ovok.slim.notifications.outOfBed instead.

MethodsCopy Anchor Link

SlimOutOfBedResource.listCopy Anchor Link

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

Lists out-of-bed notifications. Calls GET v1/slim/notifications/oob.

Returns Future<Map<String, dynamic>>.

SlimOutOfBedResource.recentCopy Anchor Link

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

Lists recent out-of-bed notifications. Calls GET v1/slim/notifications/recent/oob.

Returns Future<Map<String, dynamic>>.

SlimPatientThresholdsResourceCopy Anchor Link

class SlimPatientThresholdsResource

One resident's alert thresholds. Reached through ovok.slim.patients.thresholds.

ConstructorsCopy Anchor Link

SlimPatientThresholdsResource.newCopy Anchor Link

SlimPatientThresholdsResource(HttpClient _http)

Built by SlimPatientsResource; use ovok.slim.patients.thresholds instead.

MethodsCopy Anchor Link

SlimPatientThresholdsResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve(String patientId)

Retrieves a resident's thresholds. Calls GET v2/slim/threshold/patient/{patientId}.

Returns Future<Map<String, dynamic>>.

SlimPatientThresholdsResource.updateCopy Anchor Link

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

Replaces a resident's thresholds with body. Calls PUT v2/slim/threshold/patient/{patientId}; never retried.

Returns Future<Map<String, dynamic>>.

SlimPatientsResourceCopy Anchor Link

class SlimPatientsResource

Residents in the Slim care API. Reached through ovok.slim.patients.

ConstructorsCopy Anchor Link

SlimPatientsResource.newCopy Anchor Link

SlimPatientsResource(HttpClient _http)

Built by SlimResource; use ovok.slim.patients instead.

PropertiesCopy Anchor Link

SlimPatientsResource.thresholdsCopy Anchor Link

final SlimPatientThresholdsResource thresholds

Per-resident alert thresholds.

MethodsCopy Anchor Link

SlimPatientsResource.listCopy Anchor Link

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

Lists residents. Calls GET v1/slim/patient.

query filters the list; its page (0-based) is the first page loaded. The returned Page fetches the following pages.

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

SlimPatientsResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve(String patientId)

Retrieves one resident. Calls GET v1/slim/patient/{patientId}.

Returns Future<Map<String, dynamic>>.

SlimPatientsResource.createCopy Anchor Link

Future<JsonMap> create(JsonMap body)

Creates a resident from body. Calls POST v1/slim/patient.

Returns Future<Map<String, dynamic>>.

SlimPatientsResource.updateCopy Anchor Link

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

Replaces a resident with body. Calls PUT v1/slim/patient/{patientId}.

Returns Future<Map<String, dynamic>>.

SlimPatientsResource.deleteCopy Anchor Link

Future<void> delete(String patientId)

Deletes a resident. Calls DELETE v1/slim/patient/{patientId}.

Returns Future<void>.

SlimPatientsResource.everythingCopy Anchor Link

Future<JsonMap> everything(String patientId)

Retrieves a resident with every related resource. Calls GET v1/slim/patient/{patientId}/$everything.

Returns Future<Map<String, dynamic>>.

SlimPatientsResource.currentVitalsCopy Anchor Link

Future<JsonMap> currentVitals(String patientId)

Retrieves a resident's current vital signs. Calls GET v1/slim/patient/{patientId}/current-vitals.

Returns Future<Map<String, dynamic>>.

SlimPoliciesResourceCopy Anchor Link

class SlimPoliciesResource

Access policies. Reached through ovok.slim.policies.

ConstructorsCopy Anchor Link

SlimPoliciesResource.newCopy Anchor Link

SlimPoliciesResource(HttpClient _http)

Built by SlimResource; use ovok.slim.policies instead.

MethodsCopy Anchor Link

SlimPoliciesResource.listCopy Anchor Link

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

Lists policies. Calls GET v1/slim/policy.

Returns Future<Map<String, dynamic>>.

SlimPoliciesResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve(String policyId)

Retrieves one policy. Calls GET v1/slim/policy/{policyId}.

Returns Future<Map<String, dynamic>>.

SlimPoliciesResource.createCopy Anchor Link

Future<JsonMap> create(JsonMap body)

Creates a policy from body. Calls POST v1/slim/policy.

Returns Future<Map<String, dynamic>>.

SlimPoliciesResource.updateCopy Anchor Link

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

Replaces a policy with body. Calls PUT v1/slim/policy/{policyId}.

Returns Future<Map<String, dynamic>>.

SlimPoliciesResource.deleteCopy Anchor Link

Future<void> delete(String policyId)

Deletes a policy. Calls DELETE v1/slim/policy/{policyId}.

Returns Future<void>.

SlimPractitionersResourceCopy Anchor Link

class SlimPractitionersResource

Practitioner invites. Reached through ovok.slim.practitioners.

ConstructorsCopy Anchor Link

SlimPractitionersResource.newCopy Anchor Link

SlimPractitionersResource(HttpClient _http)

Built by SlimResource; use ovok.slim.practitioners instead.

MethodsCopy Anchor Link

SlimPractitionersResource.inviteCopy Anchor Link

Future<JsonMap> invite(JsonMap body)

Invites a practitioner as body describes. Calls POST v1/slim/invite/practitioner.

Returns Future<Map<String, dynamic>>.

SlimProjectsResourceCopy Anchor Link

class SlimProjectsResource

Projects in the Slim care API. Reached through ovok.slim.projects.

ConstructorsCopy Anchor Link

SlimProjectsResource.newCopy Anchor Link

SlimProjectsResource(HttpClient http)

Built by SlimResource; use ovok.slim.projects instead.

PropertiesCopy Anchor Link

SlimProjectsResource.childrenCopy Anchor Link

final SlimChildProjectsResource children

The current project's child projects.

MethodsCopy Anchor Link

SlimProjectsResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve(String projectId)

Retrieves one project. Calls GET v1/slim/project/{projectId}.

Returns Future<Map<String, dynamic>>.

SlimProjectsResource.updateCopy Anchor Link

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

Replaces a project with body. Calls PUT v1/slim/project/{projectId}.

Returns Future<Map<String, dynamic>>.

SlimProjectsResource.usersCopy Anchor Link

Future<Page<JsonMap>> users(String projectId, [QueryParams query = const {}])

Lists a project's users. Calls GET v1/slim/project/{projectId}/users.

query filters the list; its page (0-based) is the first page loaded.

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

SlimProjectsResource.currentUsersCopy Anchor Link

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

Lists the current project's users. Calls GET v1/slim/project/users.

query filters the list; its page (0-based) is the first page loaded.

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

SlimProjectsResource.deviceCountsCopy Anchor Link

Future<JsonMap> deviceCounts(String projectId)

Counts a project's devices. Calls GET v1/slim/project/{projectId}/device-counts.

Returns Future<Map<String, dynamic>>.

SlimProjectsResource.patientCountsCopy Anchor Link

Future<JsonMap> patientCounts(String projectId)

Counts a project's residents. Calls GET v1/slim/project/{projectId}/patient-counts.

Returns Future<Map<String, dynamic>>.

SlimResourceCopy Anchor Link

class SlimResource

The Slim care API for care-home operations. Reached through ovok.slim.

Every request throws an OvokException subclass when it fails.

ConstructorsCopy Anchor Link

SlimResource.newCopy Anchor Link

SlimResource(HttpClient http, [UserSession? session])

Built by Ovok; use ovok.slim instead.

PropertiesCopy Anchor Link

SlimResource.patientsCopy Anchor Link

final SlimPatientsResource patients

Residents and their thresholds.

SlimResource.devicesCopy Anchor Link

final SlimDevicesResource devices

Devices, live rows and telemetry.

SlimResource.notificationsCopy Anchor Link

final SlimNotificationsResource notifications

Notifications: alarms, out-of-bed, medical and notes.

SlimResource.thresholdsCopy Anchor Link

final SlimThresholdsResource thresholds

The project's alert thresholds.

SlimResource.trendsCopy Anchor Link

final SlimTrendsResource trends

Vital-sign graphs.

SlimResource.sleepCopy Anchor Link

final SlimSleepResource sleep

Sleep statistics.

SlimResource.locationsCopy Anchor Link

final SlimLocationsResource locations

Locations such as rooms and beds.

SlimResource.zonesCopy Anchor Link

final SlimZonesResource zones

Zones and their device counts.

SlimResource.exportsCopy Anchor Link

final SlimExportsResource exports

PDF exports.

SlimResource.changeHistoryCopy Anchor Link

final SlimChangeHistoryResource changeHistory

The change history of Slim resources.

SlimResource.projectsCopy Anchor Link

final SlimProjectsResource projects

Projects, their users and child projects.

SlimResource.policiesCopy Anchor Link

final SlimPoliciesResource policies

Access policies.

SlimResource.organizationsCopy Anchor Link

final SlimOrganizationsResource organizations

Organizations.

SlimResource.practitionersCopy Anchor Link

final SlimPractitionersResource practitioners

Practitioner invites.

SlimResource.usersCopy Anchor Link

final SlimUsersResource users

User deletion.

MethodsCopy Anchor Link

SlimResource.healthCopy Anchor Link

Future<JsonMap> health()

Checks that the Slim API is up. Calls GET v1/slim/health.

Returns Future<Map<String, dynamic>>.

SlimSleepResourceCopy Anchor Link

class SlimSleepResource

Sleep statistics. Reached through ovok.slim.sleep.

ConstructorsCopy Anchor Link

SlimSleepResource.newCopy Anchor Link

SlimSleepResource(HttpClient _http)

Built by SlimResource; use ovok.slim.sleep instead.

MethodsCopy Anchor Link

SlimSleepResource.statisticsCopy Anchor Link

Future<JsonMap> statistics(QueryParams query)

Retrieves sleep statistics for query. Calls GET v1/slim/sleep/statistics.

Returns Future<Map<String, dynamic>>.

SlimThresholdsResourceCopy Anchor Link

class SlimThresholdsResource

The project's alert thresholds. Reached through ovok.slim.thresholds.

ConstructorsCopy Anchor Link

SlimThresholdsResource.newCopy Anchor Link

SlimThresholdsResource(HttpClient _http)

Built by SlimResource; use ovok.slim.thresholds instead.

MethodsCopy Anchor Link

SlimThresholdsResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve()

Retrieves the project's thresholds. Calls GET v2/slim/threshold.

Returns Future<Map<String, dynamic>>.

SlimThresholdsResource.updateCopy Anchor Link

Future<JsonMap> update(JsonMap body)

Replaces the project's thresholds with body. Calls PUT v2/slim/threshold; never retried.

Returns Future<Map<String, dynamic>>.

SlimTrendsResourceCopy Anchor Link

class SlimTrendsResource

Vital-sign graphs. Reached through ovok.slim.trends.

ConstructorsCopy Anchor Link

SlimTrendsResource.newCopy Anchor Link

SlimTrendsResource(HttpClient _http)

Built by SlimResource; use ovok.slim.trends instead.

MethodsCopy Anchor Link

SlimTrendsResource.graphsCopy Anchor Link

Future<JsonMap> graphs(QueryParams query)

Retrieves trend graphs for the range in query. Calls GET v1/slim/trends/graphs.

Returns Future<Map<String, dynamic>>.

SlimTrendsResource.realtimeCopy Anchor Link

Future<JsonMap> realtime(QueryParams query)

Retrieves realtime graphs for the range in query. Calls GET v1/slim/trends/realtime.

Returns Future<Map<String, dynamic>>.

SlimUsersResourceCopy Anchor Link

class SlimUsersResource

User deletion. Reached through ovok.slim.users.

ConstructorsCopy Anchor Link

SlimUsersResource.newCopy Anchor Link

SlimUsersResource(HttpClient _http)

Built by SlimResource; use ovok.slim.users instead.

MethodsCopy Anchor Link

SlimUsersResource.deleteCopy Anchor Link

Future<JsonMap> delete(String profileType, String profileId)

Deletes the user whose profile is profileType/profileId. Calls DELETE v1/slim/user/{profileType}/{profileId}.

Returns Future<Map<String, dynamic>>.

SlimZonesResourceCopy Anchor Link

class SlimZonesResource

Zones. Reached through ovok.slim.zones.

ConstructorsCopy Anchor Link

SlimZonesResource.newCopy Anchor Link

SlimZonesResource(HttpClient _http)

Built by SlimResource; use ovok.slim.zones instead.

MethodsCopy Anchor Link

SlimZonesResource.listCopy Anchor Link

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

Lists zones. Calls GET v1/slim/zones.

query filters the list; its page (0-based) is the first page loaded. The returned Page fetches the following pages.

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

SlimZonesResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve(String zoneId)

Retrieves one zone. Calls GET v1/slim/zones/{zoneId}.

Returns Future<Map<String, dynamic>>.

SlimZonesResource.deviceCountsCopy Anchor Link

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

Counts the devices per zone. Calls GET v1/slim/zones/device-counts.

Returns Future<Map<String, dynamic>>.