上云无忧 > 文档中心 > 环信IM即时通讯使用教程(React-Native) - 管理群组属性
IM即时通讯
环信IM即时通讯使用教程(React-Native) - 管理群组属性

文档简介:
群组是支持多人沟通的即时通讯系统,本文介绍如何使用环信即时通讯 IM React Native SDK 在实时互动 app 中实现群组属性相关功能。 技术原理: 环信即时通讯 IM React Native SDK 提供 ChatGroupManager 类和 ChatGroup 类用于群组管理,支持你通过调用 API 在项目中实现如下功能:
*此产品及展示信息均由环信官方提供。免费试用 咨询热线:400-826-7010,为您提供专业的售前咨询,让您快速了解云产品,助您轻松上云! 微信咨询
  免费试用、价格特惠

群组是支持多人沟通的即时通讯系统,本文介绍如何使用环信即时通讯 IM React Native SDK 在实时互动 app 中实现群组属性相关功能。

技术原理

环信即时通讯 IM React Native SDK 提供 ChatGroupManager 类和 ChatGroup 类用于群组管理,支持你通过调用 API 在项目中实现如下功能:

  • 修改群组名称及描述
  • 获取、更新群组公告
  • 管理群组共享文件
  • 更新群扩展字段

前提条件

开始前,请确保满足以下条件:

  • 完成 SDK 初始化,详见 快速开始 及 SDK 集成概述。
  • 了解环信即时通讯 IM 的使用限制,详见 使用限制。
  • 了解群组和群成员的数量限制,详见 套餐包详情 (opens new window)

实现方法

本节介绍如何使用环信即时通讯 IM React Native SDK 提供的 API 实现上述功能。

修改群组名称

仅群主和群管理员可以调用 changeGroupName 方法设置和修改群组名称,群名称的长度限制为 128 个字符。

示例代码如下:

// 修改群组名称。 ChatClient.getInstance() .groupManager.changeGroupName(groupId, local_name) .then(() => 
{ console.log("update group name success."); }) .catch((reason) => { console.log("update group name fail.", reason); }); 
 

修改群组描述

仅群主和群管理员可以调用 changeGroupDescription 方法设置和修改群组描述,群描述的长度限制为 512 个字符。

示例代码如下:

ChatClient.getInstance() .groupManager.changeGroupDescription(groupId, desc) .then(() => { console.log
("update group description success."); }) .catch((reason) => { console.log("update group description fail.", reason); }); 
 

管理群公告

更新群公告

仅群主和群管理员可以调用 updateGroupAnnouncement 方法设置和更新群公告,群公告的长度限制为 512 个字符。群公告发生变化时,群成员会收到群组事件通知 IGroupManagerDelegate#OnAnnouncementChangedFromGroup。

示例代码如下:

ChatClient.getInstance() .groupManager.updateGroupAnnouncement(groupId, announcement) .then(() => 
{ console.log("update ann success."); }) .catch((reason) => { console.log("update ann fail.", reason); }); 
 

获取群公告

所有群成员均可以调用 fetchAnnouncementFromServer 方法从服务器获取群公告。

示例代码如下:

ChatClient.getInstance() .groupManager.fetchAnnouncementFromServer(groupId) .then((ann) => { console.log
("get ann success.", ann); }) .catch((reason) => { console.log("get ann fail.", reason); }); 
 

当群组公告发生变化时,所有群成员收到通知 ChatGroupEventListener#onAnnouncementChanged。

管理共享文件

上传共享文件

所有群组成员均可以调用 uploadGroupSharedFile 方法上传共享文件至群组,群共享文件大小限制为 10 MB。上传共享文件后,其他群成员收到 ChatGroupEventListener#onSharedFileAdded 回调。

示例代码如下:

// 设置文件进度回调 const callback = new (class implements ChatGroupFileStatusCallback { that: any; 
constructor(t: any) { this.that = t; } onProgress(groupId: string, filePath: string, progress: number): 
void { console.log(`onProgress: `, groupId, filePath, progress); } onError(groupId: string, filePath:
 string, error: ChatError): void { console.log(`onError: `, groupId, filePath, error); } onSuccess
