Signals resource

Generated reference for ovok_sdk: signals resource.

  • Stable unknown
  • Release candidate since 0.1.0-rc.4
  • Development since 0.1.0-dev.23+d339d81

SignalsResource

class SignalsResource

Signals monitoring for patients. Reached through ovok.signals.

Every request throws an OvokException subclass when it fails.

Constructors

SignalsResource.new

SignalsResource(HttpClient http)

Built by Ovok; use ovok.signals instead.

ParameterTypeKindDefault
httpHttpClientpositional

Properties

SignalsResource.undeliverable

final UndeliverableResource undeliverable

Residents whose Signals configuration could not be delivered.

Methods

SignalsResource.enable

Future<JsonMap> enable(String patientId)

Enables Signals for a patient.

Calls POST fhir/Patient/{patientId}/$enable-signals. Idempotent: a failed call leaves nothing half done, and a retry completes it. Readings saved through Ovok reach Signals without a second submit.

ParameterTypeKindDefault
patientIdStringpositional

Returns Future<Map<String, dynamic>>.

UndeliverableResource

class UndeliverableResource

Signals configuration that could not be delivered.

Reached through ovok.signals.undeliverable.

Constructors

UndeliverableResource.new

UndeliverableResource(HttpClient _http)

Built by Ovok; use ovok.signals.undeliverable instead.

ParameterTypeKindDefault
_httpHttpClientpositional

Methods

UndeliverableResource.list

Future<JsonMap> list()

Lists the undeliverable residents. Calls GET signals/config/undeliverable.

Returns Future<Map<String, dynamic>>.

UndeliverableResource.repair

Future<JsonMap> repair([JsonMap request = const {}])

Delivers the configuration again.

Calls POST signals/config/undeliverable/repair. Without patientIds, repairs the residents list shows.

ParameterTypeKindDefault
requestJsonMapoptional positionalconst {}

Returns Future<Map<String, dynamic>>.

Last updated on

On this page