rolerules

package

v0.0.0-...-ba096a2 Latest Latest Go to latest Published: Nov 10, 2018 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/camd67/moebot

Links

Open Source Insights

Documentation ¶

Index ¶

type Confirmation
- func (r *Confirmation) Apply(session *discordgo.Session, action *RoleAction) (success bool, message string)
- func (r *Confirmation) Check(session *discordgo.Session, action *RoleAction) (success bool, message string)
type Exclusive
- func (r *Exclusive) Apply(session *discordgo.Session, action *RoleAction) (success bool, message string)
- func (r *Exclusive) Check(session *discordgo.Session, action *RoleAction) (success bool, message string)
type NoMultiples
- func (r *NoMultiples) Apply(session *discordgo.Session, action *RoleAction) (success bool, message string)
- func (r *NoMultiples) Check(session *discordgo.Session, action *RoleAction) (success bool, message string)
type NoRemove
- func (r *NoRemove) Apply(session *discordgo.Session, action *RoleAction) (success bool, message string)
- func (r *NoRemove) Check(session *discordgo.Session, action *RoleAction) (success bool, message string)
type Points
- func (r *Points) Apply(session *discordgo.Session, action *RoleAction) (success bool, message string)
- func (r *Points) Check(session *discordgo.Session, action *RoleAction) (success bool, message string)
type RoleAction
type RoleActionType
type RoleRule
- func GetRulesForRole(server *types.Server, role *types.Role, comPrefix string) ([]RoleRule, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Confirmation ¶

type Confirmation struct {
	ComPrefix string
}

func (*Confirmation) Apply ¶

func (r *Confirmation) Apply(session *discordgo.Session, action *RoleAction) (success bool, message string)

func (*Confirmation) Check ¶

func (r *Confirmation) Check(session *discordgo.Session, action *RoleAction) (success bool, message string)

type Exclusive ¶

type Exclusive struct {
	ExclusiveRoles []types.Role
}

func (*Exclusive) Apply ¶

func (r *Exclusive) Apply(session *discordgo.Session, action *RoleAction) (success bool, message string)

func (*Exclusive) Check ¶

func (r *Exclusive) Check(session *discordgo.Session, action *RoleAction) (success bool, message string)

type NoMultiples ¶

type NoMultiples struct {
	ExclusiveRoles []types.Role
}

func (*NoMultiples) Apply ¶

func (r *NoMultiples) Apply(session *discordgo.Session, action *RoleAction) (success bool, message string)

func (*NoMultiples) Check ¶

func (r *NoMultiples) Check(session *discordgo.Session, action *RoleAction) (success bool, message string)

type NoRemove ¶

type NoRemove struct {
	ReferenceGroup types.RoleGroup
}

func (*NoRemove) Apply ¶

func (r *NoRemove) Apply(session *discordgo.Session, action *RoleAction) (success bool, message string)

func (*NoRemove) Check ¶

func (r *NoRemove) Check(session *discordgo.Session, action *RoleAction) (success bool, message string)

type Points ¶

type Points struct {
	PointsTreshold int
}

func (*Points) Apply ¶

func (r *Points) Apply(session *discordgo.Session, action *RoleAction) (success bool, message string)

func (*Points) Check ¶

func (r *Points) Check(session *discordgo.Session, action *RoleAction) (success bool, message string)

type RoleAction ¶

type RoleAction struct {
	Role            *types.Role
	UserRank        *types.UserServerRank
	Member          *discordgo.Member
	Guild           *discordgo.Guild
	Channel         *discordgo.Channel
	OriginalMessage *discordgo.Message
	Action          RoleActionType
}

RoleAction Action being performed on the role

type RoleActionType ¶

type RoleActionType int

RoleActionType Type of action being performed on the role

const (
	//RoleAdd Adding the role
	RoleAdd RoleActionType = 1
	//RoleRemove Removing the role
	RoleRemove RoleActionType = 2
)

type RoleRule ¶

type RoleRule interface {
	Check(session *discordgo.Session, action *RoleAction) (success bool, message string)
	Apply(session *discordgo.Session, action *RoleAction) (success bool, message string)
}

RoleRule Rule defining if and how a role should be applied

func GetRulesForRole ¶

func GetRulesForRole(server *types.Server, role *types.Role, comPrefix string) ([]RoleRule, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL