Push resource
Generated reference for ovok_sdk: push resource.
- Stable unknown
- Release candidate not available
- Development since 0.2.0-dev.51+80996d9
PushDevicesResource
class PushDevicesResourceThe signed-in person's push devices. Reached through ovok.push.devices.
Constructors
PushDevicesResource.new
PushDevicesResource(HttpClient _push)Built by Ovok; use ovok.push.devices instead.
| Parameter | Type | Kind | Default |
|---|---|---|---|
_push | HttpClient | positional |
Methods
PushDevicesResource.register
Future<JsonMap> register(JsonMap device)Registers device: its token, platform (ios, android or web) and optional appId.
Calls POST v1/push/devices. The same token again answers the same device. The token is never returned.
| Parameter | Type | Kind | Default |
|---|---|---|---|
device | JsonMap | positional |
Returns Future<Map<String, dynamic>>.
PushDevicesResource.list
Future<JsonMap> list()Lists the signed-in person's devices, under devices. Calls GET v1/push/devices.
Returns Future<Map<String, dynamic>>.
PushDevicesResource.unregister
Future<void> unregister(String id)Removes the device id, which then gets no more push. Calls DELETE v1/push/devices/{id}.
| Parameter | Type | Kind | Default |
|---|---|---|---|
id | String | positional |
Returns Future<void>.
PushProviderResource
class PushProviderResourceThe provider the project's push goes through: fcm, apns, expo or relay.
Reached through ovok.push.provider. For project admins.
Constructors
PushProviderResource.new
PushProviderResource(HttpClient _push)Built by Ovok; use ovok.push.provider instead.
| Parameter | Type | Kind | Default |
|---|---|---|---|
_push | HttpClient | positional |
Methods
PushProviderResource.retrieve
Future<JsonMap> retrieve()Reads the provider and its settings, never a secret. Calls GET v1/push/provider.
Returns Future<Map<String, dynamic>>.
PushProviderResource.create
Future<JsonMap> create(JsonMap provider)Sets up the provider from provider, its name and credentials.
Calls POST v1/push/provider. A relay's whsec_ signing secret is answered this once.
| Parameter | Type | Kind | Default |
|---|---|---|---|
provider | JsonMap | positional |
Returns Future<Map<String, dynamic>>.
PushProviderResource.update
Future<JsonMap> update(JsonMap changes)Changes the provider set up: changes names it and the fields to change. Calls PATCH v1/push/provider.
| Parameter | Type | Kind | Default |
|---|---|---|---|
changes | JsonMap | positional |
Returns Future<Map<String, dynamic>>.
PushProviderResource.remove
Future<void> remove()Removes the provider; no push is sent until one is set up again. Calls DELETE v1/push/provider.
Returns Future<void>.
PushResource
class PushResourcePush devices and the project's push provider.
Reached through ovok.push. Every route is under v1/push.
Every request throws an OvokException subclass when it fails.
Constructors
PushResource.new
PushResource(HttpClient http)Built by Ovok; use ovok.push instead.
| Parameter | Type | Kind | Default |
|---|---|---|---|
http | HttpClient | positional |
Properties
PushResource.devices
final PushDevicesResource devicesThe devices the signed-in person receives push on, each their own.
PushResource.provider
final PushProviderResource providerThe provider the project's push goes through, for project admins.
Last updated on