repository

Documentation

Index

• type App
• type Auth
• type Channel
• type Feedback
• type Field
• type File
• type Permission
• type User
• type Userinfo

Types

type App

type App interface {
	// GetApp 获取指定的应用信息
	GetApp(ctx kratosx.Context, id uint32) (*entity.App, error)

	// ListApp 获取应用信息列表
	ListApp(ctx kratosx.Context, req *types.ListAppRequest) ([]*entity.App, uint32, error)

	// CreateApp 创建应用信息
	CreateApp(ctx kratosx.Context, req *entity.App) (uint32, error)

	// UpdateApp 更新应用信息
	UpdateApp(ctx kratosx.Context, req *entity.App) error

	// UpdateAppStatus 更新应用信息状态
	UpdateAppStatus(ctx kratosx.Context, req *types.UpdateAppStatusRequest) error

	// DeleteApp 删除应用信息
	DeleteApp(ctx kratosx.Context, id uint32) error

	// GetAppByKeyword 获取指定的应用信息
	GetAppByKeyword(ctx kratosx.Context, keyword string) (*entity.App, error)
}

type Auth

type Auth interface {
	// ListAuth 获取应用授权信息列表
	ListAuth(ctx kratosx.Context, req *types.ListAuthRequest) ([]*entity.Auth, uint32, error)

	// CreateAuth 创建应用授权信息
	CreateAuth(ctx kratosx.Context, req *entity.Auth) (uint32, error)

	// UpsertAuth 更新应用授权信息
	UpsertAuth(ctx kratosx.Context, req *entity.Auth) error

	// UpdateAuthStatus 更新应用授权信息状态
	UpdateAuthStatus(ctx kratosx.Context, req *types.UpdateAuthStatusRequest) error

	// DeleteAuth 删除应用授权信息
	DeleteAuth(ctx kratosx.Context, userId uint32, appId uint32) error

	// GetAuth 获取指定的应用授权信息
	GetAuth(ctx kratosx.Context, id uint32) (*entity.Auth, error)

	// GetAuthByUA 获取指定的应用授权信息
	GetAuthByUA(ctx kratosx.Context, uid uint32, aid uint32) (*entity.Auth, error)

	// IsBindOAuth 判断渠道是否绑定用户
	IsBindOAuth(ctx kratosx.Context, cid uint32, aid string) bool

	// GetOAuthByCA 获取指定的授权信息
	GetOAuthByCA(ctx kratosx.Context, cid uint32, aid string) (*entity.OAuth, error)

	// ListOAuth 获取应用授权信息列表
	ListOAuth(ctx kratosx.Context, req *types.ListOAuthRequest) ([]*entity.OAuth, uint32, error)

	// CreateOAuth 创建应用授权信息
	CreateOAuth(ctx kratosx.Context, req *entity.OAuth) (string, error)

	// GetOAuthByUid 获取指定的三方授权应用
	GetOAuthByUid(ctx kratosx.Context, uid string) (*entity.OAuth, error)

	// UpdateOAuth 更新应用授权信息
	UpdateOAuth(ctx kratosx.Context, req *entity.OAuth) error

	// DeleteOAuth 删除应用授权信息
	DeleteOAuth(ctx kratosx.Context, userId uint32, appId uint32) error

	// BindOAuthByUid 通过授权渠道号绑定
	BindOAuthByUid(ctx kratosx.Context, uid uint32, aid string) error
}

type Channel

type Channel interface {
	// GetChannelByKeyword 获取指定的登陆渠道
	GetChannelByKeyword(ctx kratosx.Context, keyword string) (*entity.Channel, error)

	// GetChannel 获取指定的登陆渠道
	GetChannel(ctx kratosx.Context, id uint32) (*entity.Channel, error)

	// ListChannel 获取登陆渠道列表
	ListChannel(ctx kratosx.Context, req *types.ListChannelRequest) ([]*entity.Channel, uint32, error)

	// CreateChannel 创建登陆渠道
	CreateChannel(ctx kratosx.Context, req *entity.Channel) (uint32, error)

	// UpdateChannel 更新登陆渠道
	UpdateChannel(ctx kratosx.Context, req *entity.Channel) error

	// DeleteChannel 删除登陆渠道
	DeleteChannel(ctx kratosx.Context, id uint32) error
}

type Feedback

