From dc03c1364262bc296a89e66ab0417e6f1cc294f2 Mon Sep 17 00:00:00 2001 From: Philipp Heckel Date: Sun, 13 Mar 2022 16:06:40 -0400 Subject: [PATCH] Update docs for UnifiedPush 2.0 spec --- Makefile | 8 ++++++++ docs/releases.md | 7 +++++++ docs/subscribe/phone.md | 44 +++++++++++++++++++++-------------------- 3 files changed, 38 insertions(+), 21 deletions(-) diff --git a/Makefile b/Makefile index 34ebe2e7..3bd40ea6 100644 --- a/Makefile +++ b/Makefile @@ -149,6 +149,14 @@ release-check-tags: echo "ERROR: Must update docs/install.md with latest tag first.";\ exit 1;\ fi + if grep -q XXXXX docs/releases.md; then\ + echo "ERROR: Must update docs/releases.md, found XXXXX.";\ + exit 1;\ + fi + if ! grep -q $(LATEST_TAG) docs/releases.md; then\ + echo "ERROR: Must update docs/releases.mdwith latest tag first.";\ + exit 1;\ + fi release: build-deps release-check-tags check goreleaser release --rm-dist --debug diff --git a/docs/releases.md b/docs/releases.md index d6f6cfc3..dff11215 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -2,6 +2,13 @@ Binaries for all releases can be found on the GitHub releases pages for the [ntfy server](https://github.com/binwiederhier/ntfy/releases) and the [ntfy Android app](https://github.com/binwiederhier/ntfy-android/releases). +## ntfy Android app v1.10.0 +Released XXXXXXXXXXXXXXX + +**Features:** + +* Support for UnifiedPush 2.0 specification (bytes messages, #130) + ## ntfy server v1.17.1 Released Mar 12, 2022 diff --git a/docs/subscribe/phone.md b/docs/subscribe/phone.md index 8051cb9e..74a105bb 100644 --- a/docs/subscribe/phone.md +++ b/docs/subscribe/phone.md @@ -130,19 +130,21 @@ notification popups: Here's a list of extras you can access. Most likely, you'll want to filter for `topic` and react on `message`: -| Extra name | Type | Example | Description | -|---|---|---|---| -| `id` | *string* | `bP8dMjO8ig` | Randomly chosen message identifier (likely not very useful for task automation) | -| `base_url` | *string* | `https://ntfy.sh` | Root URL of the ntfy server this message came from | -| `topic` ❤️ | *string* | `mytopic` | Topic name; **you'll likely want to filter for a specific topic** | -| `muted` | *bool* | `true` | Indicates whether the subscription was muted in the app | -| `muted_str` | *string (`true` or `false`)* | `true` | Same as `muted`, but as string `true` or `false` | -| `time` | *int* | `1635528741` | Message date time, as Unix time stamp | -| `title` | *string* | `Some title` | Message [title](../publish.md#message-title); may be empty if not set | -| `message` ❤️ | *string* | `Some message` | Message body; **this is likely what you're interested in** | -| `tags` | *string* | `tag1,tag2,..` | Comma-separated list of [tags](../publish.md#tags-emojis) | -| `tags_map` | *string* | `0=tag1,1=tag2,..` | Map of tags to make it easier to map first, second, ... tag | -| `priority` | *int (between 1-5)* | `4` | Message [priority](../publish.md#message-priority) with 1=min, 3=default and 5=max | +| Extra name | Type | Example | Description | +|-----------------|------------------------------|--------------------|------------------------------------------------------------------------------------| +| `id` | *String* | `bP8dMjO8ig` | Randomly chosen message identifier (likely not very useful for task automation) | +| `base_url` | *String* | `https://ntfy.sh` | Root URL of the ntfy server this message came from | +| `topic` ❤️ | *String* | `mytopic` | Topic name; **you'll likely want to filter for a specific topic** | +| `muted` | *Boolean* | `true` | Indicates whether the subscription was muted in the app | +| `muted_str` | *String (`true` or `false`)* | `true` | Same as `muted`, but as string `true` or `false` | +| `time` | *Int* | `1635528741` | Message date time, as Unix time stamp | +| `title` | *String* | `Some title` | Message [title](../publish.md#message-title); may be empty if not set | +| `message` ❤️ | *String* | `Some message` | Message body; **this is likely what you're interested in** | +| `message_bytes` | *ByteArray* | `(binary data)` | Message body as binary data | +| `encoding`️ | *String* | - | Message encoding (empty or "base64") | +| `tags` | *String* | `tag1,tag2,..` | Comma-separated list of [tags](../publish.md#tags-emojis) | +| `tags_map` | *String* | `0=tag1,1=tag2,..` | Map of tags to make it easier to map first, second, ... tag | +| `priority` | *Int (between 1-5)* | `4` | Message [priority](../publish.md#message-priority) with 1=min, 3=default and 5=max | #### Send messages using intents To send messages from other apps (such as [MacroDroid](https://play.google.com/store/apps/details?id=com.arlosoft.macrodroid) @@ -164,14 +166,14 @@ Here's what that looks like: The following intent extras are supported when for the intent with the `io.heckel.ntfy.SEND_MESSAGE` action: -| Extra name | Required | Type | Example | Description | -|---|---|---|---|---| -| `base_url` | - | *string* | `https://ntfy.sh` | Root URL of the ntfy server this message came from, defaults to `https://ntfy.sh` | -| `topic` ❤️ | ✔ | *string* | `mytopic` | Topic name; **you must set this** | -| `title` | - | *string* | `Some title` | Message [title](../publish.md#message-title); may be empty if not set | -| `message` ❤️ | ✔ | *string* | `Some message` | Message body; **you must set this** | -| `tags` | - | *string* | `tag1,tag2,..` | Comma-separated list of [tags](../publish.md#tags-emojis) | -| `priority` | - | *string or int (between 1-5)* | `4` | Message [priority](../publish.md#message-priority) with 1=min, 3=default and 5=max | +| Extra name | Required | Type | Example | Description | +|--------------|----------|-------------------------------|-------------------|------------------------------------------------------------------------------------| +| `base_url` | - | *String* | `https://ntfy.sh` | Root URL of the ntfy server this message came from, defaults to `https://ntfy.sh` | +| `topic` ❤️ | ✔ | *String* | `mytopic` | Topic name; **you must set this** | +| `title` | - | *String* | `Some title` | Message [title](../publish.md#message-title); may be empty if not set | +| `message` ❤️ | ✔ | *String* | `Some message` | Message body; **you must set this** | +| `tags` | - | *String* | `tag1,tag2,..` | Comma-separated list of [tags](../publish.md#tags-emojis) | +| `priority` | - | *String or Int (between 1-5)* | `4` | Message [priority](../publish.md#message-priority) with 1=min, 3=default and 5=max | ## iPhone/iOS I almost feel devious for putting the *Download on the App Store* button on this page. Currently, there is no iOS app