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

Add documentation for include_filtered (#1543)

Browse Source 
* Add documentation for `include_filtered`

* Update grouped_notifications.md
This commit is contained in:
Claire 2024-10-09 16:54:13 +02:00 committed by GitHub
parent b0c7cca93b
commit c99799ac3e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -86,6 +86,9 @@ expand_accounts
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. 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.
include_filtered
: Boolean. Whether to include notifications filtered by the user's [NotificationPolicy]({{< relref "entities/NotificationPolicy" >}}). Defaults to false.
#### Response
Sample call with limit=2.

6
content/en/methods/notifications.md
View File

@ -47,7 +47,8 @@ Types to filter include:
3.3.0 - added `status` type; both `min_id` and `max_id` can be used at the same time now\
3.5.0 - added `types`; add `update` and `admin.sign_up` types\
4.0.0 - added `admin.report` type\
4.1.0 - notification limit changed from 15 (max 30) to 40 (max 80)
4.1.0 - notification limit changed from 15 (max 30) to 40 (max 80)\
4.3.0 - added `include_filtered` parameter
#### Request
@ -79,6 +80,9 @@ exclude_types[]
account_id
: String. Return only notifications received from the specified account.
include_filtered
: Boolean. Whether to include notifications filtered by the user's [NotificationPolicy]({{< relref "entities/NotificationPolicy" >}}). Defaults to false.
#### Response
Sample call with limit=2.