ZIM 升级指南

本文介绍 ZIM uni-app SDK 版本升级时的一些说明和注意事项。

2.18.0 升级指南

注意

从 2.18.0 版本开始，以下接口有重大变更，因此在从旧版本升级到 2.18.0 版本时，请您阅读以下指南。

单聊消息接收回调

原单聊消息接收回调 receivePeerMessage 已被废弃，请使用 peerMessageReceived 代替。

新回调支持以下功能：

用户在线时，可通过此回调接收在线单聊消息。
用户重新登录 ZIM SDK 后，可以通过此回调接收离线期间（最长7天）收到的所有单聊消息。

Untitled

//新接口
peerMessageReceived: (zim: ZIM, data: ZIMEventOfConversationMessageReceivedResult) => void;

//老接口
receivePeerMessage: (zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult) => void;

Copied!

房间消息接收回调

原房间消息接收回调 receiveRoomMessage 已被废弃，请使用 roomMessageReceived 代替。

新回调支持以下功能：

用户在线时，可通过此回调接收在线房间消息。
用户从离线恢复到在线后，若仍在房间中，即可通过此回调接收离线期间内的所有房间消息。

Untitled

//新接口
roomMessageReceived: (zim: ZIM, data: ZIMEventOfConversationMessageReceivedResult) => void;

//老接口
receiveRoomMessage: (zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult) => void;

Copied!

群组消息接收回调

原群组消息接收回调 receiveGroupMessage 已被废弃，请使用 groupMessageReceived 代替。

新回调支持以下功能：

用户在线时，可通过此回调接收在线群组消息。
用户重新登录 ZIM SDK 后，可以通过通过此回调接收离线期间（最长7天）收到的所有群聊消息。

Untitled

//新接口
groupMessageReceived: (zim: ZIM, data: ZIMEventOfConversationMessageReceivedResult) => void;

    
//老接口
receiveGroupMessage: (zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult) => void;

Copied!

callCancel

说明

以下变更仅对进阶模式呼叫邀请而言。

在新版本的 callCancel 中，如果参数 userIDs 包含一个 userID，则该接口将仅取消邀请该被叫用户。如果 userIDs 参数为空，则该接口将对所有被叫用户取消邀请。

而对于旧版本的 callCancel 接口，无论参数 userIDs 是否为空，均视为对所有被叫用户取消邀请。

由于旧版 ZIM SDK 不兼容单独取消逻辑，因此如果您既需要保留使用老版本 ZIM 实现的取消逻辑，又需要使用新版本的单独取消功能，请隔离新老版本 ZIM 之间的呼叫功能。

新版本用法

旧版本用法

// 单独取消 userIdA 、userIdB
var callID = 'xxxx';
var invitees = ['userIdA','userIdB'];  // 被邀请人ID列表
var config = { extendedData: 'xxxx' }; 
zim.callCancel(invitees, callID, config)
    .then(res => {
        // 操作成功
    })
    .catch(err => {
        // 操作失败
    })

// 取消整个呼叫邀请,当整个呼叫中所有被叫都未接受时可以调用成功    
var callID = 'xxxx';
var invitees = [];  // 被邀请人ID列表
var config = { extendedData: 'xxxx' }; 
zim.callCancel(invitees, callID, config)
    .then(res => {
        // 操作成功
    })
    .catch(err => {
        // 操作失败
    })

Copied!

// 无论 userIDs 中是否传递 userID,均为取消整个呼叫，当整个呼叫中所有被叫都未接受时可以调用成功
var callID = 'xxxx';
var invitees = ['userIdA','userIdB'];  // 被邀请人ID列表
var config = { extendedData: 'xxxx' }; 
zim.callCancel(invitees, callID, config)
    .then(res => {
        // 操作成功
    })
    .catch(err => {
        // 操作失败
    })

// 取消整个呼叫邀请,当整个呼叫中所有被叫都未接受时可以调用成功    
var callID = 'xxxx';
var invitees = [];  // 被邀请人ID列表
var config = { extendedData: 'xxxx' }; 
zim.callCancel(invitees, callID, config)
    .then(res => {
        // 操作成功
    })
    .catch(err => {
        // 操作失败
    })

Copied!