Class ChatGroupManager

群组管理类，用于管理群组的创建，删除及成员管理等操作。

Hierarchy

BaseManager
- ChatGroupManager

Index

Constructors

constructor

new ChatGroupManager(): ChatGroupManager
Returns ChatGroupManager
Overrides BaseManager.constructor

Properties

`Protected` `Optional`_eventEmitter

_eventEmitter?: NativeEventEmitter

`Protected` `Static`TAG

TAG: string = 'ChatGroupManager'

Methods

acceptInvitation

acceptInvitation(groupId: string, inviter: string): Promise<void>
接受入群邀请。
Parameters
- groupId: string
  群组 ID。
- inviter: string
  邀请人的用户 ID。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

acceptJoinApplication

acceptJoinApplication(groupId: string, userId: string): Promise<void>
同意入群申请。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
- userId: string
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

addAdmin

addAdmin(groupId: string, admin: string): Promise<void>
添加群组管理员。

仅群主可调用此方法。管理员不可调用该方法。
Parameters
- groupId: string
  群组 ID。
- admin: string
  设置为群组管理员的成员用户 ID。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

addAllowList

addAllowList(groupId: string, members: string[]): Promise<void>
将成员加入群组白名单。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
- members: string[]
  要加入群组白名单的用户 ID 列表。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

addGroupListener

addGroupListener(listener: ChatGroupEventListener): void
添加群组监听器。
Parameters
- listener: ChatGroupEventListener
  将要添加的群组监听器。
Returns void

addMembers

addMembers(groupId: string, members: string[], welcome?: string): Promise<void>
向群组中添加新成员。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
- members: string[]
  要加入的成员列表。
- Optionalwelcome: string
  (可选) 欢迎消息。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

blockGroup

blockGroup(groupId: string): Promise<void>
屏蔽群消息。

屏蔽群消息的用户仍是群成员，但无法接收群消息。
Parameters
- groupId: string
  群组 ID。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

blockMembers

blockMembers(groupId: string, members: string[]): Promise<void>
将成员加入群组的黑名单列表。

成功调用该方法后，该用户会先被移除出群组，然后加入群组黑名单。该用户无法接收、发送群消息，也无法申请再次加入群组。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
- members: string[]
  要加入群组黑名单的成员的用户 ID 列表。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

changeGroupDescription

changeGroupDescription(groupId: string, description: string): Promise<void>
修改群组描述。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
- description: string
  新的群组描述。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

changeGroupName

changeGroupName(groupId: string, groupName: string): Promise<void>
修改群组名称。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
- groupName: string
  新的群组名称。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

changeOwner

changeOwner(groupId: string, newOwner: string): Promise<void>
转移群主权限。

仅群主可调用此方法。
Parameters
- groupId: string
  群组 ID。
- newOwner: string
  新群主的用户 ID。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

createGroup

createGroup(
    options: ChatGroupOptions,
    groupName: string,
    desc?: string,
    inviteMembers?: string[],
    inviteReason?: string,
): Promise<ChatGroup>
创建群组。

群组创建成功后，会更新内存及数据库中的数据，多端多设备会收到相应的通知事件，然后将群组更新到内存及数据库中。

可通过设置 ChatGroupEventListener 监听相关事件。
Parameters
- options: ChatGroupOptions
  群组创建时需设置的选项。该参数可选，不可为 null。详见 ChatGroupOptions. 群组的其他选项如下： - 群组最大成员数，默认值为 200； - 群组类型，详见 ChatGroupStyle。默认值为 ChatGroupStyle.PrivateOnlyOwnerInvite，即私有群，仅群主可邀请用户入群； - 邀请入群是否需要对方同意，默认为 false，即邀请后直接入群； - 群详情扩展。
- groupName: string
  群组名称。该参数可选，不设置传 null。
- Optionaldesc: string
  群组描述。该参数可选，不设置传 null。
- OptionalinviteMembers: string[]
  群成员列表。可选参数。该参数不可为 null。
- OptionalinviteReason: string
  成员入群的邀请信息。该参数可选，不设置传 null。
Returns Promise<ChatGroup>
创建成功的群组实例。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

createGroupEx

