文档中心
IM 即时通讯
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • 即时通讯
  • 消息相关
  • 插入本地消息

插入本地消息

更新时间:2024-01-05 21:28

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

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

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

前提条件

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

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

实现流程

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

调用接口示例

 virtual void insertMessageToLocalDB(std::shared_ptr<ZIMMessage> message,
                                     const std::string &conversationID,
                                     ZIMConversationType conversationType,
                                     const std::string &senderUserID,
                                     ZIMMessageInsertedCallback callback) = 0;

参数说明

参数 类型 是否必填 说明
message ZIMMessage 是 插入的消息内容。可以指定传入的消息类型(例如:文本消息,富媒体消息,系统消息等类型)。
conversationID std::string 是

插入消息的会话 ID。

  • 单聊时,conversationID 即是对方的 userID。
  • 房间时,conversationID 即是房间的 roomID。
  • 群组时,conversationID 即是群组的 groupID。
conversationType ZIMConversationType 是 会话类型。
senderUserID std::string 是 消息插入者的 userID。
callback ZIMMessageInsertedCallback 是 插入本地消息操作的结果回调。

示例代码

// 1、创建 ZIM 对象,传入 appID、appSign,目前仅建议一个客户端创建一个zim实例
zim::ZIMAppConfig app_config;
app_config.appID = 12345;     //替换为您申请到的 AppID
app_config.appSign = "appSign";   //替换为您申请到的 AppSign
zim_ = zim::ZIM::create(app_config);

// 2、设置 setEventHandler 回调
im_event_handler_ = std::make_shared<CZIMEventHandler>();
zim_->setEventHandler(im_event_handler_);

// 3、登录
zim::ZIMUserInfo user_info;
user_info.userID = user_id;
user_info.userName = user_name;

zim_->login(user_info, [=](zim::ZIMError errorInfo){
    // 这里可以获取登录结果返回值,并根据错误码执行用户代码
});

// 4、向本地数据库插入一条消息
// 这里演示的是插入一条自定义消息,开发者可以自行修改为插入其他类型的消息,信令消息不支持。
std::string conversationID="conversationID";
std::string sender_user_id = "sender_user_id";
zim::ZIMConversationType type = zim::ZIMConversationType::ZIM_CONVERSATION_TYPE_PEER;
int subType = 1;// 业务自己定义的系统消息类型,取值 [0,200]
auto customMessage = std::make_shared<zim::ZIMCustomMessage>("custom message",subType);
zim_->insertMessageToLocalDB(std::static_pointer_cast<zim::ZIMMessage>(customMessage),conversationID, type, sender_user_id,[=](const std::shared_ptr<zim::ZIMMessage> &message,const zim::ZIMError &errorInfo) { 
              // 开发者可以在这里监听插入消息的回调
            });
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