Realtime resource

Generated reference for ovok_sdk: realtime resource.

  • Stable unknown
  • Release candidate since 0.1.0-rc.4
  • Development since 0.1.0-dev.26+c361756

RealtimeNotification

typedef RealtimeNotification = Map<String, dynamic>

A FHIR SubscriptionStatus event notification received over a WebSocket.

resources holds the changed resources sent with the notification, in the order the server sent them.

RealtimeNotificationHandler

typedef RealtimeNotificationHandler = void Function(Map<String, dynamic>)

Receives each event notification for a realtime subscription.

RealtimeResource

class RealtimeResource

Creates FHIR subscriptions and receives matching resource updates.

Constructors

RealtimeResource.new

RealtimeResource(
  HttpClient _http,
  FhirResource _fhir,
  String _baseUrl,
  UserSession _session,
)

Built by the client; use ovok.realtime instead.

ParameterTypeKindDefault
_httpHttpClientpositional
_fhirFhirResourcepositional
_baseUrlStringpositional
_sessionUserSessionpositional

Methods

RealtimeResource.subscribe

Future<RealtimeUnsubscribe> subscribe(String criteria, RealtimeNotificationHandler handler)

Subscribes to resources matching a FHIR search criteria.

The returned function closes the WebSocket and deletes the Subscription. Throws OvokValidationException when criteria is blank.

ParameterTypeKindDefault
criteriaStringpositional
handlerRealtimeNotificationHandlerpositional

Returns Future<Future<void> Function()>.

RealtimeUnsubscribe

typedef RealtimeUnsubscribe = Future<void> Function()

Stops a realtime subscription and removes its FHIR Subscription resource.

Last updated on

On this page