controller

Documentation

Overview

Package controller 主要处理逻辑

Index

• Variables
• func DeleteGroup(context *gin.Context)
• func GetAllPlugin(context *gin.Context)
• func GetBotList(context *gin.Context)
• func GetFriendList(context *gin.Context)
• func GetGroupList(context *gin.Context)
• func GetGroupMemberList(context *gin.Context)
• func GetLog(context *gin.Context)
• func GetPermCode(context *gin.Context)
• func GetPlugin(context *gin.Context)
• func GetRequestList(context *gin.Context)
• func GetUserInfo(context *gin.Context)
• func HandleRequest(context *gin.Context)
• func JobAdd(context *gin.Context)
• func JobDelete(context *gin.Context)
• func JobList(context *gin.Context)
• func Login(context *gin.Context)
• func Logout(context *gin.Context)
• func SendMsg(context *gin.Context)
• func UpdateAllPluginStatus(context *gin.Context)
• func UpdatePluginStatus(context *gin.Context)
• func UpdateResponseStatus(context *gin.Context)
• func Upgrade(context *gin.Context)

Variables

var (
	// MsgConn 向前端推送消息的ws链接
	MsgConn *websocket.Conn
	// LogConn 向前端推送日志的ws链接
	LogConn *websocket.Conn
)

Functions

func DeleteGroup

func DeleteGroup(context *gin.Context)

DeleteGroup 删除群聊或好友

@Tags			通用
@Summary		删除群聊或好友
@Description	删除群聊或好友
@Router			/api/deleteGroup [get]
@Param			object	body		types.DeleteGroupParams	false	"删除群聊或好友入参"
@Success		200		{object}	types.Response			"成功"

func GetAllPlugin

func GetAllPlugin(context *gin.Context)

GetAllPlugin 获取所有插件的状态

@Tags			插件
@Summary		获取所有插件的状态
@Description	获取所有插件的状态
@Router			/api/manage/getAllPlugin [get]
@Param			object	body		types.AllPluginParams					false	"获取所有插件的状态入参"
@Success		200		{object}	types.Response{result=[]types.PluginVo}	"成功"

func GetBotList

func GetBotList(context *gin.Context)

GetBotList 获取机器人qq号

@Tags			通用
@Summary		获取机器人qq号
@Description	获取机器人qq号
@Router			/api/getBotList [get]
@Success		200	{object}	types.Response	"成功"

func GetFriendList

func GetFriendList(context *gin.Context)

GetFriendList 获取好友列表

@Tags			通用
@Summary		获取好友列表
@Description	获取好友列表
@Router			/api/getFriendList [get]
@Param			selfId	query		int				false	"机器人qq"
@Success		200		{object}	types.Response	"成功"

func GetGroupList

func GetGroupList(context *gin.Context)

GetGroupList 获取群列表

@Tags			通用
@Summary		获取群列表
@Description	获取群列表
@Router			/api/getGroupList [get]
@Param			selfId	query		int				false	"机器人qq"
@Success		200		{object}	types.Response	"成功"

func GetGroupMemberList

func GetGroupMemberList(context *gin.Context)

GetGroupMemberList 获取群成员列表

@Tags			通用
@Summary		获取群成员列表
@Description	获取群成员列表,groupId为0的时候拉取好友信息
@Router			/api/getGroupMemberList [get]
@Param			selfId	query		int				false	"机器人qq"
@Param			groupId	query		int				false	"群聊id"
@Success		200		{object}	types.Response	"成功"

func GetLog

func GetLog(context *gin.Context)

GetLog 连接日志

func GetPermCode

func GetPermCode(context *gin.Context)

GetPermCode 授权码

@Tags			用户
@Summary		授权码
@Description	授权码
@Router			/api/getPermCode [get]
@Success		200	{object}	types.Response{result=[]string}	"成功"

func GetPlugin

func GetPlugin(context *gin.Context)

GetPlugin 获取某个插件的状态

@Tags			插件
@Summary		获取某个插件的状态
@Description	获取某个插件的状态
@Router			/api/manage/getPlugin [get]
@Param			object	body		types.PluginParams						false	"获取某个插件的状态入参"
@Success		200		{object}	types.Response{result=types.PluginVo}	"成功"

