群操作句柄：绑定某个群的快捷操作

Properties

group_id

readonly group_id: string

---

group_name?

readonly optional group_name?: string

Methods

ban()

ban(userId, duration): Promise<void>

禁言成员，duration 单位为秒，0 表示解除

Parameters

userId

PlatformId

duration

number

Returns

Promise<void>

---

getInfo()

getInfo(): Promise<GroupInfo | null>

Returns

Promise<GroupInfo | null>

---

getList()

getList(): Promise<GroupInfo[]>

Returns

Promise<GroupInfo[]>

---

getMemberInfo()

getMemberInfo(userId): Promise<MemberInfo | null>

Parameters

userId

PlatformId

Returns

Promise<MemberInfo | null>

---

getMemberList()

getMemberList(): Promise<MemberInfo[]>

Returns

Promise<MemberInfo[]>

---

kick()

kick(userId, rejectAddRequest?): Promise<void>

Parameters

userId

PlatformId

rejectAddRequest?

boolean

Returns

Promise<void>

---

leave()

leave(isDismiss?): Promise<void>

退出群聊，isDismiss 为 true 时解散群

Parameters

isDismiss?

boolean

Returns

Promise<void>

---

recall()

recall(messageId): Promise<void>

Parameters

messageId

PlatformId

Returns

Promise<void>

---

sendMsg()

sendMsg(message): Promise<SentMessage>

Parameters

message

MessageInput

Returns

Promise<SentMessage>

---

setAdmin()

setAdmin(userId, enable): Promise<void>

Parameters

userId

PlatformId

enable

boolean

Returns

Promise<void>

---

setCard()

setCard(userId, card): Promise<void>

Parameters

userId

PlatformId

card

string

Returns

Promise<void>

---

setName()

setName(groupName): Promise<void>

Parameters

groupName

string

Returns

Promise<void>

---

setPortrait()

setPortrait(file): Promise<void>

Parameters

file

string

Returns

Promise<void>