createGroupEx(
    params: {
        desc?: string;
        groupAvatar?: string;
        groupName: string;
        inviteMembers?: string[];
        inviteReason?: string;
        options: ChatGroupOptions;
    },
): Promise<ChatGroup>
创建群组对象。支持设置头像。

群组创建成功后，会更新内存及数据库中的数据，多端多设备会收到相应的通知事件，然后将群组更新到内存及数据库中。

可通过设置 ChatGroupEventListener 监听相关事件。
Parameters
- params: {
      desc?: string;
      groupAvatar?: string;
      groupName: string;
      inviteMembers?: string[];
      inviteReason?: string;
      options: ChatGroupOptions;
  }
Returns Promise<ChatGroup>
创建成功的群组实例。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

declineInvitation

declineInvitation(
    groupId: string,
    inviter: string,
    reason?: string,
): Promise<void>
拒绝入群邀请。
Parameters
- groupId: string
  群组 ID。
- inviter: string
  邀请人的用户 ID。
- Optionalreason: string
  拒绝理由。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

declineJoinApplication

declineJoinApplication(
    groupId: string,
    username: string,
    reason?: string,
): Promise<void>
拒绝用户的入群申请。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
- username: string
  申请入群的用户 ID。
- Optionalreason: string
  拒绝理由。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

destroyGroup

destroyGroup(groupId: string): Promise<void>
解散群组。

仅群主可调用此方法。
Parameters
- groupId: string
  群组 ID。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

downloadGroupSharedFile

downloadGroupSharedFile(
    groupId: string,
    fileId: string,
    savePath: string,
    callback?: ChatGroupFileStatusCallback,
): Promise<void>
下载群共享文件。
Parameters
- groupId: string
  群组 ID。
- fileId: string
  群共享文件 ID。
- savePath: string
  群共享文件保存地址。
- Optionalcallback: ChatGroupFileStatusCallback
  （可选）下载结果回调。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

fetchAllowListFromServer

fetchAllowListFromServer(groupId: string): Promise<string[]>
从服务器分页获取群组白名单列表。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
Returns Promise<string[]>
群组白名单列表。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

fetchAnnouncementFromServer

fetchAnnouncementFromServer(groupId: string): Promise<string>
从服务器获取群组公告。

所有群成员都可以调用该方法。
Parameters
- groupId: string
  群组 ID。
Returns Promise<string>
群组公告。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

fetchBlockListFromServer

fetchBlockListFromServer(
    groupId: string,
    pageSize?: number,
    pageNum?: number,
): Promise<string[]>
从服务器分页获取群组黑名单列表。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
- pageSize: number = 200
  每页获取的数量。
- pageNum: number = 1
  当前页码，从 1 开始。
Returns Promise<string[]>
群组黑名单列表。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

fetchGroupFileListFromServer

fetchGroupFileListFromServer(
    groupId: string,
    pageSize?: number,
    pageNum?: number,
): Promise<ChatGroupSharedFile[]>
从服务器分页获取群共享文件。
Parameters
- groupId: string
  群组 ID。
- pageSize: number = 200
  每页获取的群共享文件数量。
- pageNum: number = 1
  当前页面，从 1 开始。
Returns Promise<ChatGroupSharedFile[]>
群共享文档列表。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

fetchGroupInfoFromServer

fetchGroupInfoFromServer(
groupId: string,
isFetchMembers?: boolean,
): Promise<ChatGroup | undefined>
从服务器获取群组详情。
Parameters
- groupId: string
  群组 ID。
- isFetchMembers: boolean = false
  是否获取群组成员信息： - true：是；该方法最多可获取 200 个成员的信息。如需获取所有群组成员的信息，可调用 fetchMemberListFromServer。 - false：否。
Returns Promise<ChatGroup | undefined>
群组实例。如果群组不存在，返回 undefined。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

fetchGroupInfoWithoutMembersFromServer

fetchGroupInfoWithoutMembersFromServer(
groupId: string,
): Promise<ChatGroup | undefined>
获取群组信息，但不包含群组成员信息。
Parameters
- groupId: string
  群组 ID。
Returns Promise<ChatGroup | undefined>
群组实例。如果群组不存在，返回 undefined。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

fetchJoinedGroupCount

fetchJoinedGroupCount(): Promise<number>
获取已加入的群组数目。

Returns Promise<number>
已加入群组的数目。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

fetchJoinedGroupsFromServer

fetchJoinedGroupsFromServer(
pageSize: number,
pageNum: number,
): Promise<ChatGroup[]>
以分页方式从服务器获取当前用户已加入的群组。

此操作只返回群组列表，不包含群组的所有成员信息。如果要更新某个群组包括成员的全部信息，需要再调用 #fetchMemberListFromServer。
Parameters
- pageSize: number
  每页期望返回的群组数。[1, 20]
- pageNum: number
  当前页码，从 0 开始。
Returns Promise<ChatGroup[]>
当前用户已加入的群组列表

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

fetchMemberAttributes

fetchMemberAttributes(
groupId: string,
member: string,
): Promise<Record<string, string> | undefined>
获取单个群成员所有自定义属性。
Parameters
- groupId: string
  群组 ID。
- member: string
  要获取的自定义属性的群成员的用户 ID。
Returns Promise<Record<string, string> | undefined>
成员属性。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

fetchMemberInfoListFromServer

fetchMemberInfoListFromServer(
    groupId: string,
    cursor: string,
    limit?: number,
): Promise<ChatCursorResult<ChatGroupMember>>
从服务器分页获取群组成员信息列表。
Parameters
- groupId: string
  群组 ID。
- cursor: string
  游标位置，从该位置开始获取数据。首次调用时传 null，按成员加入群组时间的倒序获取。
- Optionallimit: number
  每页获取的群组成员数量。默认值为 200。
Returns Promise<ChatCursorResult<ChatGroupMember>>
群组成员信息列表和下次查询的游标。详见 ChatCursorResult。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError.

fetchMemberListFromServer

fetchMemberListFromServer(
    groupId: string,
    pageSize?: number,
    cursor?: string,
): Promise<ChatCursorResult<string>>
从服务器分页获取群组成员。
Parameters
- groupId: string
  群组 ID。
- pageSize: number = 200
  每页获取的群组成员数量。
- Optionalcursor: string
  开始取数据的游标位置。首次调用时传 null，按成员加入群组时间的倒序获取。
Returns Promise<ChatCursorResult<string>>
群组成员列表以及下次查询的 cursor。详见 ChatCursorResult。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

fetchMembersAttributes

fetchMembersAttributes(
    groupId: string,
    members: string[],
    attributeKeys?: string[],
): Promise<Map<string, Record<string, string>>>
根据指定的属性 key 获取多个群成员的自定义属性。
Parameters
- groupId: string
  群组 ID。
- members: string[]
  要获取自定义属性的群成员的用户 ID 数组。
- OptionalattributeKeys: string[]
  要获取自定义属性的 key 的数组。若 keys 为空数组或不传则获取这些群成员的所有自定义属性。
Returns Promise<Map<string, Record<string, string>>>
指定成员指定关键字的属性。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

fetchMuteListFromServer

fetchMuteListFromServer(
    groupId: string,
    pageSize?: number,
    pageNum?: number,
): Promise<string[]>
从服务器分页获取群组禁言列表。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
- pageSize: number = 200
  每页获取的禁言成员数量。
- pageNum: number = 1
  当前页码，从 1 开始。
Returns Promise<string[]>
群组禁言列表。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

fetchPublicGroupsFromServer

fetchPublicGroupsFromServer(
pageSize: number,
cursor?: string,
): Promise<ChatCursorResult<ChatGroupInfo>>
分页从服务器获取公开群组。
Parameters
- pageSize: number
  每页期望返回的群组数。
- Optionalcursor: string
  开始取数据的游标位置。首次调用时传 null，按群组创建时间的倒序获取。
Returns Promise<ChatCursorResult<ChatGroupInfo>>
群组列表以及用于下次查询的 cursor。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

getGroupWithId

getGroupWithId(groupId: string): Promise<ChatGroup | undefined>
根据群组 ID，从内存中获取群组对象。
Parameters
- groupId: string
  群组 ID。
Returns Promise<ChatGroup | undefined>
群组实例。如果群组不存在，返回 undefined。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

getJoinedGroups

getJoinedGroups(): Promise<ChatGroup[]>
从本地数据库获取当前用户已加入的群组。

Returns Promise<ChatGroup[]>
群组列表。

Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

