README
¶
Nibbler User
Provides a basic user model, and some means to persist and query it. No API endpoints are added by this extension
Utilities
- GetSafeUser: returns a version of the user with sensitive properties wiped.
- EnforceLoggedIn
- EnforceEmailValidated
Context and Protected Context
- Some "room" is available in the default user model for app-specific data that is attached to users. These are the context properties. The difference between Context and Protected Context is whether or not API requests should expose the data or not. The Protected Context is a place where the back-end can attach additional info without it ever being seen by the user, essentially.
Documentation
¶
Index ¶
- func FromJson(jsonString string) (*nibbler.User, error)
- func GetSafeUser(user nibbler.User) nibbler.User
- func ToJson(user *nibbler.User) (result string, err error)
- type Extension
- func (s *Extension) Create(user *nibbler.User) (*nibbler.User, error)
- func (s *Extension) Destroy(app *nibbler.Application) error
- func (s *Extension) GetName() string
- func (s *Extension) GetUserByEmail(email string) (*nibbler.User, error)
- func (s *Extension) GetUserByEmailVerificationToken(token string) (*nibbler.User, error)
- func (s *Extension) GetUserById(id string) (*nibbler.User, error)
- func (s *Extension) GetUserByPasswordResetToken(token string) (*nibbler.User, error)
- func (s *Extension) GetUserByUsername(username string) (*nibbler.User, error)
- func (s *Extension) Init(app *nibbler.Application) error
- func (s *Extension) PostInit(app *nibbler.Application) error
- func (s *Extension) SearchUsers(query nibbler.SearchParameters) (*nibbler.SearchResults, error)
- func (s *Extension) Update(user *nibbler.User) error
- func (s *Extension) UpdatePassword(user *nibbler.User) error
- type PersistenceExtension
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Extension ¶
type Extension struct {
nibbler.Extension
PersistenceExtension PersistenceExtension
OnBeforeUserCreate func(user *nibbler.User)
OnAfterUserCreate func(user *nibbler.User)
OnBeforeUserUpdate func(user *nibbler.User)
OnAfterUserUpdate func(user *nibbler.User)
OnBeforePasswordUpdate func(user *nibbler.User)
OnAfterPasswordUpdate func(user *nibbler.User)
}
func (*Extension) GetUserByEmail ¶
func (*Extension) GetUserByEmailVerificationToken ¶ added in v0.3.4
func (*Extension) GetUserByPasswordResetToken ¶
func (*Extension) GetUserByUsername ¶
func (*Extension) PostInit ¶ added in v0.14.0
func (s *Extension) PostInit(app *nibbler.Application) error
func (*Extension) SearchUsers ¶ added in v0.23.0
func (s *Extension) SearchUsers(query nibbler.SearchParameters) (*nibbler.SearchResults, error)
type PersistenceExtension ¶
type PersistenceExtension interface {
nibbler.Extension
Create(user *nibbler.User) (*nibbler.User, error)
GetUserByEmail(email string) (*nibbler.User, error)
GetUserByEmailValidationToken(token string) (*nibbler.User, error)
GetUserById(id string) (*nibbler.User, error)
GetUserByPasswordResetToken(token string) (*nibbler.User, error)
GetUserByUsername(username string) (*nibbler.User, error)
SearchUsers(query nibbler.SearchParameters) (*nibbler.SearchResults, error)
Update(user *nibbler.User) error
UpdatePassword(user *nibbler.User) error
}
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.