浏览 SDKs · Android
平台
SDKsAndroid

设置消息本地扩展

为指定消息保存仅当前设备本地可见的自定义扩展字段。

复制

为当前设备上的指定消息保存专属本地扩展数据(localEx)。适用于记录本地下载进度、音视频播放断点、语音转文字展示缓存等设备独有状态,不会漫游同步到服务端或其他端。

String conversationID = "si_user_a_user_b";
String clientMsgID = "msg_001";
String localExJson = "{\"downloadStatus\":2,\"localPath\":\"/storage/emulated/0/...\"}";

OpenIMClient.getInstance().messageManager.setMessageLocalEx(
    new OnBase<String>() {
        @Override
        public void onSuccess(String data) {
            // 本地扩展保存成功
        }

        @Override
        public void onError(int code, String error) {
            // 处理保存失败
        }
    },
    conversationID,
    clientMsgID,
    localExJson
);

参数说明

参数类型是否必填说明
baseOnBase<String>是异步请求回调。
conversationIDString是目标消息所属的会话 ID。
clientMsgIDString是目标消息的客户端消息 ID。
localExString是待保存的本地扩展数据字符串(如 JSON 格式)。

返回结果

成功回调中的 data 返回确认信息。

该操作为纯本地属性保存,不修改消息正文,也不会向其他端广播事件。客户端应以 clientMsgID 为标识更新本地内存中对应消息的 localEx 属性并刷新 UI。