permission

Documentation

Overview

Package permission is used to store the various permission in praelatus, it acts as a pseudo-enumeration

Index

• Constants
• Variables
• func ValidPermission(permName Permission) bool
• type Permission
• type Permissions
  • func (p Permissions) Add(perms ...Permission) Permissions
  • func (p Permissions) Contains(permName Permission) bool

Constants

const (
	ViewProject      Permission = "VIEW_PROJECT"
	AdminProject                = "ADMIN_PROJECT"
	CreateTicket                = "CREATE_TICKET"
	CommentTicket               = "COMMENT_TICKET"
	RemoveComment               = "REMOVE_COMMENT"
	RemoveOwnComment            = "REMOVE_OWN_COMMENT"
	EditOwnComment              = "EDIT_OWN_COMMENT"
	EditComment                 = "EDIT_COMMENT"
	TransitionTicket            = "TRANSITION_TICKET"
	EditTicket                  = "EDIT_TICKET"
	RemoveTicket                = "REMOVE_TICKET"
)

These are the permissions available in Praelatus

Variables

var ListOfPermissions = [...]Permission{
	ViewProject,
	AdminProject,
	CreateTicket,
	CommentTicket,
	RemoveComment,
	RemoveOwnComment,
	EditOwnComment,
	EditComment,
	TransitionTicket,
	EditTicket,
	RemoveTicket,
}

ListOfPermissions holds available permissions in a slice. This is valuable for various areas where we need to return all permissions or iterate permissions.

Functions

func ValidPermission

func ValidPermission(permName Permission) bool

ValidPermission will verify that a given permission string is valid.

Types

type Permission

type Permission string

Permission is an alias type to make it's use more clear inside of models.

type Permissions

type Permissions []string

Permissions is used to add some convenience functions for checking permisisons

func (Permissions) Add

func (p Permissions) Add(perms ...Permission) Permissions

func (Permissions) Contains

func (p Permissions) Contains(permName Permission) bool