roles

package

v0.4.1 Latest Latest Go to latest Published: Apr 29, 2020 License: GPL-3.0 Imports: 7 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

Package roles is intended to provide Roles Based access controls for users and channels. This is a work in progress, and is likely to chnage.

This section is empty.

This section is empty.

func Check(ctx context.Context, role string) bool

Check verifies the the current user has the requested role

func CheckAll(ctx context.Context, want []string) bool

CheckAll checks that the user has all of the request roles.

func CheckAny(ctx context.Context, want []string) bool

CheckAny checks to see if the current user has any one of the request roles.

func FromContext(ctx context.Context) map[string]struct{}

FromContext retrieves a set of roles from the current context

func Register()

Register installs this handler on bot.DefaultBot

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

Handler implements support for user roles

func New(up hugot.Handler, cs command.Set, s storage.Storer) *Handler

New creates a new roles handler.

func (h *Handler) Describe() (string, string)

Describe implements the Describer interface for the alias handler

func (h *Handler) Help(w io.Writer) error

Help implements the command.Helper interfaace for the alias handler

func (h *Handler) ProcessMessage(ctx context.Context, w hugot.ResponseWriter, m *hugot.Message) error

ProcessMessage adds any roles the user has to the context