CoolQ (spring-cq 4.14.0 API)

java.lang.Object
- net.lz1998.cq.robot.CoolQ

```
public class CoolQ
extends Object
```

构造器概要

构造器
构造器和说明
`CoolQ(long selfId, org.springframework.web.socket.WebSocketSession botSession, net.lz1998.cq.robot.EventHandler eventHandler, List<CQPlugin> pluginList)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`ApiData<BooleanData>`	`canSendImage()` 检查是否可以发送图片
`ApiData<BooleanData>`	`canSendRecord()` 检查是否可以发送语音
`ApiRawData`	`cleanDataDir(String data_dir)` 清理数据目录
`ApiRawData`	`cleanPluginLog()` 清理插件日志
`ApiRawData`	`deleteMsg(int message_id)` 撤回消息
`ApiData<CookiesData>`	`getCookies(String domain)` 获取 Cookies
`ApiData<CredentialsData>`	`getCredentials(String domain)` 获取 QQ 相关接口凭证即上面两个接口的合并
`ApiData<CsrfTokenData>`	`getCsrfToken()` 获取 CSRF Token
`ApiListData<FriendData>`	`getFriendList()` 获取好友列表
`ApiData<GroupInfoData>`	`getGroupInfo(long group_id, boolean no_cache)` 获取群信息
`ApiListData<GroupData>`	`getGroupList()` 获取群列表
`ApiData<GroupMemberInfoData>`	`getGroupMemberInfo(long group_id, long user_id, boolean no_cache)` 获取群成员信息
`ApiListData<GroupMemberInfoData>`	`getGroupMemberList(long group_id)` 获取群成员列表响应内容为 JSON 数组，每个元素的内容和上面的 /get_group_member_info 接口相同，但对于同一个群组的同一个成员，获取列表时和获取单独的成员信息时，某些字段可能有所不同，例如 area、title 等字段在获取列表时无法获得，具体应以单独的成员信息为准。
`ApiData<FileData>`	`getImage(String file)` 获取图片
`ApiData<LoginInfoData>`	`getLoginInfo()` 获取登录号信息
`ApiData<FileData>`	`getRecord(String file, String out_format, boolean full_path)` 获取语音
`ApiData<CQStatus>`	`getStatus()` 获取插件运行状态
`ApiData<StrangerInfoData>`	`getStrangerInfo(long user_id, boolean no_cache)` 获取陌生人信息
`ApiData<VersionInfoData>`	`getVersionInfo()` 获取酷Q 及 HTTP API 插件的版本信息参数
`void`	`onReceiveApiMessage(com.alibaba.fastjson.JSONObject message)`
`void`	`onReceiveEventMessage(com.alibaba.fastjson.JSONObject message)`
`ApiData<MessageData>`	`sendDiscussMsg(long discuss_id, String message, boolean auto_escape)` 发送讨论组消息
`ApiData<MessageData>`	`sendGroupMsg(long group_id, String message, boolean auto_escape)` 发送群消息
`ApiRawData`	`sendLike(long user_id, Integer times)` 发送好友赞
`ApiData<MessageData>`	`sendPrivateMsg(long user_id, String message, boolean auto_escape)` 发送私聊消息
`ApiRawData`	`setDiscussLeave(long discuss_id)` 退出讨论组
`ApiRawData`	`setFriendAddRequest(String flag, boolean approve, String remark)` 处理加好友请求
`ApiRawData`	`setGroupAddRequest(String flag, String sub_type, boolean approve, String reason)` 处理加群请求／邀请
`ApiRawData`	`setGroupAdmin(long group_id, long user_id, boolean enable)` 群组设置管理员
`ApiRawData`	`setGroupAnonymous(long group_id, boolean enable)` 群组匿名
`ApiRawData`	`setGroupAnonymousBan(long group_id, CQGroupAnonymous cqGroupAnonymous, boolean duration)` 群组匿名用户禁言
`ApiRawData`	`setGroupAnonymousBan(long group_id, String flag, boolean duration)` 群组匿名用户禁言
`ApiRawData`	`setGroupBan(long group_id, long user_id, long duration)` 群组单人禁言
`ApiRawData`	`setGroupCard(long group_id, long user_id, String card)` 设置群名片（群备注）
`ApiRawData`	`setGroupKick(long group_id, long user_id, boolean reject_add_request)` 群组踢人
`ApiRawData`	`setGroupLeave(long group_id, boolean is_dismiss)`
`ApiRawData`	`setGroupSpecialTitle(long group_id, long user_id, String special_title, boolean duration)` 设置群组专属头衔
`ApiRawData`	`setGroupWholeBan(long group_id, boolean enable)` 群组全员禁言
`ApiRawData`	`setRestartPlugin(int delay)` 重启 HTTP API 插件

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - CoolQ
```
public CoolQ(long selfId,
             org.springframework.web.socket.WebSocketSession botSession,
             net.lz1998.cq.robot.EventHandler eventHandler,
             List<CQPlugin> pluginList)
