插入本地消息

---

功能简介

ZIM SDK 支持向单聊、群组和房间会话插入本地消息，插入的消息只会存在于设备本地，不会发送给其他用户、不会同步到其它设备；并且在卸载客户端应用后，该消息不会留存。

开发者可使用此功能，向本地数据库插入一条消息，用于展示系统提示。例如：加入群组提示、离开群组等无需跨终端发送给其他用户的本地提示。

前提条件

在实现“插入本地消息”功能之前，请确保：

• 已在 ZEGO 控制台 创建项目，获取到了接入 ZIM SDK 服务所需的 AppID、AppSign。ZIM 服务权限不是默认开启的，使用前，请先在 ZEGO 控制台 自助开通 ZIM 服务（详情请参考控制台的 服务配置 - 即时通讯 - 开通服务），若无法开通 ZIM 服务，请联系 ZEGO 技术支持开通。
• 已集成 ZIM SDK，详情请参考 快速开始 - 实现基本收发消息 的 “2 集成 SDK”。

使用步骤

开发者需要调用 insertMessageToLocalDB 接口，传入构造好的 ZIMMessage 消息、会话 conversationID、会话类型 conversationType、消息插入者 senderUserID 等参数，即可向本地数据库里插入一条消息。

调用接口示例

Future<ZIMMessageInsertedResult> insertMessageToLocalDB(
    ZIMMessage message,
    String conversationID,
    ZIMConversationType conversationType,
    String senderUserID);

参数说明

插入成功后，可以通过 ZIMMessageInsertedResult 类型的异步返回值，获取操作结果。

示例代码

// 1、创建 ZIM 对象，传入 appID、appSign .
ZIMAppConfig appConfig = ZIMAppConfig();
appConfig.appID = 12345;  //替换为您申请到的 AppID
appConfig.appSign = "appSign";   //替换为您申请到的 AppSign
zim = ZIM.create(appConfig);

// 2、登录
try{
    ZIMLoginConfig loginConfig = ZIMLoginConfig();
    //该用户的用户昵称，不填写代表不修改用户昵称
    loginConfig.userName = 'userName';
    //若使用 token 作为登录鉴权的方式，请填写该参数，否则无需填写
    loginConfig.token = '';
    // 本次登录是否为离线登录，详情请参考离线登录相关文档
    loginConfig.isOfflineLogin = false;
    await ZIM.getInstance()?.login('zego', loginConfig);
    // 登录成功，编写登录成功的业务逻辑
} on PlatformException catch(onError){
    // 登录失败
    //登录失败的错误码，请参考接入文档的错误码表来处理
    onError.code;
    //登录失败的错误信息
    onError.message;
}

// 3、向本地数据库插入一条消息
// 这里演示的是插入一条自定义消息，开发者可以自行修改为插入其他类型的消息，信令消息不支持。
String message = "custom";
int subType = 1;// 业务自己定义的系统消息类型，取值为 [0,200]
ZIMCustomMessage customMessage = new ZIMCustomMessage(message,subType);
String conversationID ="conversationID";
String senderUserID = "senderUserID";
ZIMConversationType type = ZIMConversationType.PEER;
zim
    .insertMessageToLocalDB(message, conversationID, type, senderUserID)
    .then((value) => {

})
    .catchError((onError) {

});