cqhttp_go_sdk

package module
v0.0.0-...-05adfb3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 21, 2022 License: GPL-3.0 Imports: 4 Imported by: 1

README

cqhttp-go-sdk

酷q已经停止更新

本项目为酷 Q 的 CoolQ HTTP API 插件的 Golang SDK,封装了 web server 相关的代码,让 Gopher 能方便地开发插件。仅支持插件 3.0.0 或更新版本。

关于 CoolQ HTTP API 插件,见 richardchien/coolq-http-api。

获取

go get -u github.com/juzi5201314/cqhttp-go-sdk

使用

import "github.com/juzi5201314/cqhttp-go-sdk"

...
    api := cqhttp_go_sdk.Api(url, token)
...

例如给 123456789 发送消息 233

package main

import "github.com/juzi5201314/cqhttp-go-sdk"

func main() {
	api := cqhttp_go_sdk.Api("http://localhost:5700", "xxxx")
	m, err := api.SendPrivateMsg(123456789, "233", false)
	if err != nil {
		panic(err)
	}
	...
}

所有方法名字与 http 插件 API 文档中的一样,格式改为驼峰命名。 参数顺序也基本一样(如果不一样,那就是我写错了)。 所有方法返回值都为一个 map,结构与 http 插件响应的 json 相同。

所有方法均有并发版本(函数名字前添加 Concurrent),如:ConcurrentSendPrivateMsg。 此类方法只返回一个 chan,存放着一个 map。error 则为 map["error"]

例如:

	api := cqhttp_go_sdk.Api("http://localhost:5700", "xxxx")
	c := api.ConcurrentSendPrivateMsg(23456789, "msg", false)
	m := <-c
	err := m["error"]
	if err != nil {
		panic(err)
	}

这个有什么用? 假设你代码跟 QQ 机器人不是同一个服务器而延迟 200ms, 意味着加上处理消息的时间,发送到收到响应信息需要 500ms。 那么你同时发送 5 条信息,最后一条甚至要 2 秒之后才会开始发送。 对于一些业务,响应时间长会造成用户体验极差。 而得益于 go 强大的并发能力,如果是并发版本,5 条信息几乎是同时发送的。

CQ码

import "github.com/juzi5201314/cqhttp-go-sdk/cq"

...
    cq.At(123456789) //返回一个字符串 [CQ:at,qq=123456789]
...

更多 CQ 码请参考 酷Q官方CQ码说明 以及 cq-http插件说明

webserver

import "github.com/juzi5201314/cqhttp-go-sdk/server"

...
    s := server.StartListenServer(5700, "/")
    //启动一个http server在5700端口

    s.ListenPrivateMessage(server.PrivateMessageListener(pm))
    //添加一个函数来监听私聊消息

    s.Listen()
    //开始监听,此函数使用之后将会阻塞
...

// 函数参数与 cqhttp 插件文档的顺序一样,如下。
// 返回的 map 为响应数据,如返回 nil 或者空 map 表示不响应
func pm(sub_type string, message_id float64, user_id float64, message string, font float64) map[string]interface{} {
	println("收到消息" + message + ",类型为" + sub_type)
	return map[string]interface{}{
		"reply": "这是一条自动回复消息",
	}
}

/**
  * 更多监听事件函数
  * ListenGroupMessage
  * ListenDiscussMessage
  * ListenGroupUpload
  * ListenGroupAdmin
  * ListenGroupDecrease
  * ListenGroupIncrease
  * ListenFriendRequest
  * ListenGroupRequest
  */

更多事件请看 cqhttp插件官方文档

Command

command 包可以方便开发者判断用户执行指令

import "github.com/juzi5201314/cqhttp-go-sdk/command"
...
    commmand.Register("cat", commmand.Executant(CatCommand))
...

func CatCommand(cmd string, args []string, ctm command.CommandTriggerMan) {
	ctm.Reply(args[1])
}
/**
  * 对机器人私聊或者机器人存在的群聊里发送
  * cat 2333
  * 机器人就会发送2333
  */

Register 方法第一个参数为命令名字,第二个为触发命令之后处理的执行的函数

CatCommand: 第一个参数 cmd 为命令名字(cat),第二个为命令之后参数(以空格分隔),第三个 CommandTriggerMan 储存了发送命令的的用户信息。

CommandTriggerMan:

func GetOrigin() int
来源,目前有 3 种,分别是 command.GROUP,command.PRIVATE,command.DISCUSS,分别为来自群组,私聊,讨论组

