zelo72/documentation
1
0
Fork 0
mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00
Code Issues 6 Releases Wiki Activity

Clarify group_key for ungrouped notifications (#1539)

Browse Source 
* Clarify `group_key` for ungrouped notifications

* Clarify that `grouped_types` affects `group_key` but not streaming API

* Update content/en/methods/grouped_notifications.md

Co-authored-by: Claire <claire.github-309c@sitedethib.com>

---------

Co-authored-by: David Roetzel <david@roetzel.de>
This commit is contained in:
Claire 2024-10-08 11:34:32 +02:00 committed by GitHub
parent eadb8b98cc
commit 42a8dbc20d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
content/en/entities/Notification.md
View File

@ -48,7 +48,7 @@ aliases: [
### `group_key` {#group_key} ### `group_key` {#group_key}
**Description:** Group key shared by similar notifications, to be used in the grouped notifications feature. Should be considered opaque. **Description:** Group key shared by similar notifications, to be used in the grouped notifications feature. Should be considered opaque, but ungrouped notifications can be assumed to have a `group_key` of the form `ungrouped-{notification_id}`.
**Type:** String\ **Type:** String\
**Version history:**\ **Version history:**\
4.3.0 - added 4.3.0 - added

2
content/en/methods/grouped_notifications.md
View File

@ -84,7 +84,7 @@ expand_accounts
: String. One of `full` (default) or `partial_avatars`. When set to `partial_avatars`, some accounts will not be rendered in full in the returned `accounts` list but will be instead returned in stripped-down form in the `partial_accounts` list. The most recent account in a notification group is always rendered in full in the `accounts` attribute. : String. One of `full` (default) or `partial_avatars`. When set to `partial_avatars`, some accounts will not be rendered in full in the returned `accounts` list but will be instead returned in stripped-down form in the `partial_accounts` list. The most recent account in a notification group is always rendered in full in the `accounts` attribute.
grouped_types[] grouped_types[]
: Array of String. Restrict which notification types can be grouped. Use this if there are notification types for which your client does not support grouping. If omitted, the server will group notifications of all types it supports (currently, `favourite`, `follow` and `reblog`). If you do not want any notification grouping, use [GET `/api/v1/notifications`]({{< relref "methods/notifications#get" >}}) instead. : Array of String. Restrict which notification types can be grouped. Use this if there are notification types for which your client does not support grouping. If omitted, the server will group notifications of all types it supports (currently, `favourite`, `follow` and `reblog`). If you do not want any notification grouping, use [GET `/api/v1/notifications`]({{< relref "methods/notifications#get" >}}) instead. Notifications that would be grouped if not for this parameter will instead be returned as individual single-notification groups with a unique `group_key` that can be assumed to be of the form `ungrouped-{notification_id}`. Please note that neither the streaming API nor the individual notification APIs are aware of this parameter and will always include a “proper” `group_key` that can be different from what is returned here, meaning that you may have to ignore `group_key` for such notifications that you do not want grouped and use `ungrouped-{notification_id}` instead for consistency.
#### Response #### Response