acceptmsg

Documentation

Overview

Package acceptmsg provides a message model for discordgo which can be accepted or declined via message reactions.

Index

• Variables
• type AcceptMessage
  • func New() *AcceptMessage
  • func (am *AcceptMessage) AsFollowUp(ctx ken.Context) (*AcceptMessage, error)
  • func (am *AcceptMessage) DeleteAfterAnswer() *AcceptMessage
  • func (am *AcceptMessage) DoOnAccept(onAccept ActionHandler) *AcceptMessage
  • func (am *AcceptMessage) DoOnDecline(onDecline ActionHandler) *AcceptMessage
  • func (am *AcceptMessage) Error() error
  • func (am *AcceptMessage) LockOnUser(userID string) *AcceptMessage
  • func (am *AcceptMessage) Send(chanID string) (*AcceptMessage, error)
  • func (am *AcceptMessage) WithContent(cont string) *AcceptMessage
  • func (am *AcceptMessage) WithEmbed(e *discordgo.MessageEmbed) *AcceptMessage
  • func (am *AcceptMessage) WithSession(s *discordgo.Session) *AcceptMessage
  • func (am *AcceptMessage) WithTimeout(t time.Duration) *AcceptMessage
• type ActionHandler

Variables

var (
	ErrTimeout = errors.New("timed out")
)

Types

type AcceptMessage

type AcceptMessage struct {
	*discordgo.Message
	Session        *discordgo.Session
	Embed          *discordgo.MessageEmbed
	UserID         string
	DeleteMsgAfter bool
	AcceptFunc     ActionHandler
	DeclineFunc    ActionHandler
	// contains filtered or unexported fields
}

AcceptMessage extends discordgo.Message to build and send an AcceptMessage.

func New

func New() *AcceptMessage

New creates an empty instance of AcceptMessage.

func (*AcceptMessage) AsFollowUp

func (am *AcceptMessage) AsFollowUp(ctx ken.Context) (*AcceptMessage, error)

AsFollowUp pushes the accept messages as follow up message to the command context and sets up listener handlers for reactions.

func (*AcceptMessage) DeleteAfterAnswer

func (am *AcceptMessage) DeleteAfterAnswer() *AcceptMessage

DeleteAfterAnswer enables that the whole accept embed message is being deleted after users answer.

func (*AcceptMessage) DoOnAccept

func (am *AcceptMessage) DoOnAccept(onAccept ActionHandler) *AcceptMessage

DoOnAccept specifies the action handler executed on acception.

func (*AcceptMessage) DoOnDecline

func (am *AcceptMessage) DoOnDecline(onDecline ActionHandler) *AcceptMessage

DoOnDecline specifies the action handler executed on decline.

func (*AcceptMessage) Error

func (am *AcceptMessage) Error() error

Error blocks until either one of the action functions was called or until the accept message timed out. Then, it returns an error or nil.

func (*AcceptMessage) LockOnUser

func (am *AcceptMessage) LockOnUser(userID string) *AcceptMessage

LockOnUser specifies, that only reaction inputs from the defined user are accepted.

func (*AcceptMessage) Send

func (am *AcceptMessage) Send(chanID string) (*AcceptMessage, error)

Send pushes the accept message into the specified channel and sets up listener handlers for reactions.

func (*AcceptMessage) WithContent

func (am *AcceptMessage) WithContent(cont string) *AcceptMessage

WithContent creates an embed with default color and specified content as description and sets it as embed instance.

func (*AcceptMessage) WithEmbed

func (am *AcceptMessage) WithEmbed(e *discordgo.MessageEmbed) *AcceptMessage

WithEmbed sets the Embed instance to be set.

func (*AcceptMessage) WithSession

func (am *AcceptMessage) WithSession(s *discordgo.Session) *AcceptMessage

WithSession sets the discordgo.Session instance.

func (*AcceptMessage) WithTimeout

func (am *AcceptMessage) WithTimeout(t time.Duration) *AcceptMessage

type ActionHandler

type ActionHandler func(*discordgo.Message) error