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 RealtimeResourceCreates 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.
| Parameter | Type | Kind | Default |
|---|---|---|---|
_http | HttpClient | positional | |
_fhir | FhirResource | positional | |
_baseUrl | String | positional | |
_session | UserSession | positional |
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.
| Parameter | Type | Kind | Default |
|---|---|---|---|
criteria | String | positional | |
handler | RealtimeNotificationHandler | positional |
Returns Future<Future<void> Function()>.
RealtimeUnsubscribe
typedef RealtimeUnsubscribe = Future<void> Function()Stops a realtime subscription and removes its FHIR Subscription resource.
Last updated on