inviteUser

inviteUser(groupId: string, members: string[], reason?: string): Promise<void>
邀请用户加入群组。

该方法只适用于以下三种类型的群组： PrivateOnlyOwnerInvite、PrivateMemberCanInvite 和 PublicJoinNeedApproval。对于 PrivateOnlyOwnerInvite 类型，只有群主可以邀请其他用户加入群组。对于 PrivateMemberCanInvite 类型，所有成员都可以邀请其他用户加入群组。对于 PublicJoinNeedApproval 类型，所有成员都可以邀请其他用户加入群组，但邀请后需要群主或群管理员审批。
Parameters
- groupId: string
  群组 ID。
- members: string[]
  受邀用户的用户 ID 列表。
- Optionalreason: string
  邀请理由。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

isMemberInAllowListFromServer

isMemberInAllowListFromServer(groupId: string): Promise<boolean>
从服务器查询该用户是否在群组白名单上。
Parameters
- groupId: string
  群组 ID。
Returns Promise<boolean>
该用户是否在群白名单上。
- true：是。
- false：否。
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

joinPublicGroup

joinPublicGroup(groupId: string): Promise<void>
加入公开群组。

若群组无需群主或管理员验证，可直接加入。

若群组需要群主或管理员验证，用户需等待请求批准后才能加入。群组类型详见 ChatGroupStyle。
Parameters
- groupId: string
  群组 ID。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

leaveGroup

leaveGroup(groupId: string): Promise<void>
主动退出群组。
Parameters
- groupId: string
  群组 ID。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

muteAllMembers

muteAllMembers(groupId: string): Promise<void>
禁言全体群成员。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

muteMembers

muteMembers(
    groupId: string,
    members: string[],
    duration?: number,
): Promise<void>
禁言群组成员。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
- members: string[]
  要禁言的成员用户 ID 列表。
- duration: number = -1
  禁言时长。预留参数。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

removeAdmin

removeAdmin(groupId: string, admin: string): Promise<void>
移除群组管理员权限。

仅群主可调用此方法。
Parameters
- groupId: string
  群组 ID。
- admin: string
  移除群组管理员权限的成员用户 ID。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

removeAllGroupListener

removeAllGroupListener(): void
清除群组监听器。

Returns void

removeAllowList

removeAllowList(groupId: string, members: string[]): Promise<void>
从群白名单中移出成员。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
- members: string[]
  要移出群组白名单的成员列表。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

removeGroupListener

removeGroupListener(listener: ChatGroupEventListener): void
移除群组监听器。
Parameters
- listener: ChatGroupEventListener
  要移除的群组监听器。
Returns void

removeGroupSharedFile

removeGroupSharedFile(groupId: string, fileId: string): Promise<void>
删除指定群共享文件。

群成员可以删除自己上传的共享文件，群主或管理员可以删除所有人上传的共享文件。
Parameters
- groupId: string
  群组 ID。
- fileId: string
  群共享文件 ID。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

removeMembers

removeMembers(groupId: string, members: string[]): Promise<void>
从群组中移除用户。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
- members: string[]
  要移出群组的成员用户 ID 列表。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

requestToJoinPublicGroup

requestToJoinPublicGroup(groupId: string, reason?: string): Promise<void>
申请加入群组。

该方法仅适用于群组类型为 ChatGroupStyle.PublicJoinNeedApproval 的公开群组。
Parameters
- groupId: string
  群组 ID。
- Optionalreason: string
  申请加入的理由。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

setMemberAttribute

setMemberAttribute(
    groupId: string,
    member: string,
    attributes: Record<string, string>,
): Promise<void>
设置单个群成员的自定义属性。
Parameters
- groupId: string
  群组 ID。
- member: string
  要设置自定义属性的群成员的用户 ID。
- attributes: Record<string, string>
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

setNativeListener

setNativeListener(event: NativeEventEmitter): void
Parameters
- event: NativeEventEmitter
Returns void
Overrides BaseManager.setNativeListener

unblockGroup

unblockGroup(groupId: string): Promise<void>
解除屏蔽群消息。
Parameters
- groupId: string
  群组 ID。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

unblockMembers

