users

Documentation

Index

• type Users
  • func (users Users) Activate(email string) string
  • func (users Users) Add(mainData config.UserMain, extraData config.UserExtra) (string, string)
  • func (users Users) Auth(username, email, password string) (bool, string, string)
  • func (users Users) Delete(userID, username, password string) string
  • func (users Users) Disconnect()
  • func (users Users) Get(userID, collectionName string, data interface{}) error
  • func (users Users) GetByUsernameOrEmail(username, email string) (config.UserMain, string)
  • func (users *Users) Init()
  • func (users Users) Update(userID string, update interface{}, collectionName string)

Types

type Users

type Users struct {
	DBName string
	// contains filtered or unexported fields
}

Users is used to handle user data

func (Users) Activate

func (users Users) Activate(email string) string

Activate is used to mark an account as active

func (Users) Add

func (users Users) Add(
	mainData config.UserMain, extraData config.UserExtra) (string, string)

Add is used to add user to database

func (Users) Auth

func (users Users) Auth(username, email, password string) (bool, string, string)

Auth is used to authenticate a user

func (Users) Delete

func (users Users) Delete(userID, username, password string) string

Delete is used to mark a user as deleted

func (Users) Disconnect

func (users Users) Disconnect()

Disconnect is used to disconnect from the mongodb

func (Users) Get

func (users Users) Get(userID, collectionName string, data interface{}) error

Get is used to get user's data

func (Users) GetByUsernameOrEmail

func (users Users) GetByUsernameOrEmail(username, email string) (config.UserMain, string)

GetByUsernameOrEmail is used to get user based on username or email

func (*Users) Init

func (users *Users) Init()

Init is used to initialize users struct

func (Users) Update

func (users Users) Update(userID string, update interface{}, collectionName string)

Update is used to update users data in any collection