Update content for 4.0 (part 1) (#991)
* add rules * join date on profiles * deprecate follow scope * deprecate identity proofs * familiar followers * use definition lists instead of tables for defining activitypub properties * reformat notifications page into markdown * fix broken links to publicKey header * Application website is now nullable * update environment variables added and removed * fix typo * fix heading level * min_id and max_id can be used at the same time (3.3) * fix typo * new tootctl options * reformat tootctl page to use definition lists for params * add rules and configuration to Instance * fix typo * refactor instance api page * 3.3.0 duration on mutes * 3.3.0 mute_expires_at * improve section headings * 3.4.0 resend email confirmation api * 3.4.0 policy on push subscriptions * 3.4.0 add details to account registration error * refactor accounts api page and start adding relrefs to entity pages * 3.4.0 accounts/lookup api * add see also to accounts methods * add more see-also links * 3.5.0 appeal mod decisions * 3.5.0 reformat reports and add category/rule_ids params * document report entity and missing responses * fix typos * fix relrefs and url schema, add aliases to old urls * add archetypes for new methods/entities * update archetypes with see-also stubs * clearer presentation of rate limits * announcements api methods * refactor apps methods * refactor bookmarks methods + some anchors * refactor conversations methods * custom_emojis methods refactor * anchors * refactor directory methods * refactor domain_blocks methods * add see also to emails methods * fix page relref shortcodes to specific methods + refactor endorsements methods * min_id max_id * refactor favourites methods * refactor featured_tags methods * refactor filters methods, make path params consistent, i18n required shortcode * follow_requests methods * lists methods * markers methods * forgot to add entity links * media methods, also fix formatting of some json errors * mutes methods, add more see-also links * oembed methods * preferences methods * proofs methods * push methods * suggestions methods * 3.5.0 add new trend types, fix formatting * refactor streaming methods * refactor oauth methods * note that streaming api casts payload to string * refactor search methods * refactor polls methods * remove unnecessary link * reformat scheduled_statuses methods * reformat timelines methods * reformat statuses methods * 3.5.0 editing statuses * consistent use of array brackets in form data parameters * update dev setup guide, add vagrant and clean up text * add admin/accounts methods * 3.6 role entity * admin/accounts methods v2 * minor fix * stub admin/reports methods * document admin reports * add 403 example to methods archetype * cleanup entities for admin reports and add new attrs * 3.6.0 domain allows methods + normalize admin entity namespace * fix search-and-replace error * add aliases for admin entities * 3.6.0 canonical email blocks entity * 3.5.0 admin/retention api * 3.5.0 add admin::ip doc * 3.5.0 admin/reports * 3.6.0 admin/domain_allows * 3.5.0 admin/dimensions * 3.6.0 permissions and roles * minor formatting fix * add anchor link to headings * checkpoint * add update commands to dev env setup guide * change mentions of v3.6 to v4.0 * tootctl now uses custom roles * fix formatting * v2 instance api * update frontmatter, add better titles to pages * minor wording change * consistency * add more aliases * add placeholders and WIP notices * explain link pagination and stub out todos * switch baseURL to https * 422 on reports with rules but category!=violation * document bug fixes * fix typo * remove duplicate API method definition * s/tootsuite/mastodon for github links * remove unnecessary escaping * s/tootsuite/mastodon in Entity archetype * add missing nullable shortcode * clarify oauth scope when requesting a user token * api/v2/media now synchronous for images * DISALLOW_UNAUTHENTICATED_API_ACCESS * add undocumented env variables * add instance domain blocks and extended description api * add SMTP_ENABLE_STARTTLS * add description to SMTP_ENABLE_STARTTLS * take suggestions from open PRs * normalize links and flavour language * Fully document streaming API based on source code * Add mention of MIME types * bump to ruby 3.0.4 * clarify how to check on async media processing * validation of replies_policy * remove TODOs on admin account action * EmailDomainBlocks * IpBlocks * Admin::DomainBlock * remove TODOs * following hashtags * followed_tags * remove reference to unused parameter * add new oauth scopes for admin blocks and allows * fix command signature for i18n-tasks normalize * reformat code structure page * document fixes for following tags (assume 4.0.3) * Add warning about pre-4.0 hardcoded roles * add note about case sensitivity * remove use of 'simply' from docs * remove reference to silencing * add reference to IDN normalization for verified links * add lang parameter
This commit is contained in:
trwnh
GitHub
parent
69e9017730
commit
3628b6d434
225 changed files with 22675 additions and 11631 deletions
137
content/en/entities/Notification.md
Normal file
137
content/en/entities/Notification.md
Normal file
|
|
@ -0,0 +1,137 @@
|
|||
---
|
||||
title: Notification
|
||||
description: Represents a notification of an event relevant to the user.
|
||||
menu:
|
||||
docs:
|
||||
parent: entities
|
||||
aliases: [
|
||||
"/entities/notification",
|
||||
"/entities/Notification",
|
||||
"/entities/notification",
|
||||
"/entities/Notification",
|
||||
]
|
||||
---
|
||||
|
||||
|
||||
|
||||
## Attributes
|
||||
|
||||
### `id` {#id}
|
||||
|
||||
**Description:** The id of the notification in the database.\
|
||||
**Type:** String (cast from an integer, but not guaranteed to be a number)\
|
||||
**Version history:**\
|
||||
0.9.9 - added
|
||||
|
||||
### `type` {#type}
|
||||
|
||||
**Description:** The type of event that resulted in the notification.\
|
||||
**Type:** String (Enumerable oneOf)\
|
||||
`mention` = Someone mentioned you in their status\
|
||||
`status` = Someone you enabled notifications for has posted a status\
|
||||
`reblog` = Someone boosted one of your statuses\
|
||||
`follow` = Someone followed you\
|
||||
`follow_request` = Someone requested to follow you\
|
||||
`favourite` = Someone favourited one of your statuses\
|
||||
`poll` = A poll you have voted in or created has ended\
|
||||
`update` = A status you interacted with has been edited\
|
||||
`admin.sign_up` = Someone signed up (optionally sent to admins)\
|
||||
`admin.report` = A new report has been filed\
|
||||
**Version history:**\
|
||||
0.9.9 - added\
|
||||
2.8.0 - added `poll`\
|
||||
3.1.0 - added `follow_request`\
|
||||
3.3.0 - added `status`\
|
||||
3.5.0 - added `update` and `admin.sign_up`\
|
||||
4.0.0 - added `admin.report`
|
||||
|
||||
### `created_at` {#created_at}
|
||||
|
||||
**Description:** The timestamp of the notification.\
|
||||
**Type:** String (ISO 8601 Datetime)\
|
||||
**Version history:**\
|
||||
0.9.9 - added
|
||||
|
||||
### `account` {#account}
|
||||
|
||||
**Description:** The account that performed the action that generated the notification.\
|
||||
**Type:** [Account]({{< relref "entities/Account" >}})\
|
||||
**Version history:**\
|
||||
0.9.9 - added
|
||||
|
||||
### `status` {{%optional%}} {#status}
|
||||
|
||||
**Description:** Status that was the object of the notification. Attached when `type` of the notification is `favourite`, `reblog`, `status`, `mention`, `poll`, or `update`.\
|
||||
**Type:** [Status]({{< relref "entities/Status" >}})\
|
||||
**Version history:**\
|
||||
0.9.9 - added
|
||||
|
||||
### `report` {{%optional%}} {#report}
|
||||
|
||||
**Description:** Report that was the object of the notification. Attached when `type` of the notification is `admin.report`.\
|
||||
**Type:** [Report]({{< relref "entities/Report" >}})\
|
||||
**Version history:**\
|
||||
4.0.0 - added
|
||||
|
||||
## Examples
|
||||
|
||||
### Mention
|
||||
|
||||
```json
|
||||
|
||||
{
|
||||
"id": "34975861",
|
||||
"type": "mention",
|
||||
"created_at": "2019-11-23T07:49:02.064Z",
|
||||
"account": {
|
||||
"id": "971724",
|
||||
"username": "zsc",
|
||||
"acct": "zsc",
|
||||
// ...
|
||||
},
|
||||
"status": {
|
||||
"id": "103186126728896492",
|
||||
"created_at": "2019-11-23T07:49:01.940Z",
|
||||
"in_reply_to_id": "103186038209478945",
|
||||
"in_reply_to_account_id": "14715",
|
||||
// ...
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Favourite
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "34975535",
|
||||
"type": "favourite",
|
||||
"created_at": "2019-11-23T07:29:18.903Z",
|
||||
"account": {
|
||||
"id": "297420",
|
||||
"username": "haskal",
|
||||
"acct": "haskal@cybre.space",
|
||||
// ...
|
||||
},
|
||||
"status": {
|
||||
"id": "103186046267791694",
|
||||
"created_at": "2019-11-23T07:28:34.210Z",
|
||||
// ...
|
||||
"account": {
|
||||
"id": "14715",
|
||||
"username": "trwnh",
|
||||
"acct": "trwnh",
|
||||
// ...
|
||||
},
|
||||
// ...
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
{{< page-relref ref="methods/notifications" caption="notifications API methods" >}}
|
||||
|
||||
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/serializers/rest/notification_serializer.rb" caption="app/serializers/rest/notification_serializer.rb" >}}
|
||||
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue