# `PushToken`

The address of a device for push notifications, from Apple's or Google's service.

Use it to send a push notification. A token can stop working, so replace it when the service says so. For a phone itself, use [`Imei`](/docs/types/type-imei.md).

## Shape

One value, held as text in one set form, with no parts: `bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1`.

## Example

```jadpo
PushToken("bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1")
```

`PushToken(raw)` checks the text, and text that isn't one breaks the `format` rule.

`text.parse(raw, as: PushToken)` reads one from text that comes from outside. Text that isn't one at all fails `malformed`, such as `a token` or `token!`.

## Good to know

- `==` tells you whether two are the same. `<` and `list.sort_by` don't take it.
- A field that holds one counts as personal data (`online`), so you don't mark it yourself.

## In JSON

A string, in a request, a response or `json.write`:

```json
"740f4707bebcf74f9b7c25d48e3358945f6aa01da5ddb387462c7eaf61bb78ad"
"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1"
```

## Details

<details>
<summary>Text form, storage, how it is shown, and operations</summary>

`PushToken` is in the group Web and network, and has been in Jadpo since 0.1.0.

### Text form

`text.from` writes one standard text form, the same form `text.parse` reads back: `740f4707bebcf74f9b7c25d48e3358945f6aa01da5ddb387462c7eaf61bb78ad` and `bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1`.

### How it is stored

It is stored in one column named for the field, of type `text`. `bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1` is stored as `'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1'`.

### How it is shown to people

`text.format(value, locale:)` shows it to people in their locale.

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `740f4707bebcf74f9b7c25d48e3358945f6aa01da5ddb387462c7eaf61bb78ad` | `740f4707bebcf74f9b7c25d48e3358945f6aa01da5ddb387462c7eaf61bb78ad` |
| `bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1` | `bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1` |

### Operations

It also takes `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. [How every standard type behaves](/docs/every-standard-type-meets-one-contract.md) says how they work.

</details>