群属性管理

更新时间:2022-02-28

本文介绍如何管理群的属性。

环信即时通讯 IM SDK 提供以下方法用于管理群组属性:

  • modifyGroup 修改群组信息;
  • fetchGroupAnnouncement 获取群公告;
  • updateGroupAnnouncement 设置/更新群公告;
  • uploadGroupSharedFile 上传共享文件;
  • downloadGroupSharedFile 下载群共享文件
  • deleteGroupSharedFile 删除群共享文件;
  • fetchGroupSharedFileList 获取群共享文件列表。
  • 完成 SDK 初始化,详见 快速开始
  • 了解环信即时通讯 IM API 的接口调用频率限制,详见 使用限制

修改群组名称和描述

群主和群管理员可以修改群名称和群描述。

群名称的长度限制为:128 个字符。群描述的长度限制为:512 个字符。

示例代码:

let option = {
    groupId: "groupId",
    groupName: "groupName",
    description: "A description of group"
};
conn.modifyGroup(option).then(res => console.log(res))

群公告

群主和群管理员可以设置和更新群公告,群成员可以获取群公告。

群公告的长度限制为:512 个字符。

获取群公告

示例代码:

let option = {
    groupId: "groupId"
};
conn.fetchGroupAnnouncement(option).then(res => console.log(res))

设置/更新群公告

群公告发生变化时,群成员会收到 updateAnnouncement 监听事件。

示例代码:

let option = {
    groupId: "groupId",   
    announcement: "A announcement of group"                       
};
conn.updateGroupAnnouncement(option).then(res => console.log(res))

共享文件

群主和群管理员可以删除全部的群共享文件,群成员只能删除自己上传的群共享文件。

示例代码:

  • 上传共享文件
let option = {
    groupId: "groupId",
    file: file, // <input type="file"/>获取的文件对象。                        
    onFileUploadProgress: function(resp) {},   // 上传进度的回调。
    onFileUploadComplete: function(resp) {},   // 上传完成时的回调。
    onFileUploadError: function(e) {},         // 上传失败的回调。
    onFileUploadCanceled: function(e) {}       // 上传取消的回调。
};
conn.uploadGroupSharedFile(option);
  • 下载共享文件
let option = {
    groupId: "groupId",
    fileId: "fileId", // 文件 ID。                  
    onFileDownloadComplete: function(resp) {}, // 下载成功的回调。
    onFileDownloadError: function(e) {},       // 下载失败的回调。
};
conn.downloadGroupSharedFile(option);
  • 删除群共享文件
let option = {
    groupId: "groupId",
    fileId: "fileId", // 文件 ID。 
};
conn.deleteGroupSharedFile(option).then(res => console.log(res))
  • 获取群共享文件列表
let option = {
    groupId: "groupId"
};
conn.fetchGroupSharedFileList(option).then(res => console.log(res))