Class Group

Readonly fs

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, rand): Promise<string>

• 添加精华消息

  Parameters

  • seq: number

    消息序号

  • rand: number

    消息的随机值

  Returns Promise<string>

allowAnony

• allowAnony(yes?): Promise<boolean>

• 允许/禁止匿名

  Parameters

  • yes: boolean = true

  Returns Promise<boolean>

announce

• announce(content): Promise<boolean>

• 发送简易群公告

  Parameters

  • content: string

  Returns Promise<boolean>

getAnonyInfo

• getAnonyInfo(): Promise<Omit<Anonymous, "flag">>

• 获取自己的匿名情报

  Returns Promise<Omit<Anonymous, "flag">>

getAtAllRemainder

• getAtAllRemainder(): Promise<number>

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

  Returns Promise<number>

getAvatarUrl

• getAvatarUrl(size?, history?): string

• 获取群头像url

  Parameters

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

    头像大小，默认0

  • history: number = 0

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

  Returns string

  头像的url地址

getChatHistory

• getChatHistory(seq?, cnt?): Promise<GroupMessage[]>

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

  Parameters

  • seq: number = 0

    消息序号，默认为0，表示从最后一条发言往前

  • cnt: number = 20

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

  Returns Promise<GroupMessage[]>

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

getFileUrl

• getFileUrl(fid): Promise<string>

• 获取群文件下载地址

  Parameters

  • fid: string

    文件id

  Returns Promise<string>

getMemberMap

• getMemberMap(no_cache?): Promise<Map<number, MemberInfo>>

• 获取群员列表

  Parameters

  • no_cache: boolean = false

  Returns Promise<Map<number, MemberInfo>>

invite

• invite(uid): Promise<boolean>

• 邀请好友入群

  Parameters

  • uid: number

    好友账号

  Returns Promise<boolean>

kickMember

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

• 踢出此群，use kick

  Parameters

  • uid: number

    群员账号

  • Optional msg: string

  • block: boolean = false

    是否屏蔽群员

  Returns Promise<boolean>

  Todo

  未知参数

markRead

• markRead(seq?): Promise<void>

• 标记seq之前的消息为已读

  Parameters

  • seq: number = 0

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

  Returns Promise<void>

muteAll

• muteAll(yes?): Promise<boolean>

• 全员禁言

  Parameters

  • yes: boolean = true

  Returns Promise<boolean>

muteAnony

• muteAnony(flag, duration?): Promise<void>

• 禁言匿名群员，默认1800秒

  Parameters

  • flag: string

  • duration: number = 1800

  Returns Promise<void>

muteMember

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

• 禁言群员，use mute

  Parameters

  • uid: number

    群员账号

  • duration: number = 600

    禁言时长（秒），默认600

  Returns Promise<void>

pickMember

• pickMember(uid, strict?): Member

• 获取群员实例

  Parameters

  • uid: number

    群员账号

  • strict: boolean = false

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

  Returns Member

pokeMember

• pokeMember(uid): Promise<boolean>

• 戳一戳

  Parameters

  • uid: number

    群员账号

  Returns Promise<boolean>

quit

• quit(): Promise<boolean>

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

  Returns Promise<boolean>

recallMsg

• recallMsg(msg): Promise<boolean>

• 撤回消息

  Parameters

  • msg: GroupMessage

  Returns Promise<boolean>
• recallMsg(msgid): Promise<boolean>

• Parameters

  • msgid: string

  Returns Promise<boolean>

• recallMsg(seq, rand, pktnum?): Promise<boolean>

• Parameters

  • seq: number

  • rand: number

  • Optional pktnum: number

  Returns Promise<boolean>

• recallMsg(param, rand, pktnum): Promise<boolean>

• 撤回消息，cqhttp方法用

  Parameters

  • param: number

  • rand: number

  • pktnum: number

  Returns Promise<boolean>
• recallMsg(message_id): Promise<boolean>

• 撤回消息

  Parameters

  • message_id: string

    消息id

  Returns Promise<boolean>
• recallMsg(message): Promise<boolean>

• 撤回消息

  Parameters

  • message: GroupMessage

    群聊消息对象

  Returns Promise<boolean>

removeEssence

• removeEssence(seq, rand): Promise<string>

• 移除精华消息

  Parameters

  • seq: number

    消息序号

  • rand: number

    消息的随机值

  Returns Promise<string>

renew

• renew(): Promise<GroupInfo>

• 强制刷新群资料

  Returns Promise<GroupInfo>

setAdmin

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

• 设置管理员，use setAdmin

  Parameters

  • uid: number

    群员账号

  • yes: boolean = true

    是否设为管理员

  Returns Promise<boolean>

setAvatar

• setAvatar(file): Promise<void>

• 设置群头像

  Parameters

  • file: string | Buffer | Readable

  Returns Promise<void>

setCard

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

• 设置名片，use setCard

  Parameters

  • uid: number

    群员账号

  • card: string = ""

    名片

  Returns Promise<boolean>

setName

• setName(name): Promise<boolean>

• 设置群名

  Parameters

  • name: string

  Returns Promise<boolean>

setRemark

• setRemark(remark?): Promise<void>

• 设置群备注

  Parameters

  • remark: string = ""

  Returns Promise<void>

setTitle

• setTitle(uid, title?, duration?): Promise<boolean>

• 设置头衔，use setTitle

  Parameters

  • uid: number

    群员账号

  • title: string = ""

    头衔名

  • duration: number = -1

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

  Returns Promise<boolean>

sign

• sign(): Promise<{
      result: number;
  }>

• 打卡

  Returns Promise<{
      result: number;
  }>