Zego ZIM 即时通讯原生插件(JS 封装层) - 更新日志

2.15.0(2024-04-29)

详情:https://doc-zh.zego.im/article/15340

2.14.1(2024-03-15)

修复已知问题;

2.14.0(2024-03-06)

详情:https://doc-zh.zego.im/article/15340

2.12.0(2023-12-01)

详情:https://doc-zh.zego.im/article/15340

2.11.0(2023-11-02)

详情:https://doc-zh.zego.im/article/11594

2.10.1(2023-10-23)

修复已知问题;

2.10.0(2023-09-14)

详情:https://doc-zh.zego.im/article/11594

2.9.0(2023-07-26)

新增功能

功能项 功能描述 相关接口
呼叫邀请新增模式 新增进阶模式,支持用户在呼叫中邀请、退出呼叫和结束呼叫。
  • [callingInvite\|_blank](@callingInvite)</li">ul><li>[callingInvite\|_blank](@callingInvite)</li[callQuit\|_blank](@callQuit)</li">li>[callQuit\|_blank](@callQuit)</li[callEnd\|_blank](@callEnd)</li">li>[callEnd\|_blank](@callEnd)</li
  • 撤回他人消息 群组会话中,群主可以撤回他人发送的消息。 revokeMessage|_blank
    获取房间成员信息 支持调用服务端接口,根据房间 ID 获取房间成员的信息,包括房间用户数量、用户 ID 及名称。 获取房间成员信息|_blank
    服务端消息发送接口新增支持更多消息类型 支持通过服务端接口发送图片、文件、音频、视频、自定义和弹幕类型消息,详情请参考 MessageBody 说明|_blank
    设置消息拓展字段 新增仅本端可见的消息拓展字段,支持更新该字段,可用于展示消息翻译状态或其他内容。
  • [localExtendedData\|_blank](@localExtendedData-ZIMMessage)</li">ul><li>[localExtendedData\|_blank](@localExtendedData-ZIMMessage)</li[updateMessageLocalExtendedData\|_blank](@updateMessageLocalExtendedData)</li">li>[updateMessageLocalExtendedData\|_blank](@updateMessageLocalExtendedData)</li
  • 改进优化

    优化项 优化描述 相关接口
    呼叫邀请接收回调 优化呼叫邀请普通模式,支持在呼叫邀请的超时时间内,离线用户收到呼叫邀请在上线后能够立即被通知。 callUserStateChanged|_blank

    废弃删除

    废弃接口 废弃说明 废弃版本
  • [callInvitationAccepted\|_blank](@callInvitationAccepted)</li">ul><li>[callInvitationAccepted\|_blank](@callInvitationAccepted)</li[callInvitationRejected\|_blank](@callInvitationRejected)</li">li>[callInvitationRejected\|_blank](@callInvitationRejected)</li[callInviteesAnsweredTimeout\|_blank](@callInviteesAnsweredTimeout)</li">li>[callInviteesAnsweredTimeout\|_blank](@callInviteesAnsweredTimeout)</li
  • 为便利开发者监听呼叫邀请中用户的呼叫状态变化,新增 callUserStateChanged|_blank,替代原呼叫邀请回调 callInvitationAcceptedcallInvitationRejectedcallInviteesAnsweredTimeout 2.9.0

    2.8.1(2023-06-08)

    修复已知问题;

    2.8.0(2023-06-01)

    2.8.0 版本

    新增功能

    功能项 功能描述 相关接口
    置顶会话 用户可以选择想要优先查看的会话,将其固定在会话列表顶部。
  • [updateConversationPinnedState\|_blank](@updateConversationPinnedState)</li">ul><li>[updateConversationPinnedState\|_blank](@updateConversationPinnedState)</li[queryConversationPinnedList\|_blank](@queryConversationPinnedList)</li">li>[queryConversationPinnedList\|_blank](@queryConversationPinnedList)</li
  • 自定义消息类型 新增自定义类型消息,开发者可自定义消息的类型,如投票类型、接龙类型、视频卡片类型等,并自行完成消息的解析。ZIM SDK 不负责定义和解析自定义消息的具体内容。 ZIMCustomMessage|_blank
    查询会话信息 通过指定会话 ID 查询会话的详细信息。 queryConversation|_blank
    查询房间内用户状态 通过指定若干 userID 和 roomID,查询目标用户是否在指定房间内,从而进行业务逻辑设计,如邀请连麦。

    最多支持一次性查询 10 名用户的信息。

    queryRoomMembers|_blank
    消息发送前回调 通过设置服务端回调,在用户发送单聊、群聊或房间聊天消息时,ZIM 向开发者服务端发送请求,开发者可实现:
    • 拦截违规消息。
    • 建立用户黑白名单。
    消息发送前回调|_blank
    消息发送后回调 通过设置服务端回调,在用户发送单聊、群聊、房间消息成功或失败后,ZIM 向开发者服务端发送请求,开发者可实现:
    • 实时记录用户发送的消息。
    • 统计用户发送的消息。
    • 直播录屏场景中,通过录制视频的时间戳,将聊天记录嵌入到录播视频中。
    消息发送后回调|_blank
    批量注册用户 支持调用服务端接口,指定用户信息(用户 ID 等),开发者可实现发起一次请求,注册多名用户。

    最多支持一次性注册 100 名用户。

    批量注册用户|_blank
    查询 App 下的群列表 支持调用服务端接口获取 App 中所有群组的 ID。 查询 App 下的群列表|_blank
    查询群成员列表 支持调用服务端接口,指定群组 ID,获取对应群组的成员列表。 查询群成员列表|_blank
    移除群成员 支持调用服务端接口,指定群组 ID 和用户 ID,批量群成员。

    最多支持一次性移除 50 名群成员。

    移除群成员|_blank

    废弃删除

    废弃项 废弃描述 相关接口
    废弃系统消息类型 ZIMMessageType|_blank 废弃了系统消息(值为 30),开发者请使用功能更完善的自定义消息(值为 200)替代。 ZIMMessageTypeCustom|_blank


    2.7.3(2023-03-27)

    修复调用 sendMessageReceiptsRead 报错问题。

    2.7.2(2023-03-21)

    问题修复:修复了枚举类型丢失问题;

    2.7.1(2023-03-17)

    问题修复:修复已知问题。

    2.7.0(2023-03-09)

    2.7.0 版本

    发布日期:2023-03-09

    改进优化

    优化项 优化描述 相关接口
    优化用户登录时 userName 置空逻辑 区分了用户名修改接口和登录接口。用户登录时,若将 userName 置空,不再会因此修改 userName,优化用户登录体验。 userName|_blank
    优化会话消息拉取时机 SDK 会智能检测当前用户的会话活跃情况,优化数据同步的时机,提升用户查询速度与体验。 -
    优化断网重连时机 当 APP 断网后,SDK 会实时检测网络状态变化以及 APP 前后台变化,加快用户重连速度。 -

    2.6.0(2023-01-13)

    2.6.0 版本

    发布日期:2023-01-13

    新增功能

    功能项 功能描述 相关接口
    服务端新增呼叫邀请相关回调 用户可以通过 ZIM 服务端的回调,明确呼叫邀请的结果,适用于网络环境不好时,SDK 反馈的结果不稳定。
    消息体增加扩展字段 ZIMMessage|_blank 增加 extendedData|_blank 字段,用户可以将用户头像和昵称等信息传入该字段,在聊天对话发送消息时实时展示。 extendedData|_blank
    新增发送消息状态回调 开发者可以通过监听此回调来完善消息发送状态的逻辑。根据消息状态的变更,开发者可以在 UI 上做相应提醒等。 messageSentStatusChanged|_blank

    改进优化

    优化项 优化描述 相关接口
    优化弱网情况下消息发送的逻辑 用户在弱网环境下发送消息时,SDK 会通过策略逻辑尽可能保证消息发送状态的正确性。 -

    2.5.0(2022-12-06)

    2.5.0 版本

    发布日期:2022-12-06

    新增功能

    功能项 功能描述 相关接口
    消息撤回 撤回发送成功的消息,默认撤回 2 分钟内的消息。撤回操作仅支持撤回单聊和群聊的消息,不支持撤回房间内消息。

    如需配置撤回时间,请联系 ZEGO 技术支持。

  • [revokeMessage\|_blank](@revokeMessage)</li">ul><li>[revokeMessage\|_blank](@revokeMessage)</li[messageRevokeReceived\|_blank](@messageRevokeReceived)</li">li>[messageRevokeReceived\|_blank](@messageRevokeReceived)</li
  • 消息回执 ZIMMessageSendConfig|_blank 新增 hasReceipt 参数,支持在单聊和群聊会话中发送附带回执的消息。
    ZIM SDK 支持在单聊和群聊会话查看其他用户是否阅读本端发送的信息,以及支持查看群聊中已读消息和未读消息的数量,以及对应的用户信息,但是不支持信令消息、弹幕消息、以及房间内消息使用回执。
  • [ZIMMessageSendConfig\|_blank](@-ZIMMessageSendConfig)</li">ul><li>[ZIMMessageSendConfig\|_blank](@-ZIMMessageSendConfig)</li[sendMessageReceiptsRead\|_blank](@sendMessageReceiptsRead)</li">li>[sendMessageReceiptsRead\|_blank](@sendMessageReceiptsRead)</li[sendConversationMessageReceiptRead\|_blank](@sendConversationMessageReceiptRead)</li">li>[sendConversationMessageReceiptRead\|_blank](@sendConversationMessageReceiptRead)</li[queryGroupMessageReceiptReadMemberList\|_blank](@queryGroupMessageReceiptReadMemberList)</li">li>[queryGroupMessageReceiptReadMemberList\|_blank](@queryGroupMessageReceiptReadMemberList)</li[queryGroupMessageReceiptUnreadMemberList\|_blank](@queryGroupMessageReceiptUnreadMemberList)</li">li>[queryGroupMessageReceiptUnreadMemberList\|_blank](@queryGroupMessageReceiptUnreadMemberList)</li[queryMessageReceiptsInfo\|_blank](@queryMessageReceiptsInfo)</li">li>[queryMessageReceiptsInfo\|_blank](@queryMessageReceiptsInfo)</li
  • 改进优化

    优化项 优化描述 相关接口
    变更 ZIMPushConfig|_blank 的额外字段命名 为避免开发者接入概念混淆,ZIMPushConfig|_blank 的 extendedData 参数修改为 payload 参数,功能不变。 -

    2.4.0(2022-10-20)

    2.4.0 版本

    发布日期:2022-10-20

    新增功能

    功能项 功能描述 相关接口
    管理房间用户属性 支持房间内的用户自定义用户属性。例如:用户等级、勋章、状态等信息。
  • [setRoomMembersAttributes\|_blank](@setRoomMembersAttributes)</li">ul><li>[setRoomMembersAttributes\|_blank](@setRoomMembersAttributes)</li[queryRoomMembersAttributes\|_blank](@queryRoomMembersAttributes)</li">li>[queryRoomMembersAttributes\|_blank](@queryRoomMembersAttributes)</li[queryRoomMemberAttributesList\|_blank](@queryRoomMemberAttributesList)</li">li>[queryRoomMemberAttributesList\|_blank](@queryRoomMemberAttributesList)</li
  • 新增系统消息 新增系统消息类型,支持 SDK 触发进群通知、群主替换等系统性消息。可以通过 插入本地消息|_blank 功能实现。 -
    插入本地消息 支持直接向本地插入一条任意消息类型的消息。开发者可结合系统消息类型,在客户端将回调通知(例如:邀请某人进群、把某人移出群等),转为系统消息类型,插入本地 DB,以达到系统提示的效果。 insertMessageToLocalDB|_blank

    改进优化

    优化项 优化描述 相关接口
    优化消息发送接口 优化消息对象,在发送前和发送后是同一个对象。开发者在发送“视频”等内容较大的消息时,可以在消息上传完成前,缓存该消息对象,直到收到 SDK 发送成功通知时,通过比较对象相同来实现发送前 Loading 的效果。 sendMessage|_blank
    优化断网重连逻辑 优化在无网状态下、以及断网重连后的逻辑。 -
    优化性能 优化数据库性能。 -

    接口变更

    • 新增接口
    新增接口 接口描述 上线版本
    sendMessage|_blank 新增发送消息接口,支持发送单聊、房间、群组消息。 2.4.0
    sendMediaMessage|_blank 新增富媒体消息发送接口 sendMediaMessage|_blank(同名重载),支持获取媒体上传前的信息,可发送文件、图片、音频、视频等富媒体信息。 2.4.0
    • 废弃接口
    废弃接口 变更说明 废弃版本
  • [sendPeerMessage\|_blank](@sendPeerMessage)</li">ul><li>[sendPeerMessage\|_blank](@sendPeerMessage)</li[sendRoomMessage\|_blank](@sendRoomMessage)</li">li>[sendRoomMessage\|_blank](@sendRoomMessage)</li[sendGroupMessage\|_blank](@sendGroupMessage)</li">li>[sendGroupMessage\|_blank](@sendGroupMessage)</li
  • 废弃单聊消息 sendPeerMessage|_blank、房间消息 sendRoomMessage|_blank、群组消息 sendGroupMessage|_blank 3 个消息发送接口,统一使用 sendMessage|_blank 接口替代,发送消息方式更加规范。 2.4.0
    sendMediaMessage|_blank 原有的发送富媒体消息 sendMediaMessage|_blank 接口废弃,替换为同名的 sendMediaMessage|_blank 接口,接口参数不同,请注意切换使用。 2.4.0

    2.3.3(2022-09-15)

    1、新增 AppSign 与 Token 鉴权切换的兼容; 2、修复其他已知问题。

    2.3.0(2022-08-30)

    1、新增用户头像、群头像的设置,以及会话列表的会话头像获取; 2、发送图片消息成功后,能够获取到原图、大图以及缩略图的宽高,便于 UI 层的展示; 3、SDK 性能优化。

    2.2.0(2022-07-28)

    1、新增设置、查询用户扩展字段功能 2、富媒体消息上传成功后,后台会相应下发其 DownloadURL 供开发者直接使用

    2.1.6(2022-06-29)

    更新 JS 封装层至 2.1.6 版本,与 Native 原生插件对齐。

    0.0.2(2022-06-28)

    更新 JS SDK 包体结构

    0.0.1(2022-06-28)

    ZIM uni-app JS 封装层首次发布!