插入本地消息

---

功能简介

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

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

前提条件

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

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

实现流程

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

调用接口示例

insertMessageToLocalDB(
    message: ZIMMessageBase | ZIMMediaMessageBase,
    conversationID: string,
    conversationType: ZIMConversationType,
    senderUserID: string,
): Promise<ZIMMessageInsertedResult> 

参数说明

示例代码

// 向本地数据库插入一条消息
// 这里演示的是插入一条文本消息，开发者可以自行修改为插入其他类型的消息，信令消息不支持。
const message = { type: 1, message: 'string' };
const conversationType = 0;
zim.insertMessageToLocalDB(
    message,
    'conversationID',
    conversationType,
    'senderUserID'
).then((res) => {
    // 开发者可以监听插入是否成功
});