```
- 方法详细资料
  - onReceiveApiMessage
```
public void onReceiveApiMessage(com.alibaba.fastjson.JSONObject message)
```
  - onReceiveEventMessage
```
public void onReceiveEventMessage(com.alibaba.fastjson.JSONObject message)
```
  - sendPrivateMsg
```
public ApiData<MessageData> sendPrivateMsg(long user_id,
                                           String message,
                                           boolean auto_escape)
```
    发送私聊消息
    
    参数:
    
    user_id - 对方 QQ 号
    
    message - 要发送的内容
    
    auto_escape - 消息内容是否作为纯文本发送（即不解析 CQ 码），只在 message 字段是字符串时有效
    
    返回:
  - sendGroupMsg
```
public ApiData<MessageData> sendGroupMsg(long group_id,
                                         String message,
                                         boolean auto_escape)
```
    发送群消息
    
    参数:
    
    group_id - 群号
    
    message - 要发送的内容
    
    auto_escape - 消息内容是否作为纯文本发送（即不解析 CQ 码），只在 message 字段是字符串时有效
    
    返回:
  - sendDiscussMsg
```
public ApiData<MessageData> sendDiscussMsg(long discuss_id,
                                           String message,
                                           boolean auto_escape)
```
    发送讨论组消息
    
    参数:
    
    discuss_id - 讨论组 ID（正常情况下看不到，需要从讨论组消息上报的数据中获得）
    
    message - 要发送的内容
    
    auto_escape - 消息内容是否作为纯文本发送（即不解析 CQ 码），只在 message 字段是字符串时有效
    
    返回:
  - deleteMsg
```
public ApiRawData deleteMsg(int message_id)
```
    撤回消息
    
    参数:
    
    message_id - 消息 ID
    
    返回:
  - sendLike
```
public ApiRawData sendLike(long user_id,
                           Integer times)
```
    发送好友赞
    
    参数:
    
    user_id - 对方 QQ 号
    
    times - 赞的次数，每个好友每天最多 10 次
    
    返回:
  - setGroupKick
```
public ApiRawData setGroupKick(long group_id,
                               long user_id,
                               boolean reject_add_request)
```
    群组踢人
    
    参数:
    
    group_id - 群号
    
    user_id - 要踢的 QQ 号
    
    reject_add_request - 拒绝此人的加群请求
    
    返回:
  - setGroupBan
```
public ApiRawData setGroupBan(long group_id,
                              long user_id,
                              long duration)
```
    群组单人禁言
    
    参数:
    
    group_id - 群号
    
    user_id - 要禁言的 QQ 号
    
    duration - 禁言时长，单位秒，0 表示取消禁言
    
    返回:
  - setGroupAnonymousBan
```
public ApiRawData setGroupAnonymousBan(long group_id,
                                       CQGroupAnonymous cqGroupAnonymous,
                                       boolean duration)
```
    群组匿名用户禁言
    
    参数:
    
    group_id - 群号
    
    cqGroupAnonymous - 要禁言的匿名用户对象（群消息上报的 anonymous 字段）
    
    duration - 禁言时长，单位秒，无法取消匿名用户禁言
    
    返回:
  - setGroupAnonymousBan
```
public ApiRawData setGroupAnonymousBan(long group_id,
                                       String flag,
                                       boolean duration)
```
    群组匿名用户禁言
    
    参数:
    
    group_id - 群号
    
    flag - 要禁言的匿名用户的 flag（需从群消息上报的数据中获得）
    
    duration - 禁言时长，单位秒，无法取消匿名用户禁言
    
    返回:
  - setGroupWholeBan
```
public ApiRawData setGroupWholeBan(long group_id,
                                   boolean enable)
