poll

Documentation

Index

• Constants
• func NewPoll(creator, question string, answerOptions []string, settings Settings) (*Poll, *ErrorMessage)
• func NewSettingsFromStrings(strs []string) (Settings, *ErrorMessage)
• type AnswerOption
• type ErrorMessage
• type IDToNameConverter
• type Metadata
  • func (m *Metadata) ToMap() map[string]interface{}
• type Poll
  • func DecodePollFromByte(b []byte) *Poll
  • func (p *Poll) AddAnswerOption(newAnswerOption string) *ErrorMessage
  • func (p *Poll) Copy() *Poll
  • func (p *Poll) EncodeToByte() []byte
  • func (p *Poll) GetMetadata(userID string, permission bool) *Metadata
  • func (p *Poll) GetVotedAnswers(userID string) []string
  • func (p *Poll) HasVoted(userID string) bool
  • func (p *Poll) IsMultiVote() bool
  • func (p *Poll) ResetVotes(userID string)
  • func (p *Poll) ToEndPollPost(localizer *i18n.Localizer, authorName string, convert IDToNameConverter) (*model.Post, *model.AppError)
  • func (p *Poll) ToPostActions(localizer *i18n.Localizer, pluginID, authorName string) []*model.SlackAttachment
  • func (p *Poll) UpdateVote(userID string, index int) (*i18n.Message, error)
• type Settings
  • func NewSettingsFromSubmission(submission map[string]interface{}) Settings

Constants

const (
	SettingKeyAnonymous       = "anonymous"
	SettingKeyProgress        = "progress"
	SettingKeyPublicAddOption = "public-add-option"
)

const (
	// MatterpollAdminButtonType is action_type of buttons that are used for managing a poll.
	MatterpollAdminButtonType = "custom_matterpoll_admin_button"
)

Functions

func NewPoll

func NewPoll(creator, question string, answerOptions []string, settings Settings) (*Poll, *ErrorMessage)

NewPoll creates a new poll with the given parameter.

func NewSettingsFromStrings

func NewSettingsFromStrings(strs []string) (Settings, *ErrorMessage)

NewSettingsFromStrings creates a new settings with the given parameter.

Types

type AnswerOption

type AnswerOption struct {
	Answer string
	Voter  []string
}

AnswerOption stores a possible answer and a list of user who voted for this

type ErrorMessage

type ErrorMessage struct {
	Message *i18n.Message
	Data    map[string]interface{}
}

ErrorMessage contains error messsage for a user that can be localized. It should not be wrapped and instead always returned.

type IDToNameConverter

type IDToNameConverter func(userID string) (string, *model.AppError)

IDToNameConverter converts a given userID to a human readable name.

type Metadata

type Metadata struct {
	VotedAnswers           []string `json:"voted_answers"` // VotedAnswers is list of answer that the user with "UserID" have voted for the poll with "PollID"
	PollID                 string   `json:"poll_id"`
	UserID                 string   `json:"user_id"`
	AdminPermission        bool     `json:"admin_permission"` // AdminPermission will be true if the user with "UserID" has admin permission for the poll with "PollID", otherwise false.
	SettingPublicAddOption bool     `json:"setting_public_add_option"`
}

Metadata stores personalized metadata of a poll.

func (*Metadata) ToMap

func (m *Metadata) ToMap() map[string]interface{}

ToMap returns a Metadata as a map

type Poll

type Poll struct {
	ID            string
	PostID        string `json:"post_id,omitempty"`
	CreatedAt     int64
	Creator       string
	Question      string
	AnswerOptions []*AnswerOption
	Settings      Settings
}

Poll stores all needed information for a poll

func DecodePollFromByte

func DecodePollFromByte(b []byte) *Poll

DecodePollFromByte tries to create a poll from a byte array

func (*Poll) AddAnswerOption

func (p *Poll) AddAnswerOption(newAnswerOption string) *ErrorMessage

AddAnswerOption adds a new AnswerOption to a poll

func (*Poll) Copy

func (p *Poll) Copy() *Poll

Copy deep copies a poll

func (*Poll) EncodeToByte

func (p *Poll) EncodeToByte() []byte

EncodeToByte returns a poll as a byte array

func (*Poll) GetMetadata

func (p *Poll) GetMetadata(userID string, permission bool) *Metadata

GetMetadata returns personalized metadata of a poll.

func (*Poll) GetVotedAnswers

func (p *Poll) GetVotedAnswers(userID string) []string

GetVotedAnswers collect voted answers by a user and returns it as string array.

func (*Poll) HasVoted

func (p *Poll) HasVoted(userID string) bool

HasVoted return true if a given user has voted in this poll

func (*Poll) IsMultiVote

func (p *Poll) IsMultiVote() bool

IsMultiVote return true if poll is set to multi vote

func (*Poll) ResetVotes

func (p *Poll) ResetVotes(userID string)

ResetVotes remove votes by a given user

func (*Poll) ToEndPollPost

func (p *Poll) ToEndPollPost(localizer *i18n.Localizer, authorName string, convert IDToNameConverter) (*model.Post, *model.AppError)

ToEndPollPost returns the poll end message

func (*Poll) ToPostActions

func (p *Poll) ToPostActions(localizer *i18n.Localizer, pluginID, authorName string) []*model.SlackAttachment

ToPostActions returns the poll as a message

func (*Poll) UpdateVote

func (p *Poll) UpdateVote(userID string, index int) (*i18n.Message, error)

UpdateVote performs a vote for a given user

type Settings

type Settings struct {
	Anonymous       bool
	Progress        bool
	PublicAddOption bool
	MaxVotes        int `json:"max_votes"`
}

Settings stores possible settings for a poll

func NewSettingsFromSubmission

func NewSettingsFromSubmission(submission map[string]interface{}) Settings

NewSettingsFromSubmission creates a new settings with the given parameter.