(groupId: string, filePath: string): void { console.log(`onSuccess: `, groupId, filePath); } })(this)
; ChatClient.getInstance() .groupManager.uploadGroupSharedFile(groupId, filePath, callback) .then(() =
> { console.log("upload file success."); }) .catch((reason) => { console.log("upload file fail.", reason); }); 
 

删除共享文件

所有群成员均可以调用 removeGroupSharedFile 方法删除群共享文件。删除共享文件后,其他群成员收到 ChatGroupEventListener#onSharedFileDeleted 回调。

群主和群管理员可删除全部的群共享文件,群成员只能删除自己上传的群文件。示例代码如下:

ChatClient.getInstance() .groupManager.removeGroupSharedFile(groupId, fileId) .then(() => { console.log
("remove file success."); }) .catch((reason) => { console.log("remove file fail.", reason); }); 
 

从服务器获取共享文件

所有群成员均可以调用 fetchGroupFileListFromServer 方法从服务器获取群组的共享文件列表。

// 分页获取群组文件 ChatClient.getInstance() .groupManager.fetchGroupFileListFromServer(groupId, pageSize,
 pageNum) .then(() => { console.log("get file success."); }) .catch((reason) => { console.log("get file fail.", reason); }); 
 

更新群扩展字段

仅群主和群管理员可以调用 updateGroupExtension 方法更新群组的扩展字段,群组扩展字段设置 JSON 格式的数据,用于自定义更多群组信息。群扩展字段的长度限制为 8 KB。

示例代码如下:

// 设置扩展字段 const extension = { key: "value" }; ChatClient.getInstance() .groupManager.
updateGroupExtension(groupId, JSON.stringify(extension)) .then(() => { console.log("update success.");
 }) .catch((reason) => { console.log("update fail.", reason); }); 
 

监听群组事件

监听群组事件

相似文档
  • 功能描述: 聊天室是支持多人加入的类似 Twitch 的组织。聊天室中的成员没有固定关系,用户离线后,超过 5 分钟会自动退出聊天室。聊天室成员在离线后,不会收到推送消息。聊天室可以应用于直播、消息广播等。
  • 聊天室是支持多人沟通的即时通讯系统。聊天室中的成员没有固定关系,用户离线后,超过 5 分钟会自动退出聊天室。聊天室成员在离线后,不会收到推送消息。聊天室可以应用于直播、消息广播等。 本文介绍如何使用环信即时通讯 IM SDK 在实时互动 app 中创建和管理聊天室,并实现聊天室的相关功能。
  • 聊天室是支持多人沟通的即时通讯系统。本文介绍如何使用环信即时通讯 IM React Native SDK 在实时互动 app 中管理聊天室成员,并实现聊天室的相关功能。
  • 聊天室是支持多人沟通的即时通讯系统。聊天室属性可分为聊天室名称、描述和公告等基本属性和自定义属性(key-value)。若聊天室基本属性不满足业务要求,用户可增加自定义属性并同步给所有成员。利用自定义属性可以存储直播聊天室的类型、狼人杀等游戏中的角色信息和游戏状态以及实现语聊房的麦位管理和同步等。聊天室自定义属性以键值对(key-value)形式存储,属性信息变更会实时同步给聊天室成员。
  • 环信即时通讯 IM 支持同一个用户 ID 在多个平台或者多个设备上登录; 客户端支持查询当前账号的已登录设备列表,可强制该账号从其他已登录设备下线; 环信即时通讯 IM React Native SDK 支持在同一账号所有已登录设备上同步在线和离线消息以及对应的回执和已读状态、接收离线推送通知、同步好友、群组以及聊天室相关的操作。
官方微信
联系客服
400-826-7010
7x24小时客服热线
分享
  • QQ好友
  • QQ空间
  • 微信
  • 微博
返回顶部