roles

Documentation

Index

• Constants
• type Category
  • func (*Category) TableName() string
• type Plugin
  • func (p *Plugin) Action(event *events.Event) bool
  • func (p *Plugin) Help() *common.PluginHelp
  • func (p *Plugin) Names() []string
  • func (p *Plugin) Passthrough() bool
  • func (p *Plugin) Priority() int
  • func (p *Plugin) Start(params common.StartParameters) error
  • func (p *Plugin) Stop(params common.StopParameters) error
• type Role
  • func (r *Role) Match(state *state.State, input string) bool
  • func (r *Role) Name(state *state.State) string
  • func (*Role) TableName() string

Constants

const (
	ServerRoleNotFound          string = "roles.role.role-not-found-on-server"
	MultipleServerRolesWithName string = "roles.role.multiple-server-roles-with-name"
)

const (
	PLUS  = "+"
	MINUS = "-"
)

const (
	INTERVAL = 30 * time.Minute
)

Types

type Category

type Category struct {
	gorm.Model

	Name      string
	GuildID   string
	ChannelID string // the channel this Category will listen to for role assignments
	Roles     []Role `gorm:"foreignkey:CategoryID"`
	Enabled   bool
	Hidden    bool
	Limit     int // 0 = no limit
}

func (*Category) TableName

func (*Category) TableName() string

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

func (*Plugin) Action

func (p *Plugin) Action(event *events.Event) bool

func (*Plugin) Help

func (p *Plugin) Help() *common.PluginHelp

func (*Plugin) Names

func (p *Plugin) Names() []string

func (*Plugin) Passthrough

func (p *Plugin) Passthrough() bool

func (*Plugin) Priority

func (p *Plugin) Priority() int

func (*Plugin) Start

func (p *Plugin) Start(params common.StartParameters) error

func (*Plugin) Stop

func (p *Plugin) Stop(params common.StopParameters) error

type Role

type Role struct {
	gorm.Model

	CategoryID   uint // roles aren't guarenteed to have a category
	GuildID      string
	ServerRoleID string
	PrintName    string
	Emoji        string
	Enabled      bool
	Aliases      pq.StringArray `gorm:"type:varchar[]"`
}

func (*Role) Match

func (r *Role) Match(state *state.State, input string) bool

matches the input to see if its the server role name or the print name, or one of the aliases

func (*Role) Name

func (r *Role) Name(state *state.State) string

func (*Role) TableName

func (*Role) TableName() string