unblockMembers(groupId: string, members: string[]): Promise<void>
将用户从群组黑名单中移除。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
- members: string[]
  要移出黑名单的用户 ID 列表。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

unMuteAllMembers

unMuteAllMembers(groupId: string): Promise<void>
解除全体成员禁言。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

unMuteMembers

unMuteMembers(groupId: string, members: string[]): Promise<void>
将成员移除群组禁言名单。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
- members: string[]
  要移出禁言名单的用户 ID 列表。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

updateGroupAnnouncement

updateGroupAnnouncement(groupId: string, announcement: string): Promise<void>
更新群公告。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
- announcement: string
  新的群公告。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

updateGroupAvatar

updateGroupAvatar(groupId: string, avatar: string): Promise<void>
更新群组头像。
Parameters
- groupId: string
  群组 ID。
- avatar: string
  新的群组头像。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

updateGroupExtension

updateGroupExtension(groupId: string, extension: string): Promise<void>
更新群组扩展字段信息。

仅群主和管理员可调用此方法。
Parameters
- groupId: string
  群组 ID。
- extension: string
  更新后的群组扩展字段信息。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

uploadGroupSharedFile

uploadGroupSharedFile(
    groupId: string,
    filePath: string,
    callback?: ChatGroupFileStatusCallback,
): Promise<void>
上传群组共享文件。

上传成功时会触发群共享文件上传回调。
Parameters
- groupId: string
  群组 ID。
- filePath: string
  群共享文件路径。
- Optionalcallback: ChatGroupFileStatusCallback
  (可选) 群共享文件上传结果回调。
Returns Promise<void>
Throws
如果有异常会在这里抛出，包含错误码和错误描述，详见 ChatError。

`Protected` `Static`_callMethod

_callMethod<T>(method: string, args?: Object): Promise<T>
Type Parameters
- T
Parameters
- method: string
- Optionalargs: Object
Returns Promise<T>
Inherited from BaseManager._callMethod

`Protected` `Static`checkErrorFromResult

checkErrorFromResult(result: any): void
Parameters
- result: any
Returns void
Inherited from BaseManager.checkErrorFromResult

`Protected` `Static`handleGroupFileCallback

handleGroupFileCallback(
    methodName: string,
    self: BaseManager,
    groupId: string,
    filePath: string,
    callback?: ChatGroupFileStatusCallback,
): void
Parameters
- methodName: string
- self: BaseManager
- groupId: string
- filePath: string
- Optionalcallback: ChatGroupFileStatusCallback
Returns void
Inherited from BaseManager.handleGroupFileCallback

`Protected` `Static`handleMessageCallback

handleMessageCallback(
    methodName: string,
    self: BaseManager,
    message: ChatMessage,
    callback?: ChatMessageStatusCallback,
): void
Parameters
- methodName: string
- self: BaseManager
- message: ChatMessage
- Optionalcallback: ChatMessageStatusCallback
Returns void
Inherited from BaseManager.handleMessageCallback

Class ChatGroupManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ChatGroupManager

Properties

Protected Optional_eventEmitter

Protected StaticTAG

Methods

acceptInvitation

Parameters

Returns Promise<void>

Throws

acceptJoinApplication

Parameters

Returns Promise<void>

Throws

addAdmin

Parameters

Returns Promise<void>

Throws

addAllowList

Parameters

Returns Promise<void>

Throws

addGroupListener

Parameters

Returns void

addMembers

Parameters

Returns Promise<void>

Throws

blockGroup

Parameters

Returns Promise<void>

Throws

blockMembers

Parameters

Returns Promise<void>

Throws

changeGroupDescription

Parameters

Returns Promise<void>

Throws

changeGroupName

Parameters

Returns Promise<void>

Throws

changeOwner

Parameters

Returns Promise<void>

Throws

createGroup

Parameters

Returns Promise<ChatGroup>

Throws

createGroupEx

Parameters

Returns Promise<ChatGroup>

Throws

declineInvitation

Parameters

Returns Promise<void>

Throws

declineJoinApplication

Parameters

Returns Promise<void>

Throws

destroyGroup

Parameters

Returns Promise<void>

Throws

downloadGroupSharedFile

Parameters

Returns Promise<void>

Throws

`Protected` `Optional`_eventEmitter

`Protected` `Static`TAG