```
    群组全员禁言
    
    参数:
    
    group_id - 群号
    
    enable - 是否禁言
    
    返回:
  - setGroupAdmin
```
public ApiRawData setGroupAdmin(long group_id,
                                long user_id,
                                boolean enable)
```
    群组设置管理员
    
    参数:
    
    group_id - 群号
    
    user_id - 要设置管理员的 QQ 号
    
    enable - true 为设置，false 为取消
    
    返回:
  - setGroupAnonymous
```
public ApiRawData setGroupAnonymous(long group_id,
                                    boolean enable)
```
    群组匿名
    
    参数:
    
    group_id - 群号
    
    enable - 是否允许匿名聊天
    
    返回:
  - setGroupCard
```
public ApiRawData setGroupCard(long group_id,
                               long user_id,
                               String card)
```
    设置群名片（群备注）
    
    参数:
    
    group_id - 群号
    
    user_id - 要设置的 QQ 号
    
    card - 群名片内容，不填或空字符串表示删除群名片
    
    返回:
  - setGroupLeave
```
public ApiRawData setGroupLeave(long group_id,
                                boolean is_dismiss)
```
    参数:
    
    group_id - 群号
    
    is_dismiss - 是否解散，如果登录号是群主，则仅在此项为 true 时能够解散
    
    返回:
  - setGroupSpecialTitle
```
public ApiRawData setGroupSpecialTitle(long group_id,
                                       long user_id,
                                       String special_title,
                                       boolean duration)
```
    设置群组专属头衔
    
    参数:
    
    group_id - 群号
    
    user_id - 要设置的 QQ 号
    
    special_title - 专属头衔，不填或空字符串表示删除专属头衔
    
    duration - 专属头衔有效期，单位秒，-1 表示永久，不过此项似乎没有效果，可能是只有某些特殊的时间长度有效，有待测试
    
    返回:
  - setDiscussLeave
```
public ApiRawData setDiscussLeave(long discuss_id)
```
    退出讨论组
    
    参数:
    
    discuss_id - 讨论组 ID（正常情况下看不到，需要从讨论组消息上报的数据中获得）
    
    返回:
  - setFriendAddRequest
```
public ApiRawData setFriendAddRequest(String flag,
                                      boolean approve,
                                      String remark)
```
    处理加好友请求
    
    参数:
    
    flag - 加好友请求的 flag（需从上报的数据中获得）
    
    approve - 是否同意请求
    
    remark - 添加后的好友备注（仅在同意时有效）
    
    返回:
  - setGroupAddRequest
```
public ApiRawData setGroupAddRequest(String flag,
                                     String sub_type,
                                     boolean approve,
                                     String reason)
```
    处理加群请求／邀请
    
    参数:
    
    flag - 加群请求的 flag（需从上报的数据中获得）
    
    sub_type - add 或 invite，请求类型（需要和上报消息中的 sub_type 字段相符）
    
    approve - 是否同意请求／邀请
    
    reason - 拒绝理由（仅在拒绝时有效）
    
    返回:
  - getLoginInfo
```
public ApiData<LoginInfoData> getLoginInfo()
```
    获取登录号信息
    
    返回:
  - getStrangerInfo
```
public ApiData<StrangerInfoData> getStrangerInfo(long user_id,
                                                 boolean no_cache)
```
    获取陌生人信息
    
    参数:
    
    user_id - QQ 号
    
    no_cache - 是否不使用缓存（使用缓存可能更新不及时，但响应更快）
    
    返回:
  - getFriendList
```
public ApiListData<FriendData> getFriendList()
```
    获取好友列表
    
    返回:
  - getGroupList
```
public ApiListData<GroupData> getGroupList()
```
    获取群列表
    
    返回:
  - getGroupInfo
```
public ApiData<GroupInfoData> getGroupInfo(long group_id,
                                           boolean no_cache)
```
    获取群信息
    
    参数:
    
    group_id - 群号
    
    no_cache - 是否不使用缓存（使用缓存可能更新不及时，但响应更快）
    
    返回:
  - getGroupMemberInfo
```
public ApiData<GroupMemberInfoData> getGroupMemberInfo(long group_id,
                                                       long user_id,
                                                       boolean no_cache)
