logo
当前页

插入本地消息


功能简介

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

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

说明
  • 如需向房间会话插入本地消息,请使用 2.13.0 及以上版本 ZIM SDK。
  • ZIM SDK 不支持插入信令消息。

使用步骤

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

示例代码
// 1、创建 ZIM 对象,传入 appID、appSign 与 Android 中的 Application
ZIMAppConfig appConfig = new ZIMAppConfig();
appConfig.appID = 12345;  //替换为您申请到的 AppID
appConfig.appSign = "appSign";   //替换为您申请到的 AppSign
zim = ZIM.create(appConfig, application);

// 2、登录
ZIMUserInfo zimUserInfo = new ZIMUserInfo();
zimUserInfo.userID = "xxxx";
zimUserInfo.userName = "xxxx";
zim.login(zimUserInfo, new ZIMLoggedInCallback() {
    @Override
    public void onLoggedIn(ZIMError error) {
          // 开发者可根据 ZIMError 来判断是否登录成功。          
    }
 });

// 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(customMessage, conversationID, type, senderUserID, new ZIMMessageInsertedCallback() {
    @Override
    public void onMessageInserted(ZIMMessage message, ZIMError errorInfo) {
        // 开发者可以通过这个回调监听是否插入消息成功
    }
});
1
Copied!

Previous

删除消息

Next

转发消息