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>2020-08-26 09:32:10 +0300
committerJoas Schilling <coding@schilljs.com>2020-08-26 10:07:48 +0300
commita94e33e1638053559bf4aa05e8bda3abf54bd6e8 (patch)
tree30292120ca9dfa0404a8c797255d6f592ec1d9dd /docs
parent85f69ccaffab094918d1d6f661b67b233ef8c268 (diff)
Set the user status as header, so clients can decide to not show notifications
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/ocs-endpoint-v2.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/ocs-endpoint-v2.md b/docs/ocs-endpoint-v2.md
index 609acf3..8c94b07 100644
--- a/docs/ocs-endpoint-v2.md
+++ b/docs/ocs-endpoint-v2.md
@@ -26,7 +26,8 @@ In order to find out if notifications is installed/enabled on the server you can
"delete-all",
"icons",
"rich-strings",
- "action-web"
+ "action-web",
+ "user-status"
]
}
}
@@ -103,6 +104,13 @@ Status | Explanation
`204 No Content` | please slow down the polling to once per hour, since there are no apps that can generate notifications
`304 Not Modified` | The provided `If-None-Match` matches the ETag, response body is empty
+### Headers
+
+Status | Explanation
+---|---
+`ETag` | See https://tools.ietf.org/html/rfc7232#section-2.3
+`X-Nextcloud-User-Status` | Only available with the `user-status` capability. The user status (`away`, `dnd`, `offline`, `online`) should be taken into account and in case of `dnd` no notifications should be directly shown.
+
### Specification
Optional elements are still set in the array, the value is just empty: