跳到主要内容

版本:5.X

管理标签信息数据

SDK 支持创建标签系统,用于对会话进行管理。SDK 创建的标签会被同步到服务端。

本文描述了 SDK 标签管理的接口,包括如何创建标签、编辑标签,获取标签列表,以及移除标签。

提示

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

创建标签

调用 addTag 创建一个标签。每个用户最多可以创建 20 个标签。

RongIMLib.addTag({
tagId: '<标签Id>',
tagName: '<标签名字>'
}).then(({ code }) => {
console.log(code);
});
参数类型必填说明
tagITagParam要创建的标签
tag.tagIdstring标签 ID,长度不能超过 10
tag.tagNamestring标签名称,长度不能超过 15

移除标签

调用 removeTag 删除标签。

RongIMLib.removeTag('<标签Id>').then(({code}) => {
console.log(code)
});
参数类型必填说明
tagIdstring要移除的标签 ID

编辑标签

调用 updateTag 更新标签。

RongIMLib.updateTag({
tagId: '<标签Id>',
tagName: '<新的标签名字>'
}).then(({code}) => {
console.log(code)
});
参数类型必填说明
tagITagParam要编辑的标签
tag.tagIdstring标签 ID,长度不能超过 10
tag.tagNamestring标签名称,长度不能超过 15

获取标签列表

调用 getTags 获取标签列表。

RongIMLib.getTags().then(({code, data}) => {
console.log(code, data)
});