user

Documentation

Overview

Package user 用户管理，权限，邀请别人假如

提供了与用户数据相关的工具函数

Index

• Variables
• func CheckQrCode(c *gin.Context)
• func CheckRoleID(roleID int) (err error)
• func DelUser(c *gin.Context)
• func GetArea(areaID uint64) (areaInfo area.Area, err error)
• func GetInvitationCode(c *gin.Context)
• func GetRoleInfo(uID int) (roleInfos []entity.RoleInfo, err error)
• func GetVerificationCode(c *gin.Context)
• func InfoUser(c *gin.Context)
• func ListUser(c *gin.Context)
• func RegisterUserRouter(r gin.IRouter)
• func TransferOwner(c *gin.Context)
• func UpdateUser(c *gin.Context)
• func WrapUserInfo(user entity.User, isOwner bool) (infoUser entity.UserInfo, err error)
• func WrapUsers(userRoles []entity.UserRole, areaID uint64) (listUsers []entity.UserInfo, err error)
• type CheckQrCodeResp
• type GetVerificationCodeResp
• type ListUserResp

Variables

var (
	NameSizeMin = 6
	NameSizeMax = 20
)

Functions

func CheckQrCode

func CheckQrCode(c *gin.Context)

CheckQrCode 用于处理扫描邀请二维码接口的请求

func CheckRoleID

func CheckRoleID(roleID int) (err error)

func DelUser

func DelUser(c *gin.Context)

DelUser 用于处理删除成员接口的请求

func GetArea

func GetArea(areaID uint64) (areaInfo area.Area, err error)

GetArea 获取家庭信息

func GetInvitationCode

func GetInvitationCode(c *gin.Context)

GetInvitationCode 用于处理获取邀请二维码接口的请求

func GetRoleInfo

func GetRoleInfo(uID int) (roleInfos []entity.RoleInfo, err error)

func GetVerificationCode

func GetVerificationCode(c *gin.Context)

func InfoUser

func InfoUser(c *gin.Context)

InfoUser 用于处理用户详情接口的请求

func ListUser

func ListUser(c *gin.Context)

ListUser 用于处理成员列表接口的请求

func RegisterUserRouter

func RegisterUserRouter(r gin.IRouter)

RegisterUserRouter 注册与用户相关的路由及其处理函数

func TransferOwner

func TransferOwner(c *gin.Context)

func UpdateUser

func UpdateUser(c *gin.Context)

UpdateUser 用于处理修改用户接口的请求

func WrapUserInfo

func WrapUserInfo(user entity.User, isOwner bool) (infoUser entity.UserInfo, err error)

func WrapUsers

func WrapUsers(userRoles []entity.UserRole, areaID uint64) (listUsers []entity.UserInfo, err error)

Types

type CheckQrCodeResp

type CheckQrCodeResp struct {
	UserInfo entity.UserInfo `json:"user_info"`
	AreaInfo area.Area       `json:"area_info"`
}

CheckQrCodeResp 扫描邀请二维码接口返回数据

type GetVerificationCodeResp

type GetVerificationCodeResp struct {
	Code     string `json:"code"`
	ExpireIn int    `json:"expire_in"`
}

type ListUserResp

type ListUserResp struct {
	IsOwner   bool              `json:"is_owner"`
	UserCount int               `json:"user_count"`
	Users     []entity.UserInfo `json:"users"`
}

ListUserResp 成员列表接口返回数据