func GetOriginId() float64
如果是来自群组与讨论组,此项为群号与讨论组号。如果来自私聊,此项则为对方 QQ 号。

func GetId() float64
触发命令的 QQ 号

func GetMessageId() float64
返回信息 id,用于在需要时撤回消息

func Reply(string, Api)
用与快速回复对方

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type API

type API struct {
	// contains filtered or unexported fields
}

func Api

func Api(url string, token string) API

func (*API) CleanDataDir

func (api *API) CleanDataDir(data_dir string) (map[string]interface{}, error)

func (*API) ConcurrentCleanDataDir

func (api *API) ConcurrentCleanDataDir(data_dir string) chan map[string]interface{}

func (*API) ConcurrentDeleteMsg

func (api *API) ConcurrentDeleteMsg(message_id float64) chan map[string]interface{}

func (*API) ConcurrentGetCookies

func (api *API) ConcurrentGetCookies() chan map[string]interface{}

func (*API) ConcurrentGetCsrfToken

func (api *API) ConcurrentGetCsrfToken() chan map[string]interface{}

func (*API) ConcurrentGetFriendList

func (api *API) ConcurrentGetFriendList() chan map[string]interface{}

func (*API) ConcurrentGetGroupList

func (api *API) ConcurrentGetGroupList() chan map[string]interface{}

func (*API) ConcurrentGetGroupMemberInfo

func (api *API) ConcurrentGetGroupMemberInfo(group_id float64, user_id float64, no_cache bool) chan map[string]interface{}

func (*API) ConcurrentGetGroupMemberList

func (api *API) ConcurrentGetGroupMemberList(group_id float64) chan map[string]interface{}

func (*API) ConcurrentGetLoginInfo

func (api *API) ConcurrentGetLoginInfo() chan map[string]interface{}

func (*API) ConcurrentGetRecord

func (api *API) ConcurrentGetRecord(file string, out_format string) chan map[string]interface{}

func (*API) ConcurrentGetStatus

func (api *API) ConcurrentGetStatus() chan map[string]interface{}

func (*API) ConcurrentGetStrangerInfo

func (api *API) ConcurrentGetStrangerInfo(user_id float64, no_cache bool) chan map[string]interface{}

func (*API) ConcurrentGetVersionInfo

func (api *API) ConcurrentGetVersionInfo() chan map[string]interface{}

func (*API) ConcurrentSendDiscussMsg

func (api *API) ConcurrentSendDiscussMsg(discuss_id float64, message string, auto_escape bool) chan map[string]interface{}

func (*API) ConcurrentSendGroupMsg

func (api *API) ConcurrentSendGroupMsg(group_id float64, message string, auto_escape bool) chan map[string]interface{}

func (*API) ConcurrentSendLike

func (api *API) ConcurrentSendLike(user_id float64, times int) chan map[string]interface{}

func (*API) ConcurrentSendPrivateMsg

func (api *API) ConcurrentSendPrivateMsg(user_id float64, message string, auto_escape bool) chan map[string]interface{}

func (*API) ConcurrentSetDiscussLeave

func (api *API) ConcurrentSetDiscussLeave(discuss_id float64) chan map[string]interface{}

func (*API) ConcurrentSetFriendAddRequest

func (api *API) ConcurrentSetFriendAddRequest(flag string, approve bool, remark string) chan map[string]interface{}

func (*API) ConcurrentSetGroupAddRequest

func (api *API) ConcurrentSetGroupAddRequest(flag string, _type string, approve bool, reason string) chan map[string]interface{}

func (*API) ConcurrentSetGroupAdmin

func (api *API) ConcurrentSetGroupAdmin(group_id float64, user_id float64, enable bool) chan map[string]interface{}

func (*API) ConcurrentSetGroupAnonymous

func (api *API) ConcurrentSetGroupAnonymous(group_id float64, enable bool) chan map[string]interface{}

func (*API) ConcurrentSetGroupAnonymousBan

func (api *API) ConcurrentSetGroupAnonymousBan(group_id float64, flag string, duration int) chan map[string]interface{}

func (*API) ConcurrentSetGroupBan

func (api *API) ConcurrentSetGroupBan(group_id float64, user_id float64, duration int) chan map[string]interface{}

func (*API) ConcurrentSetGroupCard

func (api *API) ConcurrentSetGroupCard(group_id float64, user_id float64, card string) chan map[string]interface{}

func (*API) ConcurrentSetGroupKick

func (api *API) ConcurrentSetGroupKick(group_id float64, user_id float64, reject_add_request bool) chan map[string]interface{}

