管理标签信息数据

SDK 提供标签管理系统，支持开发者为会话打标签，以便更好地分类与管理。这些标签信息会同步至服务器端。

本文档介绍 SDK 提供的标签管理相关接口，包括：

• 创建标签
• 删除标签
• 编辑标签
• 获取标签列表

提示

关于如何使用标签管理会话，详见使用标签管理会话。

创建标签

调用 addTag 方法，可为当前用户创建一个新标签。每个用户最多可创建 20 个标签。

接口

JavaScript

RongIMLib.addTag(tag)

参数说明

参数	类型	必填	说明
tag	ITagParam	是	标签信息，包含标签 ID 和标签名称

示例代码

JavaScript

const tag = {
 tagId: 'tagId',
 tagName: 'tagName',
};
const res = await RongIMLib.addTag(tag);
console.log('创建标签结果：', res);

删除标签

调用 removeTag 方法，删除指定标签。

接口

JavaScript

RongIMLib.removeTag(tagId)

参数说明

参数	类型	必填	说明
tagId	string	是	要删除的标签 ID

示例代码

JavaScript

const tagId = 'tagId';
const res = await RongIMLib.removeTag(tagId);
console.log('删除标签结果：', res);

编辑标签

调用 updateTag 方法，修改已存在标签的名称。

接口

JavaScript

RongIMLib.updateTag(tag)

参数说明

参数	类型	必填	说明
tag	ITagParam	是	标签信息。

示例代码

JavaScript

const tag = {
 tagId: 'tagId',
 tagName: 'tagName',
};
const res = await RongIMLib.updateTag(tag);
console.log('编辑标签结果：', res);

获取标签列表

调用 getTags 方法，获取当前用户已创建的标签列表。

接口

JavaScript

RongIMLib.getTags()

参数说明

无

示例代码

JavaScript

const res = await RongIMLib.getTags();
console.log('获取标签列表结果：', res);