跳到主要内容
版本：1.x

消息收发

发送群聊消息​

serein.sendGroup(target: number, msg: string)

  • 参数
    • target 群号
    • msg 消息内容
  • 返回
    • boolean
      • 成功为true，否则为false
警告

此值仅代表此消息是否成功由 WebSocket 发出，并不代表消息能够成功发送至聊天，以下同理

发送私聊消息​

serein.sendPrivate(target: number, msg: string)

  • 参数
    • target 对方 QQ 号
    • msg 消息内容
  • 返回
    • boolean
      • 成功为true，否则为false

发送临时会话消息​

serein.sendTemp(group_id: number, user_id: number, msg: string)

  • 参数
    • group_id 群号
    • user_id 对方 QQ 号
    • msg 消息内容
  • 返回
    • boolean
      • 成功为true，否则为false

发送数据包​

serein.sendPacket(packet: string)

serein.sendPacket(JSON.stringify({
    action: "send_private_msg",
    params: {
        user_id: 10001,
        message: "你好"
    }
}));
  • 参数
    • packet 发送的数据包
  • 返回
    • boolean
      • 成功为true，否则为false
提示

你可以通过此函数实现发送消息、同意好友请求、上传文件等功能

获取 ws 连接状态​

serein.getWsStatus()

  • 参数
    • 无
  • 返回
    • boolean
      • 已连接为true，否则为false

获取群成员昵称缓存字典​

serein.getGroupCache()

  • 参数
    • 无
  • 返回
    • object<string, object<string, UserInfo>> 群成员昵称缓存字典
      • 第一个key为群号
      • 第二个key为 QQ 号
const dict = serein.getGroupCache();
const info = dict["114514"]["1919810"];
备注

此处的key必须为字符串形式的群号或 QQ 号，直接使用number类型作为key获取将导致 Serein 引发超出内存的异常

直接获取指定群的群成员信息​

serein.getUserInfo(groupid: number, userid: number)

const info = serein.getUserInfo(114514, 1919810); // 与上面的函数示例等价
  • 参数
    • groupid 群号
    • userid QQ 号
  • 返回
    • UserInfo | undefined
declare interface UserInfo {
    id: number
    card: string
    nickname: string
    role: number
    gameId: string
}

获取自身 ID（使用 Serein 缓存）​

serein.getSelfID()

  • 参数
    • 无
  • 返回
    • number?
      • 当未连接 WS 时或缓存为空时返回 null

获取统计信息（使用 Serein 缓存）​

serein.getWsStat()

  • 参数
    • 无
  • 返回
    • number?[]
      • 其中[0]为发送消息数，[1]为接收消息数
      • 当未连接 WS 时或缓存为空时返回[null, null]