# Push resource

Canonical page: https://docs.ovok.com/flutter-sdk/reference/ovok_sdk/push-resource

{/* Generated by scripts/generate_reference.dart; do not edit. */}

## PushDevicesResource [#pushdevicesresource]

```dart
class PushDevicesResource
```

The signed-in person's push devices. Reached through `ovok.push.devices`.

### Constructors [#constructors]

#### PushDevicesResource.new [#pushdevicesresourcenew]

```dart
PushDevicesResource(HttpClient _push)
```

Built by `Ovok`; use `ovok.push.devices` instead.

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `_push` | `HttpClient` | positional |  |

### Methods [#methods]

#### PushDevicesResource.register [#pushdevicesresourceregister]

```dart
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 [#pushdevicesresourcelist]

```dart
Future<JsonMap> list()
```

Lists the signed-in person's devices, under `devices`. Calls `GET v1/push/devices`.

Returns `Future<Map<String, dynamic>>`.

#### PushDevicesResource.unregister [#pushdevicesresourceunregister]

```dart
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 [#pushproviderresource]

```dart
class PushProviderResource
```

The provider the project's push goes through: `fcm`, `apns`, `expo` or `relay`.

Reached through `ovok.push.provider`. For project admins.

### Constructors [#constructors-1]

#### PushProviderResource.new [#pushproviderresourcenew]

```dart
PushProviderResource(HttpClient _push)
```

Built by `Ovok`; use `ovok.push.provider` instead.

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `_push` | `HttpClient` | positional |  |

### Methods [#methods-1]

#### PushProviderResource.retrieve [#pushproviderresourceretrieve]

```dart
Future<JsonMap> retrieve()
```

Reads the provider and its settings, never a secret. Calls `GET v1/push/provider`.

Returns `Future<Map<String, dynamic>>`.

#### PushProviderResource.create [#pushproviderresourcecreate]

```dart
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 [#pushproviderresourceupdate]

```dart
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 [#pushproviderresourceremove]

```dart
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 [#pushresource]

```dart
class PushResource
```

Push 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 [#constructors-2]

#### PushResource.new [#pushresourcenew]

```dart
PushResource(HttpClient http)
```

Built by `Ovok`; use `ovok.push` instead.

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `http` | `HttpClient` | positional |  |

### Properties [#properties]

#### PushResource.devices [#pushresourcedevices]

```dart
final PushDevicesResource devices
```

The devices the signed-in person receives push on, each their own.

#### PushResource.provider [#pushresourceprovider]

```dart
final PushProviderResource provider
```

The provider the project's push goes through, for project admins.