func (*API) ConcurrentSetGroupLeave

func (api *API) ConcurrentSetGroupLeave(group_id float64, is_dismiss bool) chan map[string]interface{}

func (*API) ConcurrentSetGroupSpecialTitle

func (api *API) ConcurrentSetGroupSpecialTitle(group_id float64, user_id float64, special_title string) chan map[string]interface{}

func (*API) ConcurrentSetGroupWholeBan

func (api *API) ConcurrentSetGroupWholeBan(group_id float64, enable bool) chan map[string]interface{}

func (*API) ConcurrentSetRestartPlugin

func (api *API) ConcurrentSetRestartPlugin() chan map[string]interface{}

func (*API) DeleteMsg

func (api *API) DeleteMsg(message_id float64) (map[string]interface{}, error)

func (*API) GetCookies

func (api *API) GetCookies() (map[string]interface{}, error)

func (*API) GetCsrfToken

func (api *API) GetCsrfToken() (map[string]interface{}, error)

func (*API) GetFriendList

func (api *API) GetFriendList() (map[string]interface{}, error)

试验性接口

func (*API) GetGroupList

func (api *API) GetGroupList() (map[string]interface{}, error)

func (*API) GetGroupMemberInfo

func (api *API) GetGroupMemberInfo(group_id float64, user_id float64, no_cache bool) (map[string]interface{}, error)

func (*API) GetGroupMemberList

func (api *API) GetGroupMemberList(group_id float64) (map[string]interface{}, error)

func (*API) GetLoginInfo

func (api *API) GetLoginInfo() (map[string]interface{}, error)

func (*API) GetRecord

func (api *API) GetRecord(file string, out_format string) (map[string]interface{}, error)

func (*API) GetStatus

func (api *API) GetStatus() (map[string]interface{}, error)

func (*API) GetStrangerInfo

func (api *API) GetStrangerInfo(user_id int, no_cache bool) (map[string]interface{}, error)

func (*API) GetVersionInfo

func (api *API) GetVersionInfo() (map[string]interface{}, error)

func (*API) SendDiscussMsg

func (api *API) SendDiscussMsg(discuss_id float64, message string, auto_escape bool) (map[string]interface{}, error)

func (*API) SendGroupMsg

func (api *API) SendGroupMsg(group_id float64, message string, auto_escape bool) (map[string]interface{}, error)

func (*API) SendLike

func (api *API) SendLike(user_id float64, times int) (map[string]interface{}, error)

func (*API) SendPrivateMsg

func (api *API) SendPrivateMsg(user_id float64, message string, auto_escape bool) (map[string]interface{}, error)

func (*API) SetDiscussLeave

func (api *API) SetDiscussLeave(discuss_id float64) (map[string]interface{}, error)

func (*API) SetFriendAddRequest

func (api *API) SetFriendAddRequest(flag string, approve bool, remark string) (map[string]interface{}, error)

func (*API) SetGroupAddRequest

func (api *API) SetGroupAddRequest(flag string, _type string, approve bool, reason string) (map[string]interface{}, error)

func (*API) SetGroupAdmin

func (api *API) SetGroupAdmin(group_id float64, user_id float64, enable bool) (map[string]interface{}, error)

func (*API) SetGroupAnonymous

func (api *API) SetGroupAnonymous(group_id float64, enable bool) (map[string]interface{}, error)

func (*API) SetGroupAnonymousBan

func (api *API) SetGroupAnonymousBan(group_id float64, flag string, duration int) (map[string]interface{}, error)

func (*API) SetGroupBan

func (api *API) SetGroupBan(group_id float64, user_id float64, duration int) (map[string]interface{}, error)

func (*API) SetGroupCard

func (api *API) SetGroupCard(group_id float64, user_id float64, card string) (map[string]interface{}, error)

func (*API) SetGroupKick

func (api *API) SetGroupKick(group_id float64, user_id float64, reject_add_request bool) (map[string]interface{}, error)

func (*API) SetGroupLeave

func (api *API) SetGroupLeave(group_id float64, is_dismiss bool) (map[string]interface{}, error)

func (*API) SetGroupSpecialTitle

func (api *API) SetGroupSpecialTitle(group_id float64, user_id float64, special_title string) (map[string]interface{}, error)

func (*API) SetGroupWholeBan

func (api *API) SetGroupWholeBan(group_id float64, enable bool) (map[string]interface{}, error)

func (*API) SetRestartPlugin

func (api *API) SetRestartPlugin() (map[string]interface{}, error)

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL