Class Group

Readonlyfs

all_muted

• get all_muted(): boolean

  是否全员禁言

  Returns boolean

info

• get info(): undefined | GroupInfo

  群资料

  Returns undefined | GroupInfo

is_admin

• get is_admin(): boolean

  我是否是管理

  Returns boolean

is_owner

• get is_owner(): boolean

  我是否是群主

  Returns boolean

mute_left

• get mute_left(): number

  我的禁言剩余时间

  Returns number

name

• get name(): undefined | string

  群名

  Returns undefined | string

addEssence

• addEssence(seq: string | number, rand?: number): Promise<void>

  添加精华消息

  Parameters

  • seq: string | number

    消息序号
  • Optionalrand: number

    消息的随机值

  Returns Promise<void>

announce

• announce(content: string): Promise<void>

  发送简易群公告

  Parameters

  • content: string

  Returns Promise<void>

delReaction

• delReaction(seq: number, eid: string, etype?: number): Promise<void>

  删除表情表态，参考（https://bot.q.qq.com/wiki/develop/api-v2/openapi/emoji/model.html#EmojiType）

  Parameters

  • seq: number

    消息序号
  • eid: string

    表情ID
  • etype: number = 1

  Returns Promise<void>

getAtAllRemainder

• getAtAllRemainder(): Promise<number>

  获取 @全体成员 的剩余次数

  Returns Promise<number>

getAvatarUrl

• getAvatarUrl(size?: 0 | 40 | 100 | 140, history?: number): string

  获取群头像url

  Parameters

  • size: 0 | 40 | 100 | 140 = 0

    头像大小，默认0
  • history: number = 0

    历史头像记录，默认0，若要获取历史群头像则填写1,2,3...

  Returns string

  头像的url地址

getChatHistory

• getChatHistory(
      seq?: number,
      count?: number,
  ): Promise<Message[] | GroupMessage[]>

  获取seq之前的cnt条聊天记录，默认从最后一条发言往前，cnt默认20不能超过20

  Parameters

  • seq: number = 0

    消息序号，默认为0，表示从最后一条发言往前
  • count: number = 20

    聊天记录条数，默认20，超过20按20处理

  Returns Promise<Message[] | GroupMessage[]>

  群聊消息列表，服务器记录不足cnt条则返回能获取到的最多消息记录

getMemberMap

• getMemberMap(
      no_cache?: boolean,
  ): Map<string, MemberInfo> | Promise<Map<string, MemberInfo>>

  获取群员列表

  Parameters

  • Optionalno_cache: boolean

  Returns Map<string, MemberInfo> | Promise<Map<string, MemberInfo>>

getMuteMemberList

• getMuteMemberList(): Promise<{ uin: string; unMuteTime: string }[]>

  获取群内被禁言人

  Returns Promise<{ uin: string; unMuteTime: string }[]>

invite

• invite(uid: string): Promise<void>

  邀请好友入群

  Parameters

  • uid: string

    好友账号

  Returns Promise<void>

kickMember

• kickMember(uid: string, msg?: string, block?: boolean): Promise<void>

  踢出此群，use Member.kick

  Parameters

  • uid: string

    群员账号
  • Optionalmsg: string
  • block: boolean = false

    是否屏蔽群员

  Returns Promise<void>

  Todo

  未知参数

markRead

• markRead(seq?: number): Promise<void>

  标记seq之前的消息为已读

  Parameters

  • seq: number = 0

    消息序号，默认为0，表示标记所有消息

  Returns Promise<void>

muteAll

• muteAll(yes?: boolean): Promise<void>

  全员禁言

  Parameters

  • yes: boolean = true

  Returns Promise<void>

muteMember

• muteMember(uid: string, duration?: number): Promise<void>

  禁言群员，use Member.mute

  Parameters

  • uid: string

    群员账号
  • duration: number = 600

    禁言时长（秒），默认600

  Returns Promise<void>

pickMember

• pickMember(uid: string, strict?: boolean): Member

  获取群员实例

  Parameters

  • uid: string

    群员账号
  • strict: boolean = false

    严格模式，若群员不存在会抛出异常

  Returns Member

pokeMember

• pokeMember(uid: string): Promise<void>

  戳一戳

  Parameters

  • uid: string

    群员账号

  Returns Promise<void>

quit

• quit(): Promise<void>

  退群，若为群主则解散该群

  Returns Promise<void>

removeEssence

• removeEssence(seq: string | number, rand?: number): Promise<void>

  移除精华消息

  Parameters

  • seq: string | number

    消息序号
  • Optionalrand: number

    消息的随机值

  Returns Promise<void>

renew

• renew(): Promise<GroupInfo>

  强制刷新群资料

  Returns Promise<GroupInfo>

sendFile

• sendFile(
      file: string | Buffer<ArrayBufferLike>,
      pid?: string,
      name?: string,
  ): Promise<GfsFileStat | { fid: string }>

  发送一个文件

  Parameters

  • file: string | Buffer<ArrayBufferLike>

    string表示从该本地文件路径上传，Buffer表示直接上传这段内容
  • Optionalpid: string

    上传的目标目录id，默认根目录
  • Optionalname: string

    上传的文件名，file为Buffer时，若留空则自动以md5命名

  Returns Promise<GfsFileStat | { fid: string }>

setAdmin

• setAdmin(uid: string, yes?: boolean): Promise<void>

  设置管理员，use Member.setAdmin

  Parameters

  • uid: string

    群员账号
  • yes: boolean = true

    是否设为管理员

  Returns Promise<void>

setCard

• setCard(uid: string, card?: string): Promise<void>

  设置名片，use Member.setCard

  Parameters

  • uid: string

    群员账号
  • card: string = ""

    名片

  Returns Promise<void>

setGroupJoinType

• setGroupJoinType(
      type: string,
      question?: string,
      answer?: string,
  ): Promise<void>

  设置加群方式

  Parameters

  • type: string

    加群方式的类型。可选值包括：

    • "AnyOne"：允许任何人加群
    • "None"：不允许任何人加群
    • "requireAuth"：需要身份验证
    • "QAjoin"：需要回答问题并由管理员审核
    • "Correct"：正确回答问题
  • Optionalquestion: string

    在 type 为 "QAjoin" 或 "Correct" 时需要传入。问题的内容。
  • Optionalanswer: string

    在 type 为 "Correct" 时需要传入。正确回答的问题答案。

  Returns Promise<void>

setMessageRateLimit

• setMessageRateLimit(times: number): Promise<void>

  设置发言限频

  Parameters

  • times: number

    每分钟发言次数

    • 10: 每分钟十条
    • 5: 每分钟五条
    • 0: 无限制

  Returns Promise<void>

setReaction

• setReaction(seq: string | number, eid: string, etype?: number): Promise<void>

  添加表情表态，参考（https://bot.q.qq.com/wiki/develop/api-v2/openapi/emoji/model.html#EmojiType）

  Parameters

  • seq: string | number

    消息序号
  • eid: string

    表情ID
  • etype: number = 1

    表情类型 EmojiType

  Returns Promise<void>

setRemark

• setRemark(remark?: string): Promise<void>

  设置群备注

  Parameters

  • remark: string = ""

  Returns Promise<void>

setScreenMemberMsg

• setScreenMemberMsg(member_id: string, isScreen?: boolean): Promise<void>

  设置当前群成员消息屏蔽状态

  Parameters

  • member_id: string
  • OptionalisScreen: boolean

  Returns Promise<void>

setTitle

• setTitle(uid: string, title?: string, duration?: number): Promise<void>

  设置头衔，use Member.setTitle

  Parameters

  • uid: string

    群员账号
  • title: string = ""

    头衔名
  • duration: number = -1

    持续时间，默认-1，表示永久

  Returns Promise<void>

sign

• sign(): Promise<void>

  打卡

  Returns Promise<void>

Staticas

• as(this: Client, gid: string, strict?: boolean): Group

  Parameters

  • this: Client
  • gid: string
  • strict: boolean = false

  Returns Group