viewer

package
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 17, 2023 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

Package viewer contains role definitions for policies

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewContext

func NewContext(parent context.Context, v Viewer) context.Context

NewContext returns a copy of parent context with the given Viewer attached with it.

Types

type Role added in v0.1.1

type Role int

Role for viewer actions.

const (
	Admin Role
	View
)

List of roles.

type UserViewer

type UserViewer struct {
	UserID string
	T      *generated.Organization
	Role   Role // Attached roles.
}

UserViewer describes a user-viewer.

func (UserViewer) Admin added in v0.1.1

func (u UserViewer) Admin() bool

Admin of the UserViewer

func (UserViewer) GetUser added in v0.1.1

func (u UserViewer) GetUser() UserViewer

GetUser returns the user information.

func (UserViewer) GetUserID added in v0.1.1

func (u UserViewer) GetUserID() string

GetUserID returns the ID of the user.

type Viewer

type Viewer interface {
	GetUser() UserViewer
	GetUserID() string
	Admin() bool // If viewer is admin.
}

Viewer describes the query/mutation viewer-context.

func FromContext

func FromContext(ctx context.Context) Viewer

FromContext returns the Viewer stored in a context.

Jump to

Keyboard shortcuts

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