vikunja-api/pkg/models/user_right.go

//  Vikunja is a todo-list application to facilitate your life.
//  Copyright 2018 Vikunja and contributors. All rights reserved.
//
//  This program is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program.  If not, see <https://www.gnu.org/licenses/>.

package models

// UserRight defines the rights users can have for lists/namespaces
type UserRight int

// define unknown user right
const (
	UserRightUnknown = -1
)

// Enumerate all the user rights
const (
	// Can read lists in a User
	UserRightRead UserRight = iota
	// Can write tasks in a User like lists and todo tasks. Cannot create new lists.
	UserRightWrite
	// Can manage a list/namespace, can do everything
	UserRightAdmin
)

func (r UserRight) isValid() error {
	if r != UserRightAdmin && r != UserRightRead && r != UserRightWrite {
		return ErrInvalidUserRight{r}
	}

	return nil
}