Package com.mikuac.shiro.action

Interface GoCQHTTPExtend

All Known Implementing Classes:
Bot
public interface GoCQHTTPExtend

  • Method Details

    • getGuildMemberList

      ActionData<GuildMemberListResp> getGuildMemberList(String guildId, String nextToken)
      获取频道成员列表 由于频道人数较多(数万), 请尽量不要全量拉取成员列表, 这将会导致严重的性能问题 尽量使用 getGuildMemberProfile 接口代替全量拉取 nextToken 为空的情况下, 将返回第一页的数据, 并在返回值附带下一页的 token
      Parameters:
      guildId - 频道ID
      nextToken - 翻页Token
      Returns:
      result ActionData of GuildMemberListResp

    • sendGuildMsg

      ActionData<GuildMsgId> sendGuildMsg(String guildId, String channelId, String msg)
      发送信息到子频道
      Parameters:
      guildId - 频道 ID
      channelId - 子频道 ID
      msg - 要发送的内容
      Returns:
      result ActionData of GuildMsgId

    • getGuildMsg

      ActionData<GetGuildMsgResp> getGuildMsg(String guildMsgId, boolean noCache)
      获取频道消息
      Parameters:
      guildMsgId - 频道 ID
      noCache - 是否使用缓存
      Returns:
      result ActionData of GetGuildMsgResp

    • getGuildServiceProfile

      ActionData<GuildServiceProfileResp> getGuildServiceProfile()
      获取频道系统内 BOT 的资料
      Returns:
      result ActionData of GuildServiceProfileResp

    • getGuildList

      ActionList<GuildListResp> getGuildList()
      获取频道列表
      Returns:
      result ActionList of GuildListResp

    • getGuildMetaByGuest

      ActionData<GuildMetaByGuestResp> getGuildMetaByGuest(String guildId)
      通过访客获取频道元数据
      Parameters:
      guildId - 频道 ID
      Returns:
      result ActionData of GuildMetaByGuestResp

    • getGuildChannelList

      ActionList<ChannelInfoResp> getGuildChannelList(String guildId, boolean noCache)
      获取子频道列表
      Parameters:
      guildId - 频道 ID
      noCache - 是否无视缓存
      Returns:
      result ActionList of ChannelInfoResp

    • getGuildMemberProfile

      ActionData<GuildMemberProfileResp> getGuildMemberProfile(String guildId, String userId)
      单独获取频道成员信息
      Parameters:
      guildId - 频道ID
      userId - 用户ID
      Returns:
      result ActionData of GuildMemberProfileResp

    • setGroupSpecialTitle

      ActionRaw setGroupSpecialTitle(long groupId, long userId, String specialTitle, int duration)
      设置群组专属头衔
      Parameters:
      groupId - 群号
      userId - 要设置的 QQ 号
      specialTitle - 专属头衔，不填或空字符串表示删除专属头衔
      duration - 专属头衔有效期，单位秒，-1 表示永久，不过此项似乎没有效果，可能是只有某些特殊的时间长度有效，有待测试
      Returns:
      result ActionRaw

    • deleteFriend

      ActionRaw deleteFriend(long friendId)
      删除好友
      Parameters:
      friendId - 好友 QQ 号
      Returns:
      result ActionRaw

    • setGroupPortrait

      ActionRaw setGroupPortrait(long groupId, String file, int cache)
      设置群头像 目前这个API在登录一段时间后因cookie失效而失效, 请考虑后使用
      Parameters:
      groupId - 群号
      file - 图片文件名（支持绝对路径，网络URL，Base64编码）
      cache - 表示是否使用已缓存的文件 （通过网络URL发送时有效, 1表示使用缓存, 0关闭关闭缓存, 默认为1）
      Returns:
      result ActionRaw

    • checkUrlSafely

      ActionData<CheckUrlSafelyResp> checkUrlSafely(String url)
      检查链接安全性 安全等级, 1: 安全 2: 未知 3: 危险
      Parameters:
      url - 需要检查的链接
      Returns:
      result ActionData of CheckUrlSafelyResp

    • sendGroupNotice

      ActionRaw sendGroupNotice(long groupId, String content)
      发送群公告
      Parameters:
      groupId - 群号
      content - 公告内容
      Returns:
      result ActionRaw

    • getGroupAtAllRemain

      ActionData<GroupAtAllRemainResp> getGroupAtAllRemain(long groupId)
      获取群 @全体成员 剩余次数
      Parameters:
      groupId - 群号
      Returns:
      result ActionData of GroupAtAllRemainResp

    • uploadGroupFile

      ActionRaw uploadGroupFile(long groupId, String file, String name, String folder)
      上传群文件 在不提供 folder 参数的情况下默认上传到根目录 只能上传本地文件, 需要上传 http 文件的话请先下载到本地
      Parameters:
      groupId - 群号
      file - 本地文件路径
      name - 储存名称
      folder - 父目录ID
      Returns:
      result ActionRaw

    • uploadGroupFile

      ActionRaw uploadGroupFile(long groupId, String file, String name)
      上传群文件 在不提供 folder 参数的情况下默认上传到根目录 只能上传本地文件, 需要上传 http 文件的话请先下载到本地
      Parameters:
      groupId - 群号
      file - 本地文件路径
      name - 储存名称
      Returns:
      result ActionRaw

    • downloadFile

      ActionData<DownloadFileResp> downloadFile(String url, int threadCount, String headers)
      调用 go cq http 下载文件
      Parameters:
      url - 链接地址
      threadCount - 下载线程数
      headers - 自定义请求头
      Returns:
      result ActionData of DownloadFileResp

    • downloadFile

      ActionData<DownloadFileResp> downloadFile(String url)
      调用 go cq http 下载文件
      Parameters:
      url - 链接地址
      Returns:
      result ActionData of DownloadFileResp

    • sendGroupForwardMsg

      ActionData<MsgId> sendGroupForwardMsg(long groupId, List<Map<String,Object>> msg)
      发送合并转发 (群)
      Parameters:
      groupId - 群号
      msg - 自定义转发消息 (可使用 ShiroUtils.generateForwardMsg() 方法创建) 参考文档
      Returns:
      result ActionRaw

    • getGroupRootFiles

      ActionData<GroupFilesResp> getGroupRootFiles(long groupId)
      获取群根目录文件列表
      Parameters:
      groupId - 群号
      Returns:
      result ActionData of GroupFilesResp

    • getGroupFilesByFolder

      ActionData<GroupFilesResp> getGroupFilesByFolder(long groupId, String folderId)
      获取群子目录文件列表
      Parameters:
      groupId - 群号
      folderId - 文件夹ID 参考 Folder 对象
      Returns:
      result ActionData of GroupFilesResp

    • getEssenceMsgList

      ActionList<EssenceMsgResp> getEssenceMsgList(long groupId)
      获取精华消息列表
      Parameters:
      groupId - 群号
      Returns:
      result ActionList of EssenceMsgResp

    • setEssenceMsg

      ActionRaw setEssenceMsg(int msgId)
      设置精华消息
      Parameters:
      msgId - 消息 ID
      Returns:
      result ActionRaw

    • deleteEssenceMsg

      ActionRaw deleteEssenceMsg(int msgId)
      移出精华消息
      Parameters:
      msgId - 消息 ID
      Returns:
      result ActionRaw

    • setBotProfile

      ActionRaw setBotProfile(String nickname, String company, String email, String college, String personalNote)
      设置机器人账号资料
      Parameters:
      nickname - 昵称
      company - 公司
      email - 邮箱
      college - 学校
      personalNote - 个性签名
      Returns:
      result ActionRaw

    • sendPrivateForwardMsg

      ActionData<MsgId> sendPrivateForwardMsg(long userId, List<Map<String,Object>> msg)
      发送合并转发 (私聊)
      Parameters:
      userId - 目标用户
      msg - 自定义转发消息 (可使用 ShiroUtils.generateForwardMsg() 方法创建) 参考文档
      Returns:
      result ActionRaw

    • sendForwardMsg

      ActionData<MsgId> sendForwardMsg(AnyMessageEvent event, List<Map<String,Object>> msg)
      发送合并转发
      Parameters:
      event - 事件
      msg - 自定义转发消息 (可使用 ShiroUtils.generateForwardMsg() 方法创建) 参考文档
      Returns:
      result ActionRaw

    • getWordSlices

      ActionData<WordSlicesResp> getWordSlices(String content)
      获取中文分词
      Parameters:
      content - 内容
      Returns:
      result ActionData of WordSlicesResp

    • getOnlineClients

      ActionData<ClientsResp> getOnlineClients(boolean noCache)
      获取当前账号在线客户端列表
      Parameters:
      noCache - 是否无视缓存
      Returns:
      result ActionData of ClientsResp

    • ocrImage

      ActionData<OcrResp> ocrImage(String image)
      图片 OCR
      Parameters:
      image - 图片ID
      Returns:
      result ActionData of OcrResp

    • uploadPrivateFile

      ActionRaw uploadPrivateFile(long userId, String file, String name)
      私聊发送文件
      Parameters:
      userId - 目标用户
      file - 本地文件路径
      name - 文件名
      Returns:
      result ActionRaw

    • sendGroupSign

      ActionRaw sendGroupSign(long groupId)
      群打卡
      Parameters:
      groupId - 群号
      Returns:
      result ActionRaw

    • deleteUnidirectionalFriend

      ActionRaw deleteUnidirectionalFriend(long userId)
      删除单向好友
      Parameters:
      userId - QQ号
      Returns:
      result ActionRaw

    • getUnidirectionalFriendList

      ActionList<UnidirectionalFriendListResp> getUnidirectionalFriendList()
      获取单向好友列表
      Returns:
      result ActionList of UnidirectionalFriendListResp

    • getGroupFileUrl

      ActionData<UrlResp> getGroupFileUrl(long groupId, String fileId, int busId)
      获取群文件资源链接
      Parameters:
      groupId - 群号
      fileId - 文件ID
      busId - 文件类型
      Returns:
      result ActionData of UrlResp

    • createGroupFileFolder

      ActionRaw createGroupFileFolder(long groupId, String folderName)
      创建群文件文件夹
      Parameters:
      groupId - 群号
      folderName - 文件夹名
      Returns:
      result ActionRaw

    • deleteGroupFileFolder

      ActionRaw deleteGroupFileFolder(long groupId, String folderId)
      删除群文件文件夹
      Parameters:
      groupId - 群号
      folderId - 文件夹ID
      Returns:
      result ActionRaw

    • deleteGroupFile

      ActionRaw deleteGroupFile(long groupId, String fileId, int busId)
      删除群文件
      Parameters:
      groupId - 群号
      fileId - 文件ID
      busId - 文件类型
      Returns:
      result ActionRaw

    • getGroupMemberList

      ActionList<GroupMemberInfoResp> getGroupMemberList(long groupId, boolean noCache)
      获取群成员列表
      Parameters:
      groupId - 群号
      noCache - 是否无视缓存
      Returns:
      result ActionList of GroupMemberInfoResp

    • getVersionInfo

      ActionData<VersionInfoResp> getVersionInfo()
      获取版本信息
      Returns:
      result ActionList of VersionInfoResp