```
    获取群成员信息
    
    参数:
    
    group_id - 群号
    
    user_id - QQ 号
    
    no_cache - 是否不使用缓存（使用缓存可能更新不及时，但响应更快）
    
    返回:
  - getGroupMemberList
```
public ApiListData<GroupMemberInfoData> getGroupMemberList(long group_id)
```
    获取群成员列表
    响应内容为 JSON 数组，每个元素的内容和上面的 /get_group_member_info 接口相同，但对于同一个群组的同一个成员，获取列表时和获取单独的成员信息时，某些字段可能有所不同，例如 area、title 等字段在获取列表时无法获得，具体应以单独的成员信息为准。
    
    参数:
    
    group_id - 群号
    
    返回:
  - getCookies
```
public ApiData<CookiesData> getCookies(String domain)
```
    获取 Cookies
    
    参数:
    
    domain - 需要获取 cookies 的域名
    
    返回:
  - getCsrfToken
```
public ApiData<CsrfTokenData> getCsrfToken()
```
    获取 CSRF Token
    
    返回:
  - getCredentials
```
public ApiData<CredentialsData> getCredentials(String domain)
```
    获取 QQ 相关接口凭证即上面两个接口的合并
    
    参数:
    
    domain - 需要获取 cookies 的域名
    
    返回:
  - getRecord
```
public ApiData<FileData> getRecord(String file,
                                   String out_format,
                                   boolean full_path)
```
    获取语音
    
    参数:
    
    file - 收到的语音文件名（CQ 码的 file 参数），如 0B38145AA44505000B38145AA4450500.silk
    
    out_format - 要转换到的格式，目前支持 mp3、amr、wma、m4a、spx、ogg、wav、flac
    
    full_path - 是否返回文件的绝对路径（Windows 环境下建议使用，Docker 中不建议）
    
    返回:
  - getImage
```
public ApiData<FileData> getImage(String file)
```
    获取图片
    
    参数:
    
    file - 收到的图片文件名（CQ 码的 file 参数），如 6B4DE3DFD1BD271E3297859D41C530F5.jpg
    
    返回:
  - canSendImage
```
public ApiData<BooleanData> canSendImage()
```
    检查是否可以发送图片
    
    返回:
  - canSendRecord
```
public ApiData<BooleanData> canSendRecord()
```
    检查是否可以发送语音
    
    返回:
  - getStatus
```
public ApiData<CQStatus> getStatus()
```
    获取插件运行状态
    
    返回:
  - getVersionInfo
```
public ApiData<VersionInfoData> getVersionInfo()
```
    获取酷Q 及 HTTP API 插件的版本信息参数
    
    返回:
  - setRestartPlugin
```
public ApiRawData setRestartPlugin(int delay)
```
    重启 HTTP API 插件
    
    参数:
    
    delay - 要延迟的毫秒数，如果默认情况下无法重启，可以尝试设置延迟为 2000 左右
    
    返回:
  - cleanDataDir
```
public ApiRawData cleanDataDir(String data_dir)
```
    清理数据目录
    
    参数:
    
    data_dir - 收到清理的目录名，支持 image、record、show、bface
    
    返回:
  - cleanPluginLog
```
public ApiRawData cleanPluginLog()
```
    清理插件日志
    
    返回:

类 CoolQ

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

CoolQ

方法详细资料

onReceiveApiMessage

onReceiveEventMessage

sendPrivateMsg

sendGroupMsg

sendDiscussMsg

deleteMsg

sendLike

setGroupKick

setGroupBan

setGroupAnonymousBan

setGroupAnonymousBan

setGroupWholeBan

setGroupAdmin

setGroupAnonymous

setGroupCard

setGroupLeave

setGroupSpecialTitle

setDiscussLeave

setFriendAddRequest

setGroupAddRequest

getLoginInfo

getStrangerInfo

getFriendList

getGroupList

getGroupInfo

getGroupMemberInfo

getGroupMemberList

getCookies

getCsrfToken

getCredentials

getRecord

getImage

canSendImage

canSendRecord

getStatus

getVersionInfo

setRestartPlugin

cleanDataDir

cleanPluginLog