Wearables resource
Generated reference for ovok_sdk: wearables resource.
- Stable unknown
- Release candidate since 0.1.0-rc.4
- Development since 0.1.0-dev.23+d339d81
WearableConnectionsResource
class WearableConnectionsResourceConnections to wearable providers. Reached through ovok.wearables.connections.
Constructors
WearableConnectionsResource.new
WearableConnectionsResource(HttpClient _wearables)Built by Ovok; use ovok.wearables.connections instead.
| Parameter | Type | Kind | Default |
|---|---|---|---|
_wearables | HttpClient | positional |
Methods
WearableConnectionsResource.list
Future<JsonMap> list()Lists the connections. Calls GET v1/wearables/connections.
Returns Future<Map<String, dynamic>>.
WearableConnectionsResource.authorize
Future<JsonMap> authorize(String provider)Starts a connection to provider.
Calls POST v1/wearables/connections/{provider}/authorize. The answer
carries the provider's one-time consent page, where the patient grants access.
| Parameter | Type | Kind | Default |
|---|---|---|---|
provider | String | positional |
Returns Future<Map<String, dynamic>>.
WearableConnectionsResource.sync
Future<JsonMap> sync(String provider)Syncs the data of provider.
Calls POST v1/wearables/connections/{provider}/sync.
| Parameter | Type | Kind | Default |
|---|---|---|---|
provider | String | positional |
Returns Future<Map<String, dynamic>>.
WearableConnectionsResource.delete
Future<void> delete(String provider)Disconnects provider. Calls DELETE v1/wearables/connections/{provider}.
| Parameter | Type | Kind | Default |
|---|---|---|---|
provider | String | positional |
Returns Future<void>.
WearableProvidersResource
class WearableProvidersResourceWearable providers. Reached through ovok.wearables.providers.
Constructors
WearableProvidersResource.new
WearableProvidersResource(HttpClient _wearables)Built by Ovok; use ovok.wearables.providers instead.
| Parameter | Type | Kind | Default |
|---|---|---|---|
_wearables | HttpClient | positional |
Methods
WearableProvidersResource.list
Future<JsonMap> list()Lists the providers. Calls GET v1/wearables/providers.
Returns Future<Map<String, dynamic>>.
WearableProvidersResource.retrieve
Future<JsonMap> retrieve(String provider)Retrieves a provider. Calls GET v1/wearables/providers/{provider}.
| Parameter | Type | Kind | Default |
|---|---|---|---|
provider | String | positional |
Returns Future<Map<String, dynamic>>.
WearableProvidersResource.create
Future<JsonMap> create(JsonMap body)Adds a provider. Calls POST v1/wearables/providers.
| Parameter | Type | Kind | Default |
|---|---|---|---|
body | JsonMap | positional |
Returns Future<Map<String, dynamic>>.
WearableProvidersResource.patch
Future<JsonMap> patch(String provider, JsonMap body)Updates a provider. Calls PATCH v1/wearables/providers/{provider}.
| Parameter | Type | Kind | Default |
|---|---|---|---|
provider | String | positional | |
body | JsonMap | positional |
Returns Future<Map<String, dynamic>>.
WearableProvidersResource.delete
Future<void> delete(String provider)Removes a provider. Calls DELETE v1/wearables/providers/{provider}.
| Parameter | Type | Kind | Default |
|---|---|---|---|
provider | String | positional |
Returns Future<void>.
WearablesResource
class WearablesResourceWearable providers and the patient's connections to them.
Reached through ovok.wearables. Every route is under v1/wearables.
Every request throws an OvokException subclass when it fails.
Constructors
WearablesResource.new
WearablesResource(HttpClient http)Built by Ovok; use ovok.wearables instead.
| Parameter | Type | Kind | Default |
|---|---|---|---|
http | HttpClient | positional |
Properties
WearablesResource.providers
final WearableProvidersResource providersThe wearable providers the project offers.
WearablesResource.connections
final WearableConnectionsResource connectionsThe signed-in patient's connections to providers.
Last updated on