type Feedback interface {
	// ListFeedbackCategory 获取反馈建议分类列表
	ListFeedbackCategory(ctx kratosx.Context, req *types.ListFeedbackCategoryRequest) ([]*entity.FeedbackCategory, uint32, error)

	// CreateFeedbackCategory 创建反馈建议分类
	CreateFeedbackCategory(ctx kratosx.Context, req *entity.FeedbackCategory) (uint32, error)

	// UpdateFeedbackCategory 更新反馈建议分类
	UpdateFeedbackCategory(ctx kratosx.Context, req *entity.FeedbackCategory) error

	// DeleteFeedbackCategory 删除反馈建议分类
	DeleteFeedbackCategory(ctx kratosx.Context, id uint32) error

	// IsExistFeedbackByMd5 是否存在反馈
	IsExistFeedbackByMd5(ctx kratosx.Context, md5 string) bool

	// GetFeedback 获取反馈建议
	GetFeedback(ctx kratosx.Context, id uint32) (*entity.Feedback, error)

	// ListFeedback 获取反馈建议列表
	ListFeedback(ctx kratosx.Context, req *types.ListFeedbackRequest) ([]*entity.Feedback, uint32, error)

	// CreateFeedback 创建反馈建议
	CreateFeedback(ctx kratosx.Context, req *entity.Feedback) (uint32, error)

	// DeleteFeedback 删除反馈建议
	DeleteFeedback(ctx kratosx.Context, id uint32) error

	// UpdateFeedback 更新反馈建议
	UpdateFeedback(ctx kratosx.Context, req *entity.Feedback) error
}

type Field

type Field interface {
	// ListField 获取用户字段列表
	ListField(ctx kratosx.Context, req *types.ListFieldRequest) ([]*entity.Field, uint32, error)

	// CreateField 创建用户字段
	CreateField(ctx kratosx.Context, req *entity.Field) (uint32, error)

	// UpdateField 更新用户字段
	UpdateField(ctx kratosx.Context, req *entity.Field) error

	// DeleteField 删除用户字段
	DeleteField(ctx kratosx.Context, id uint32) error
}

type File

type File interface {
	// GetFileURL 获取指定文件的url
	GetFileURL(ctx kratosx.Context, sha string) string
}

type Permission

type Permission interface {
	// GetPermission 获取当前用户，指定key的权限
	GetPermission(ctx kratosx.Context, keyword string) (bool, []uint32, error)

	// GetApp 获取当前用户对于app的权限
	GetApp(ctx kratosx.Context) (bool, []uint32, error)

	// HasApp 获取当前用户是否具有指定app的权限
	HasApp(ctx kratosx.Context, id uint32) bool
}

type User

type User interface {
	// GetUser 获取指定的用户信息
	GetUser(ctx kratosx.Context, id uint32) (*entity.User, error)

	// ListUser 获取用户信息列表
	ListUser(ctx kratosx.Context, req *types.ListUserRequest) ([]*entity.User, uint32, error)

	// CreateUser 创建用户信息
	CreateUser(ctx kratosx.Context, req *entity.User) (uint32, error)

	// ImportUser 导入用户信息
	ImportUser(ctx kratosx.Context, req []*entity.User) (uint32, error)

	// ExportUser 导出用户信息
	ExportUser(ctx kratosx.Context, req *types.ExportUserRequest) (string, error)

	// UpdateUser 更新用户信息
	UpdateUser(ctx kratosx.Context, req *entity.User) error

	// UpdateUserStatus 更新用户信息状态
	UpdateUserStatus(ctx kratosx.Context, req *types.UpdateUserStatusRequest) error

	// DeleteUser 删除用户信息
	DeleteUser(ctx kratosx.Context, ids []uint32) (uint32, error)

	// GetTrashUser 获取指定的回收站用户信息
	GetTrashUser(ctx kratosx.Context, id uint32) (*entity.User, error)

	// ListTrashUser 获取回收站用户信息列表
	ListTrashUser(ctx kratosx.Context, req *types.ListTrashUserRequest) ([]*entity.User, uint32, error)

	// DeleteTrashUser 彻底删除用户信息
	DeleteTrashUser(ctx kratosx.Context, ids []uint32) (uint32, error)

	// RevertTrashUser 还原用户信息
	RevertTrashUser(ctx kratosx.Context, id uint32) error

	// GetUserByPhone 获取指定的用户信息
	GetUserByPhone(ctx kratosx.Context, phone string) (*entity.User, error)

	// GetUserByEmail 获取指定的用户信息
	GetUserByEmail(ctx kratosx.Context, email string) (*entity.User, error)

	// GetUserByUsername 获取指定的用户信息
	GetUserByUsername(ctx kratosx.Context, username string) (*entity.User, error)

	// HasUserByEmail 是否存在指定的用户邮箱信息
	HasUserByEmail(ctx kratosx.Context, email string) bool

	// HasUserByUsername 是否存在指定的用户账户信息
	HasUserByUsername(ctx kratosx.Context, un string) bool
}

type Userinfo

type Userinfo interface {
	// ListUserinfo 获取用户扩展信息列表
	ListUserinfo(ctx kratosx.Context, req *types.ListUserinfoRequest) ([]*entity.Userinfo, uint32, error)

	// UpdateUserinfo 更新用户扩展信息
	UpdateUserinfo(ctx kratosx.Context, req *entity.Userinfo) error

	// CheckKeywords 检查keyword是否合法
	CheckKeywords(ctx kratosx.Context, appId uint32, keywords []string) error

	// CreateUserinfo 创建用户扩展信息
	CreateUserinfo(ctx kratosx.Context, req *entity.Userinfo) (uint32, error)

	// DeleteUserinfo 删除用户扩展信息
	DeleteUserinfo(ctx kratosx.Context, id uint32) error
}