func GetRequestList

func GetRequestList(context *gin.Context)

GetRequestList 获取所有的请求

@Tags			通用
@Summary		获取所有的请求
@Description	获取所有的请求
@Router			/api/getRequestList [get]
@Param			object	body		types.BotParams								false	"获取所有的请求入参"
@Success		200		{object}	types.Response{result=[]types.RequestVo}	"成功"

func GetUserInfo

func GetUserInfo(context *gin.Context)

GetUserInfo 获得用户信息

@Tags			用户
@Summary		获得用户信息
@Description	获得用户信息
@Router			/api/getUserInfo [get]
@Success		200	{object}	types.Response{result=types.UserInfoVo}	"成功"

func HandleRequest

func HandleRequest(context *gin.Context)

HandleRequest 处理一个请求

@Tags			通用
@Summary		处理一个请求
@Description	处理一个请求
@Router			/api/handleRequest [post]
@Param			object	body		types.HandleRequestParams	false	"处理一个请求入参"
@Success		200		{object}	types.Response				"成功"

func JobAdd

func JobAdd(context *gin.Context)

JobAdd 添加任务

@Tags			任务
@Summary		添加任务
@Description	添加任务
@Router			/api/job/add [post]
@Param			object	body		job.Job				false	"添加任务入参"
@Success		200		{object}	types.Response	"成功"

func JobDelete

func JobDelete(context *gin.Context)

JobDelete 删除任务

@Tags			任务
@Summary		删除任务
@Description	删除任务
@Router			/api/job/delete [post]
@Param			object	body		job.DeleteReq		false	"删除任务的入参"
@Success		200		{object}	types.Response	"成功"

func JobList

func JobList(context *gin.Context)

JobList 任务列表

@Tags			任务
@Summary		任务列表
@Description	任务列表
@Router			/api/job/list [get]
@Success		200	{object}	types.Response{result=[]job.Job}	"成功"

func Login

func Login(context *gin.Context)

Login 前端登录

@Tags			用户
@Summary		前端登录
@Description	前端登录
@Router			/api/login [post]
@Param			object	body		types.LoginParams							false	"前端登录"
@Success		200		{object}	types.Response{result=types.LoginResultVo}	"成功"

func Logout

func Logout(context *gin.Context)

Logout 登出

@Tags			用户
@Summary		登出
@Description	登出
@Router			/api/logout [get]
@Success		200	{object}	types.Response	"成功"

func SendMsg

func SendMsg(context *gin.Context)

SendMsg 前端调用发送信息

@Tags			通用
@Summary		前端调用发送信息
@Description	前端调用发送信息
@Router			/api/sendMsg [post]
@Param			object	body		types.SendMsgParams			false	"发消息参数"
@Success		200		{object}	types.Response{result=int}	"成功"

func UpdateAllPluginStatus

func UpdateAllPluginStatus(context *gin.Context)

UpdateAllPluginStatus 更改某群所有插件状态

@Tags			响应
@Summary		更改某群所有插件状态
@Description	更改某群所有插件状态
@Router			/api/manage/updateAllPluginStatus [post]
@Param			object	body		types.AllPluginStatusParams	false	"修改插件状态入参"
@Success		200		{object}	types.Response				"成功"

func UpdatePluginStatus

func UpdatePluginStatus(context *gin.Context)

UpdatePluginStatus 更改某一个插件状态

@Tags			插件
@Summary		更改某一个插件状态
@Description	更改某一个插件状态
@Router			/api/manage/updatePluginStatus [post]
@Param			object	body		types.PluginStatusParams	false	"修改插件状态入参"
@Success		200		{object}	types.Response				"成功"

func UpdateResponseStatus

func UpdateResponseStatus(context *gin.Context)

UpdateResponseStatus 更改某一个群响应

@Tags			响应
@Summary		更改某一个群响应
@Description	更改某一个群响应
@Router			/api/manage/updateResponseStatus [post]
@Param			object	body		types.ResponseStatusParams	false	"修改群响应入参"
@Success		200		{object}	types.Response				"成功"

func Upgrade

func Upgrade(context *gin.Context)

Upgrade 连接ws，向前端推送message