GroupManager

Constructor

不需调用构造方法，通过实例方法RtcEngine.getGroupManager()获取对象，该对象为单例，可多次调用获取。

Methods

joinGroup

▸ joinGroup(groupId: string, options?: {userData: string}): QResult

加入指定的分组

Parameters:

▪ groupId: string

需要加入的分组

▪ options: object

可选参数，加入分组时的配置信息，目前支持通过userData属性传递用户数据，其他用户收到该用户RtcEngine.Events.groupUserJoinIndication事件时，会带上userData字段数据.

Returns: QResult

QResult {
  code: string,
  message: string
}

QResult.code为OK时表示调用成功，其他表示调用失败，QResult.message为失败原因。

---

leaveGroup

▸ leaveGroup(groupId: string): QResult

离开指定的分组

Parameters:

▪ groupId: string 需要离开的分组

Returns: QResult

QResult {
  code: string,
  message: string
}

QResult.code为OK时表示调用成功，其他表示调用失败，QResult.message为失败原因。

---

subscribeGroup

▸ subscribeGroup(groupId: string): QResult

订阅指定分组的所有人的音频

Parameters:

▪ groupId: string 需要订阅声音的分组

Returns: QResult

QResult {
  code: string,
  message: string
}

QResult.code为OK时表示调用成功，其他表示调用失败，QResult.message为失败原因。

---

unsubscribeGroup

▸ unsubscribeGroup(groupId: string): QResult

取消订阅指定分组的所有人的音频

Parameters:

▪ groupId: string 需要取消订阅声音的分组

Returns: QResult

QResult {
  code: string,
  message: string
}

QResult.code为OK时表示调用成功，其他表示调用失败，QResult.message为失败原因。

---

dismissGroup

▸ dismissGroup(groupId: string): QResult

解散指定的分组

Parameters:

▪ groupId: string 需要解散的分组

Returns: QResult

QResult {
  code: string,
  message: string
}

QResult.code为OK时表示调用成功，其他表示调用失败，QResult.message为失败原因。

---

inviteGroupUsers

▸ inviteGroupUsers(groupId: string, userIdArray: Array): QResult

给其他用户发送加入分组的邀请

Parameters:

▪ groupId: string 邀请用户加入的分组

▪ userIdArray: Array<string> 邀请的userId数组

Returns: QResult

QResult {
  code: string,
  message: string
}

QResult.code为OK时表示调用成功，其他表示调用失败，QResult.message为失败原因。

setDefaultGroup

▸ setDefaultGroup(groupId: string): QResult

设置channel的默认分组，如果channel已经存在默认分组会被覆盖，所有其他人会收到RtcEngine.Events.groupDefaultUpdateIndication事件。

Parameters:

▪ groupId: string 默认分组。可以为空字符串，表示清空默认分组。

Returns: QResult

QResult {
  code: string,
  message: string
}

QResult.code为OK时表示调用成功，其他表示调用失败，QResult.message为失败原因。

getDefaultGroup

▸ getDefaultGroup(): string

获取当前channel的默认分组

Returns: string

observeGroup

▸ observeGroup(groupId: string): QResult

观察特定分组的人员变化，使得没有加入的分组时，用户能观察到该分组的人员变化情况。会收到 RtcEngine.Events.groupUserJoinIndication和

RtcEngine.Events.groupUserLeaveIndication事件

Parameters:

▪ groupId: string 待观察的分组

Returns: QResult

QResult {
  code: string,
  message: string
}

QResult.code为OK时表示调用成功，其他表示调用失败，QResult.message为失败原因。

unobserveGroup

▸ unobserveGroup(groupId: string): QResult

取消观察特定分组的人员变化。

Parameters:

▪ groupId: string 待取消观察的分组

Returns: QResult

QResult {
  code: string,
  message: string
}

QResult.code为OK时表示调用成功，其他表示调用失败，QResult.message为失败原因。

observeAllGroups

▸ observeAllGroups(): QResult

观察所有分组的人员变化，使得没有加入的分组时，用户能观察到该分组的人员变化情况。会收到 RtcEngine.Events.groupUserJoinIndication和 RtcEngine.Events.groupUserLeaveIndication事件

Returns: QResult

QResult {
  code: string,
  message: string
}

QResult.code为OK时表示调用成功，其他表示调用失败，QResult.message为失败原因。

unobserveAllGroups

▸ unobserveAllGroups(): QResult

取消观察所有分组的人员变化。

Returns: QResult

QResult {
  code: string,
  message: string
}

QResult.code为OK时表示调用成功，其他表示调用失败，QResult.message为失败原因。

on

▸ on(event: string, cb: Function): void

监听事件，支持group相关的事件:

RtcEngine.Events.groupJoinConfirm,

RtcEngine.Events.groupUserJoinIndication,

RtcEngine.Events.groupUserLeaveIndication,

RtcEngine.Events.groupDismissConfirm,

RtcEngine.Events.groupLeaveIndication,

RtcEngine.Events.groupInviteIndication

RtcEngine.Events.groupDefaultUpdateIndication

RtcEngine.Events.setDefaultGroupConfirm

RtcEngine.Events.groupObserveConfirm

Parameters:

Name	Type	Description
event	string	RtcEngine.Events
cb	Function	回调函数

Returns: void

---

off

▸ off(event: string, cb: Function): void

取消监听事件，内部分发的事件参见 RtcEngine.Events

Parameters:

Name	Type	Description
event	string	RtcEngine.Events
cb	Function	回调函数

Returns: void