5ebc8ad418
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
2.8 KiB
| title | description | menu | ||||
|---|---|---|---|---|---|---|
| Poll | Represents a poll attached to a status. |
|
Example
{
"id": "34830",
"expires_at": "2019-12-05T04:05:08.302Z",
"expired": true,
"multiple": false,
"votes_count": 10,
"voters_count": null,
"voted": true,
"own_votes": [
1
],
"options": [
{
"title": "accept",
"votes_count": 6
},
{
"title": "deny",
"votes_count": 4
}
],
"emojis": []
}
Attributes
id
Description: The ID of the poll in the database.
Type: String (cast from an integer, but not guaranteed to be a number)
Version history: Added in 2.8.0
expires_at
Description: When the poll ends.
Type: String ISO 8601 Datetime, or null if the poll does not end
Version history: Added in 2.8.0
expired
Description: Is the poll currently expired?
Type: Boolean
Version history: Added in 2.8.0
multiple
Description: Does the poll allow multiple-choice answers?
Type: Boolean
Version history: Added in 2.8.0
votes_count
Description: How many votes have been received.
Type: Number
Version history: Added in 2.8.0
voters_count
Description: How many unique accounts have voted on a multiple-choice poll.
Type: Number, or null if multiple is false.
Version history: Added in 2.8.0
voted
Description: When called with a user token, has the authorized user voted?
Type: Boolean, or null if no current user
Version history: Added in 2.8.0
own_votes
Description: When called with a user token, which options has the authorized user chosen? Contains an array of index values for options.
Type: Array of Number, or null if no current user
Version history: Added in 2.8.0
options[]
Description: Possible answers for the poll.
Type: Array of Hash
Version history: Added in 2.8.0
options[][title]
The text value of the poll option. String.
options[][votes_count]
The number of received votes for this option. Number, or null if results are not published yet.
emojis
Description: Custom emoji to be used for rendering poll options.
Type: Array of Emoji
Version history: Added in 2.8.0
See also
- [Status#poll]({{< relref "status.md#poll" >}})
- [/api/v1/polls]({{< relref "../methods/statuses/polls.md" >}})
{{< page-ref page="status.md" >}}
{{< page-ref page="methods/statuses/polls.md" >}}
{{< caption-link url="https://github.com/tootsuite/mastodon/blob/master/app/serializers/rest/poll_serializer.rb" caption="app/serializers/rest/poll_serializer.rb" >}}