Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/notifications.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoas Schilling <coding@schilljs.com>2019-04-10 17:01:43 +0300
committerJoas Schilling <coding@schilljs.com>2019-07-18 10:38:06 +0300
commit7efe105bdb1ef1e8e827048acd059e5d3a098e8e (patch)
tree3460498c59bbb5c5b981ce51ff38c2890703760d /docs
parent8c378b4e6adfa4b68288910b13c2c54e801a83c2 (diff)
Send a push message when a notification was deleted
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/push-v2.md38
1 files changed, 36 insertions, 2 deletions
diff --git a/docs/push-v2.md b/docs/push-v2.md
index 3facf4c..57a6233 100644
--- a/docs/push-v2.md
+++ b/docs/push-v2.md
@@ -18,7 +18,8 @@ In order to find out if notifications support push on the server you can run a r
"push": [
...
"devices",
- "object-data"
+ "object-data",
+ "delete"
]
}
}
@@ -211,6 +212,8 @@ The pushed notifications is defined by the [Firebase Cloud Messaging HTTP Protoc
### Encrypted subject data
+#### Normal content notification
+
If you are missing any information necessary to parse the notification in a more usable way, use the `nid` to get the full notification information via [OCS API](ocs-endpoint-v2.md)
```json
@@ -220,7 +223,6 @@ If you are missing any information necessary to parse the notification in a more
"type" : "chat",
"id" : "t0k3n",
"nid" : 1337
- }
}
```
@@ -233,6 +235,38 @@ If you are missing any information necessary to parse the notification in a more
| `nid` | Numeric identifier of the notification in order to get more information via the [OCS API](ocs-endpoint-v2.md) | `object-data` |
+#### Silent delete notification (single)
+
+These notifications should not be shown to the user. Instead you should delete pending system notifications for the respective id
+
+```json
+{
+ "delete" : true,
+ "nid" : 1337
+}
+```
+
+| Attribute | Meaning | Capability |
+| ----------- | ---------------------------------------- |------------|
+| `nid` | Numeric identifier of the notification in order to get more information via the [OCS API](ocs-endpoint-v2.md) | `object-data` |
+| `delete` | Delete all notifications related to `nid` | `delete` |
+
+
+#### Silent delete notification (all)
+
+These notifications should not be shown to the user. Instead you should delete all pending system notifications for this account
+
+```json
+{
+ "delete-all" : true
+}
+```
+
+| Attribute | Meaning | Capability |
+| ----------- | ---------------------------------------- |------------|
+| `delete-all` | Delete all notifications related to this account | `delete` |
+
+
### Verification
So a device should verify the signature using the user´s public key.
If the signature is okay, the subject can be decrypted using the device´s private key.