privacy

Documentation

Index

• Variables
• func AdminRoleAsString() string
• func EmployeeRoleAsString() string
• func NewViewerContext(parent context.Context, role Role, scopes []string) context.Context
• func OwnerRoleAsString() string
• func ViewerRole() int
• func ViewerRoleAsString() string
• type Role
• type UserViewer
  • func FromContext(ctx context.Context) (UserViewer, bool)
  • func (v *UserViewer) Admin() bool
  • func (v *UserViewer) Employee() bool
  • func (v *UserViewer) GetUserID() string
  • func (v *UserViewer) HasScope(scope string) bool
  • func (v *UserViewer) HasScopes() bool
  • func (v *UserViewer) IsEmpty() bool
  • func (v *UserViewer) Owner() bool
  • func (v *UserViewer) SetRole(role int) error
  • func (v *UserViewer) SetRoleAsString(role string) error
  • func (v *UserViewer) SetUserID(id string)
  • func (v *UserViewer) ToContext(ctx context.Context) context.Context
• type Viewer

Variables

var ContextKeyViewer = contextKey("viewer")

Functions

func AdminRoleAsString

func AdminRoleAsString() string

func EmployeeRoleAsString

func EmployeeRoleAsString() string

func NewViewerContext

func NewViewerContext(parent context.Context, role Role, scopes []string) context.Context

NewViewerContext returns a copy of parent context with a new constructed Viewer attached with it.

func OwnerRoleAsString

func OwnerRoleAsString() string

func ViewerRole

func ViewerRole() int

func ViewerRoleAsString

func ViewerRoleAsString() string

Types

type Role

type Role int

Role for viewer actions.

const (
	Admin Role
	Owner
	Employee
	View
)

List of roles.

type UserViewer

type UserViewer struct {
	Role   Role     // Attached roles.
	Scopes []string // Attached businesses for this role
	Claims map[string]string
}

UserViewer describes a user-viewer.

func FromContext

func FromContext(ctx context.Context) (UserViewer, bool)

FromContext returns the Viewer stored in a context.

func (*UserViewer) Admin

func (v *UserViewer) Admin() bool

func (*UserViewer) Employee

func (v *UserViewer) Employee() bool

func (*UserViewer) GetUserID

func (v *UserViewer) GetUserID() string

func (*UserViewer) HasScope

func (v *UserViewer) HasScope(scope string) bool

func (*UserViewer) HasScopes

func (v *UserViewer) HasScopes() bool

func (*UserViewer) IsEmpty

func (v *UserViewer) IsEmpty() bool

func (*UserViewer) Owner

func (v *UserViewer) Owner() bool

func (*UserViewer) SetRole

func (v *UserViewer) SetRole(role int) error

func (*UserViewer) SetRoleAsString

func (v *UserViewer) SetRoleAsString(role string) error

func (*UserViewer) SetUserID

func (v *UserViewer) SetUserID(id string)

func (*UserViewer) ToContext

func (v *UserViewer) ToContext(ctx context.Context) context.Context

ToContext sets the Viewer on the given context.

type Viewer

type Viewer interface {
	Admin() bool // If viewer is admin.
	Owner() bool
	Employee() bool
	SetRole() error
	IsEmpty() bool
	HasScopes() bool
	HasScope(scope string) bool
	GetUserID() string
}

Viewer describes the query/mutation viewer-context.