浏览 SDKs · React Native
平台
SDKsReact Native

设置消息本地扩展

OpenIM React Native SDK 设置消息本地扩展。

复制

为当前设备中的指定消息保存自定义本地扩展数据。此扩展字段仅在当前客户端本地数据库中维护,不会上传至服务端或同步到其他设备,常用于记录本地播放状态、草稿关联或 UI 展开折叠状态。

await OpenIMSDK.setMessageLocalEx({
  conversationID,
  clientMsgID,
  localEx: JSON.stringify({ isPlaying: false, isExpanded: true }),
});

参数说明

参数类型必填含义
conversationIDstring是消息所属的会话 ID。
clientMsgIDstring是目标消息的客户端 ID。
localExstring是本地扩展字符串,建议传递 JSON 序列化后的字符串以便组织复杂结构。

返回结果

调用成功代表自定义扩展内容已写入本地数据库。客户端应以 clientMsgID 为合并标识更新本地消息列表中对应消息的 localEx 字段,以即时刷新相关 UI 状态。