1
0
mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00
documentation/content/en/entities/preferences.md
Moritz 5ebc8ad418
Replace and fix broken links with hugos relref (#801)
As discussed in #764 there are quite a lot of outdated links in the
mastodon documentation. In basically all cases this was resolved by
simply wrapping the old plain markdown link in hugos `relref`
function[^0].

While quite a lot of links on the `/zh-cn/` also appear to be broken,
these can not be fixed by just wrapping them in `relref`[^0]. Those are
all links to `/spec/` subpages which are just not translated to `/zh-cn/`
version. Therefore, `/zh-cn/spec/` has been excluded from the automated
checking as described in the next section.

The page has been checked using the linkchecker[^1] utility. One process
is running `hugo serve` in order to see all changes in real time and
notice errors directly in your browser. In a separate command prompt the
command `linkchecker http://localhost:1313 --ignore-url=/zh-cn/spec` is
being fired up. Note the `--ignore-url=/zh-cn/spe` to exclude the just
not existing parts of the page as mentioned in the previous paragraph.

There still is some ToDo on the table since quite a lot of the anchors
appear to not be set or at least differ from previous versions. One
example: on `/client/authorized/` is a link to
`/client/token/#creating-our-application` while the id of referenced
heading is `app`. These changes **do not** fix those Issues as it would
require way more time.

[^0]: https://gohugo.io/functions/relref/
[^1]: https://github.com/linkchecker/linkchecker

Close #764
2020-08-10 23:01:50 +02:00

2.3 KiB

title description menu
Preferences Represents a user's preferences.
docs
parent
entities

Example

{
  "posting:default:visibility": "public",
  "posting:default:sensitive": false,
  "posting:default:language": null,
  "reading:expand:media": "default",
  "reading:expand:spoilers": false
}

Attributes

posting:default:visibility

Description: Default visibility for new posts. Equivalent to [Source#privacy]({{< relref "source.md#privacy" >}}).
Type: String (Enumerable, oneOf)
public = Public post
unlisted = Unlisted post
private = Followers-only post
direct = Direct post
Version history: Added in 2.8.0

posting:default:sensitive

Description: Default sensitivity flag for new posts. Equivalent to [Source#sensitive]({{< relref "source.md#sensitive" >}}).
Type: Boolean
Version history: Added in 2.8.0

posting:default:language

Description: Default language for new posts. Equivalent to [Source#language]({{< relref "source.md#language" >}})
Type: String ISO 639-1 language two-letter code, or null
Version history: Added in 2.8.0

reading:expand:media

Description: Whether media attachments should be automatically displayed or blurred/hidden.
Type: String (Enumerable, oneOf)
default = Hide media marked as sensitive
show_all = Always show all media by default, regardless of sensitivity
hide_all = Always hide all media by default, regardless of sensitivity
Version history: Added in 2.8.0

reading:expand:spoilers

Description: Whether CWs should be expanded by default.
Type: Boolean
Version history: Added in 2.8.0

See also

  • [GET /api/v1/accounts/verify_credentials]({{< relref "../methods/accounts.md#verify-account-credentials" >}})
  • [PATCH /api/v1/accounts/update_credentials]({{< relref "../methods/accounts.md#update-account-credentials" >}})
  • [GET /api/v1/preferences]({{< relref "../methods/accounts/preferences.md#view-user-preferences" >}})

{{< page-ref page="methods/accounts/preferences.md" >}}

{{< caption-link url="https://github.com/tootsuite/mastodon/blob/master/app/serializers/rest/preferences_serializer.rb" caption="app/serializers/rest/preferences_serializer.rb" >}}