setLocalCustomData
功能介绍
设置消息自定义数据
本地保存,不会发送到对端,程序卸载重装后失效
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
messageID | string | 是 | 需要设置的消息id |
localCustomData | string | 是 | 需要设置的自定义属性 |
返回模板
V2TimCallback
{
code : number
desc : string
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | number | 请求结果错误码 |
desc | string | 请求结果描述 |
代码示例
// 设置消息自定义数据
import { TencentImSDKPlugin } from 'react-native-tim-js';
// 设置之后此消息会多出一个localCustomData属性,用户可以读取此属性来获取设置的自定义属性
const setLocalCustomDataRes = await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.setLocalCustomData(
'msgID', // 需要设置的消息id messageId为消息发送后服务端创建的messageid,不是创建消息时的消息id
'localCustomData'
); // 需要设置的自定义属性
if (setLocalCustomDataRes.code === 0) {
//设置成功
}