注册群变动事件监听。
群组事件监听器,必填。
。
添加白名单。
仅群组创建者和管理员可调用此方法。
群组 ID。
要添加的成员的用户 ID 列表或者单个用户 ID。
返回的 Promise 结果,成功会回调到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
向群组中添加新成员。
仅群组创建者和管理员可调用此方法。
群组 ID。
要添加的新成员的用户 ID 数组或者单个用户 ID。
Optional
welcomeMessage: string邀请信息。
返回的 Promise 结果。成功会回调到 then(),失败则在 catch 中抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
申请加入群组。
前提:群组类型为 GroupStyle#GroupStylePublicJoinNeedApproval 或 GroupStyle#GroupStylePublicOpenJoin,即公开群。
群组 ID。
Optional
reason: string申请加入的原因。
返回的 Promise 结果,成功会回调到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
将一组用户加入群组黑名单。
先将用户移出群,再加入黑名单。加入黑名单的用户无法加入群。
仅群主和管理员可调用此方法。
群组 ID。
要加入黑名单的用户 ID 数组或者单个用户 ID。
Optional
reason: string可选参数。加入黑名单的原因。
返回的 Promise 结果,成功会回调到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
检查自己是否在群组白名单中。
仅群组创建者和管理员可调用此方法。
群组 ID。
返回的 Promise 结果,成功会回调到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
创建群组。
群组创建成功后,会更新内存及数据库中的数据,多端多设备会收到相应的通知事件,将群组更新到内存及数据库中。
可通过设置 MultiDevicesListener 监听相关事件,事件回调函数为 MultiDevicesListener#onGroupEvent, 第一个参数为事件,建群事件为 MultiDevicesEvent.GROUP_CREATE。
Optional
option: GroupOptions群的设置,可选参数,非必要。详见 GroupOptions。 - groupName -群组名称,不传值默认为 ""。 - desc -群组描述,不传值默认为 ""。 - members -创建群时初始群成员数组。群主的用户 ID 非必要。若不传值,则创建的群组初始时除群主外不带其他成员。 - reason -邀请群成员加入时的邀请信息,不传值默认为 ""。 - maxUsers -群最大成员数,不传值默认值为 200。 - style -群类型,详见 GroupStyle,不传值默认为 GroupStyle.GroupStylePrivateOnlyOwnerInvite。 - inviteNeedConfirm -邀请进群是否需要受邀用户同意,默认为 false,即邀请后直接进群。 - extField -群详情扩展信息,可以采用 json 格式。
-返回的 Promise 结果,成功会将群对象回调到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
拒绝入群邀请。
群组 ID。
Optional
reason: string拒绝理由。
返回的 Promise 结果,成功会回调到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
删除群组指定的共享文件。
成员可以删除自己上传的文件,群组所有者或者群组管理员可以删除所有的共享文件。
群组 ID。
文件 ID。
返回的 Promise 结果,成功会回调到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
解散群组。
仅群主可调用此方法。
群组 ID。
解散群组返回的 Promise 结果。成功会回调到 then(),失败则在 catch 中抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
下载群组中指定的共享文件。
群组 ID。
文件 ID。
文件保存路径。
Optional
callback: ChatCallback下载文件进度回调。
返回的 Promise 结果,成功会回调到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
从服务器获取群组公告。
群成员可调用此方法。
群组 ID。
返回的 Promise 结果,成功会回调群组公告到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
以分页方式获取群组的黑名单。
仅群主和管理员可调用此方法。
群组 ID。
当前页码,从 1 开始。
每页返回的黑名单上的用户数。
返回的 Promise 结果,成功会回调黑名单列表到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
以分页方式获取群组成员列表。
群组 ID。
每页返回的群组成员数。
Optional
cursor: string可选参数,从这个游标位置开始取数据,首次获取数据时可不传或传 ""。
返回的 Promise 结果。 成功会回调 MemberListResult 到 then(),包含用于下次获取数据的 cursor 以及成员的数组对象。如果是最后一页,cursor 返回结果为空字符串。详见 CursorResult。 失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
获取群组的禁言列表。
仅聊天室创建者和管理员可调用此方法。
群组 ID。
当前页码,从 1 开始。
每页返回的禁言成员数。
返回的 Promise 结果,成功会回调包含禁言成员 ID 及其禁言时长的 Map(key 是被禁言的成员的用户 ID,value 是禁言时间,单位是毫秒)到 then()。 失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
从服务器获取群组的共享文件列表。
群组 ID。
当前页码,从 1 开始。
每页返回的共享文件数。
返回的 Promise 结果,成功会返回共享文件属性对象数组回调到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
获取群组白名单列表。
仅聊天室创建者和管理员可调用此方法。
群组 ID。
返回的 Promise 结果,成功会返回白名单数组回调到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
从服务器获取当前用户已加入的群组数量。
返回的 Promise 结果,成功会回调加入的群组数量到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
以分页方式从服务器获取当前用户已加入的群组。
此操作只返回群组列表,不包含群组的所有成员信息。如果要更新某个群组包括成员的全部信息,需要再调用 fetchGroupFromServer。
当前页码,从 0 开始。
每页返回的群组数,最大不超过 20。
返回的 Promise 结果,成功会回调群组数组到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
根据指定的属性 key 获取多个群成员的自定义属性。
群组 ID。
要获取自定义属性的群成员的用户 ID 数组。
Optional
keys: string | string[]要获取自定义属性的 key 的数组。若 keys 为空数组或不传则获取这些群成员的所有自定义属性。
以分页方式从服务器获取公开群组。
每页返回的公开群组数。
Optional
cursor: string可选参数。从这个游标位置开始取数据,首次获取数据时不传即可。
返回的 Promise 结果。
邀请用户加入群组。
前提:群组类型是 GroupStyle#GroupStylePrivateMemberCanInvite 或 GroupStyle#GroupStylePrivateOnlyOwnerInvite,即私有群。
群组 ID。
受邀用户的 ID 数组或者单个用户 ID。
Optional
reason: string邀请原因。
返回的 Promise 结果,成功会回调到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
当前登录用户加入公开群。
如果是自由加入的公开群,直接进入群组;需要验证的公开群需要等待群主同意。详见 GroupStyle。
群组 ID。
Optional
message: string可选参数,申请入群携带的信息。
返回的 Promise 结果,成功会回调到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
当前登录用户退出群组。
群组 ID。
返回的 Promise 结果,成功会回调到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
将一组成员禁言。
仅群主和管理员可调用此方法。
群组 ID。
要禁言的用户 ID 数组或单个用户 ID。
禁言时间,单位是毫秒。若为 -1
,表示永久禁言。
返回的 Promise 结果,成功会回调更新后的群组对象到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
移除白名单。
仅群组创建者和管理员可调用此方法。
群组 ID。
需要从白名单中移除的成员的用户 ID 列表或者单个用户 ID。
返回的 Promise 结果,成功会回调到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
移除群组变化监听器。
群组事件监听器,必填。
。
上传共享文件至群组。
群组 ID。
文件本地路径。
Optional
callback: ChatCallback上传文件进度回调。
返回的 Promise 结果,成功会返回共享文件属性对象回调到 then(),失败则抛出 ChatError 异常,包括错误码和错误信息。详见 ChatError。
群组管理, 用于管理群组的创建、删除,成员管理等操作。