paginatedmessages

Documentation

Index

• Constants
• Variables
• func PaginatedCommand(pageArgIndex int, cb PaginatedCommandFunc) dcmd.RunFunc
• func RegisterPlugin()
• type CtxKey
• type PagerFunc
• type PaginatedCommandFunc
• type PaginatedMessage
  • func CreatePaginatedMessage(guildID, channelID int64, initPage, maxPages int, pagerFunc PagerFunc) (*PaginatedMessage, error)
  • func (p *PaginatedMessage) HandleReactionAdd(ra *discordgo.MessageReactionAdd)
  • func (p *PaginatedMessage) Stop()
• type Plugin
  • func (p *Plugin) BotInit()
  • func (p *Plugin) PluginInfo() *common.PluginInfo
  • func (p *Plugin) StopBot(wg *sync.WaitGroup)

Constants

const (
	EmojiNext = "➡"
	EmojiPrev = "⬅"
)

Variables

var ErrNoResults = errors.New("No results")

Functions

func PaginatedCommand

func PaginatedCommand(pageArgIndex int, cb PaginatedCommandFunc) dcmd.RunFunc

func RegisterPlugin

func RegisterPlugin()

Types

type CtxKey

type CtxKey int

const CtxKeyNoPagination CtxKey = 1

type PagerFunc

type PagerFunc func(p *PaginatedMessage, page int) (*discordgo.MessageEmbed, error)

type PaginatedCommandFunc

type PaginatedCommandFunc func(data *dcmd.Data, p *PaginatedMessage, page int) (*discordgo.MessageEmbed, error)

type PaginatedMessage

type PaginatedMessage struct {
	// immutable fields, safe to access without a lock, don't write to these, i dont see why you would need to either...
	MessageID int64
	ChannelID int64
	GuildID   int64

	// mutable fields
	CurrentPage  int
	MaxPage      int
	LastResponse *discordgo.MessageEmbed
	Navigate     func(p *PaginatedMessage, newPage int) (*discordgo.MessageEmbed, error)
	Broken       bool
	// contains filtered or unexported fields
}

func CreatePaginatedMessage

func CreatePaginatedMessage(guildID, channelID int64, initPage, maxPages int, pagerFunc PagerFunc) (*PaginatedMessage, error)

func (*PaginatedMessage) HandleReactionAdd

func (p *PaginatedMessage) HandleReactionAdd(ra *discordgo.MessageReactionAdd)

func (*PaginatedMessage) Stop

func (p *PaginatedMessage) Stop()

type Plugin

type Plugin struct{}

func (*Plugin) BotInit

func (p *Plugin) BotInit()

func (*Plugin) PluginInfo

func (p *Plugin) PluginInfo() *common.PluginInfo

func (*Plugin) StopBot

func (p *Plugin) StopBot(wg *sync.WaitGroup)