Skip to content

Member

client.pickMember(<group_id>, <friend_id>) 得到 Member 对象,表示某个群里的某位成员。也可以从群对象 client.pickGroup(<group_id>).pickMember(<friend_id>) 取得。

Member 也继承自 User:所以它同样有 sendMsggetProfilethumbUp 等通用方法。对群员调用 sendMsg 即发起群临时会话(不是群消息)。User 通用方法详见 Friend / User

管理类操作(踢人、禁言、设管理员、设头衔)需要你在该群是群主或管理员,否则失败。多数方法返回 Promise<boolean>

本页示例均假设 client 已登录。

方法

踢出

  • 方法:member.kick(msg?, block?)
  • 签名:kick(msg?: string, block?: boolean): Promise<boolean>
  • 描述:把该群员踢出群。

参数

参数类型必填默认说明
msgstring-附带的踢出消息。
blockbooleanfalse是否屏蔽(不允许再加群)。

返回值

Promise<boolean> —— 是否成功。

示例

js
// 假设 client 已登录
await client.pickMember(<group_id>, <friend_id>).kick()
ts
await client.pickMember(<group_id>, <friend_id>).kick()

禁言

  • 方法:member.mute(duration?)
  • 签名:mute(duration?: number): Promise<boolean>
  • 描述:禁言该群员。

参数

参数类型必填默认说明
durationnumber1800禁言时长(秒),最长 30 天(2592000);传 0 解除禁言。

返回值

Promise<boolean> —— 是否成功。

示例

js
// 假设 client 已登录
await client.pickMember(<group_id>, <friend_id>).mute(600) // 10 分钟
await client.pickMember(<group_id>, <friend_id>).mute(0)   // 解除
ts
await client.pickMember(<group_id>, <friend_id>).mute(600)
await client.pickMember(<group_id>, <friend_id>).mute(0)

设置管理员

  • 方法:member.setAdmin(yes?)
  • 签名:setAdmin(yes?: boolean): Promise<boolean>
  • 描述:设置 / 取消该群员为管理员(需群主权限)。

参数

参数类型必填默认说明
yesbooleantruetrue 设为管理员,false 取消。

返回值

Promise<boolean> —— 是否成功。

示例

js
// 假设 client 已登录
await client.pickMember(<group_id>, <friend_id>).setAdmin(true)
ts
await client.pickMember(<group_id>, <friend_id>).setAdmin(true)

设置头衔

  • 方法:member.setTitle(title?, duration?)
  • 签名:setTitle(title?: string, duration?: number): Promise<boolean>
  • 描述:给该群员设置专属头衔(需群主权限)。

参数

参数类型必填默认说明
titlestring""头衔名,空字符串表示清除。
durationnumber-1持续秒数,-1 表示永久。

返回值

Promise<boolean> —— 是否成功。

示例

js
// 假设 client 已登录
await client.pickMember(<group_id>, <friend_id>).setTitle("锦鲤", -1)
ts
await client.pickMember(<group_id>, <friend_id>).setTitle("锦鲤", -1)

修改名片

  • 方法:member.setCard(card?)
  • 签名:setCard(card?: string): Promise<boolean>
  • 描述:修改该群员的群名片。

参数

参数类型必填默认说明
cardstring""新名片,空字符串表示清空。

返回值

Promise<boolean> —— 是否成功。

示例

js
// 假设 client 已登录
await client.pickMember(<group_id>, <friend_id>).setCard("管理员-小李")
ts
await client.pickMember(<group_id>, <friend_id>).setCard("管理员-小李")

戳一戳

  • 方法:member.poke()
  • 签名:poke(): Promise<boolean>
  • 描述:在群里戳一戳该成员。

参数

无。

返回值

Promise<boolean> —— 是否成功。

示例

js
// 假设 client 已登录
await client.pickMember(<group_id>, <friend_id>).poke()
ts
await client.pickMember(<group_id>, <friend_id>).poke()

加为好友

  • 方法:member.addFriend(comment?)
  • 签名:addFriend(comment?: string): Promise<boolean>
  • 描述:把该群员加为好友(发送好友申请)。

参数

参数类型必填默认说明
commentstring""申请附言。

返回值

Promise<boolean> —— 是否成功发出申请(对方设置不允许时返回 false)。

示例

js
// 假设 client 已登录
await client.pickMember(<group_id>, <friend_id>).addFriend("群里聊过,加个好友")
ts
await client.pickMember(<group_id>, <friend_id>).addFriend("群里聊过,加个好友")

刷新资料

  • 方法:member.renew()
  • 签名:renew(): Promise<MemberInfo>
  • 描述:强制从服务器刷新该群员的资料(名片、头衔、角色等)。

参数

无。

返回值

Promise<MemberInfo> —— 最新的群员资料。

示例

js
// 假设 client 已登录
const info = await client.pickMember(<group_id>, <friend_id>).renew()
console.log(info.card, info.role)
ts
const info = await client.pickMember(<group_id>, <friend_id>).renew()
console.log(info.card, info.role)

其他方法

方法签名说明
sendMsg(content, source?)继承自 User发起群临时会话。
setScreenMsg(isScreen?)(isScreen?: boolean) => Promise<boolean>屏蔽 / 取消屏蔽该成员的消息。
getProfile()继承自 User查资料卡。
thumbUp(times?)继承自 User给该成员点赞。

getter 属性

直接读取的只读属性(不是方法)。

属性类型说明
group_id / gidnumber所在群号。
user_id / uinnumber该成员 QQ 号。
infoMemberInfo | undefined群员资料对象(访问时可能自动刷新)。
cardstring | undefined群名片(无名片时取昵称)。
titlestring | undefined群头衔。
is_ownerboolean是否是群主。
is_adminboolean是否是管理员(含群主)。
is_friendboolean是否是我的好友。
mute_leftnumber禁言剩余秒数。
groupGroup所在群的对象。
js
// 假设 client 已登录
const m = client.pickMember(<group_id>, <friend_id>)
console.log(m.card, m.title, m.is_admin)
// 也可以反向拿到群对象
await m.group.muteMember(m.user_id, 60)
ts
const m = client.pickMember(<group_id>, <friend_id>)
console.log(m.card, m.title, m.is_admin)
await m.group.muteMember(m.user_id, 60)

相关

Group / Discuss · Friend / User · Client