mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-12-28 10:00:31 +00:00
5e2bf0bdca
* [chore] Remove years from all license headers Years or year ranges aren't required in license headers. Many projects have removed them in recent years and it avoids a bit of yearly toil. In many cases our copyright claim was also a bit dodgy since we added the 2021-2023 header to files created after 2021 but you can't claim copyright into the past that way. * [chore] Add license header check This ensures a license header is always added to any new file. This avoids maintainers/reviewers needing to remember to check for and ask for it in case a contribution doesn't include it. * [chore] Add missing license headers * [chore] Further updates to license header * Use the more common // indentend comment format * Remove the hack we had for the linter now that we use the // format * Add SPDX license identifier
73 lines
3 KiB
Go
73 lines
3 KiB
Go
// GoToSocial
|
|
// Copyright (C) GoToSocial Authors admin@gotosocial.org
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package model
|
|
|
|
// Poll represents a poll attached to a status.
|
|
//
|
|
// swagger:model poll
|
|
type Poll struct {
|
|
// The ID of the poll in the database.
|
|
// example: 01FBYKMD1KBMJ0W6JF1YZ3VY5D
|
|
ID string `json:"id"`
|
|
// When the poll ends. (ISO 8601 Datetime), or null if the poll does not end
|
|
ExpiresAt string `json:"expires_at,omitempty"`
|
|
// Is the poll currently expired?
|
|
Expired bool `json:"expired"`
|
|
// Does the poll allow multiple-choice answers?
|
|
Multiple bool `json:"multiple"`
|
|
// How many votes have been received.
|
|
VotesCount int `json:"votes_count"`
|
|
// How many unique accounts have voted on a multiple-choice poll. Null if multiple is false.
|
|
VotersCount int `json:"voters_count,omitempty"`
|
|
// When called with a user token, has the authorized user voted?
|
|
Voted bool `json:"voted,omitempty"`
|
|
// When called with a user token, which options has the authorized user chosen? Contains an array of index values for options.
|
|
OwnVotes []int `json:"own_votes,omitempty"`
|
|
// Possible answers for the poll.
|
|
Options []PollOptions `json:"options"`
|
|
// Custom emoji to be used for rendering poll options.
|
|
Emojis []Emoji `json:"emojis"`
|
|
}
|
|
|
|
// PollOptions represents the current vote counts for different poll options.
|
|
//
|
|
// swagger:model pollOptions
|
|
type PollOptions struct {
|
|
// The text value of the poll option. String.
|
|
Title string `json:"title"`
|
|
// The number of received votes for this option.
|
|
// Number, or null if results are not published yet.
|
|
VotesCount int `json:"votes_count,omitempty"`
|
|
}
|
|
|
|
// PollRequest models a request to create a poll.
|
|
//
|
|
// swagger:parameters createStatus
|
|
type PollRequest struct {
|
|
// Array of possible answers.
|
|
// If provided, media_ids cannot be used, and poll[expires_in] must be provided.
|
|
// name: poll[options]
|
|
Options []string `form:"options" json:"options" xml:"options"`
|
|
// Duration the poll should be open, in seconds.
|
|
// If provided, media_ids cannot be used, and poll[options] must be provided.
|
|
ExpiresIn int `form:"expires_in" json:"expires_in" xml:"expires_in"`
|
|
// Allow multiple choices on this poll.
|
|
Multiple bool `form:"multiple" json:"multiple" xml:"multiple"`
|
|
// Hide vote counts until the poll ends.
|
|
HideTotals bool `form:"hide_totals" json:"hide_totals" xml:"hide_totals"`
|
|
}
|