roles

Documentation

Index

• Constants
• type Assigner
  • func NewRoleStorage(s *dg.Session, xp *xp.System) Assigner
• type DgSession
• type MsgEmbed

Constants

const SelfAssignFile string = "data/selfAssignRoles.json"

SelfAssignFile is the path were tha self assign role data is located

Types

type Assigner

type Assigner interface {
	ExecuteRoleCommands(req []string, msg *dg.MessageCreate) (*dg.MessageEmbed, error)
	LoadSelfAssignRoles(file string) error
	AutoPromote(msg *dg.MessageCreate) error
	LoadAutoRanks(file string) error
}

Assigner is the interface for interacting with the roleAction methods

func NewRoleStorage

func NewRoleStorage(s *dg.Session, xp *xp.System) Assigner

NewRoleStorage creates the roles package data storage map for the session

type DgSession

type DgSession interface {
	GuildRoles(guildID string) (st []*dg.Role, err error)
	GuildMember(guildID string, userID string) (st *dg.Member, err error)
	GuildMembers(guildID string, after string, limit int) (st []*dg.Member, err error)
	GuildMemberRoleAdd(guildID string, userID string, roleID string) (err error)
	GuildMemberRoleRemove(guildID string, userID string, roleID string) (err error)
}

DgSession is the interface for mocking the discordgo session functions in this package.

type MsgEmbed

type MsgEmbed *dg.MessageEmbed

MsgEmbed is used to shorten the name of the original embed type from discordGo