多端登录

---

功能简介

ZIM SDK 支持配置自定义多端登录，即用户同一个账号可在多个平台上同时登录，满足用户的会话、消息、群组等数据互通。

常见的登录策略

多端登录可支持在 Windows、Mac、Linux、Android、iOS、iPad、Web、小程序等八个平台上配置，其中支持在 Windows、Mac、Linux、Android、iOS、iPad 平台配置多设备登录，对于上述任一平台而言，一个账号在同一时间只能在最多两台设备上进行登录。在 Web 平台配置多实例登录，最多不超过 5 个登录实例。

以下为 ZIM SDK 支持的三种登录策略，即单平台登录、双平台登录以及多平台登录：

前提条件

在实现“多端登录”功能之前，请确保：

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

实现流程

联系 ZEGO 技术支持，开通多端登录服务，配置多端登录之后，即可在多端调用 login 登录 ZIM SDK，实现流程与单端登录无异。如何登录，详情请参考 实现基本消息收发 的“登录 ZIM“。

当登录设备已达到策略规定的上限时，如果在新设备登录帐号，原设备中最早登录的帐号会被踢下线，并通过 connectionStateChanged 回调得知 event 为 KickedOut 。例如：登录策略规定最多只能在 3 台设备上登录，已在设备 A、B、C（按登录时间排序）登录，如果在设备 D 上登录帐号，则设备 A 上的帐号会被踢下线。

当帐号被踢下线后，建议调用 logout 接口登出 ZIM 服务，用户界面切换为登录界面。

多端登录对其他功能的影响

配置多端登录后，以下功能的代码也需要做相应调整。

用户信息管理

ZIM SDK 为多端登录用户提供了用户信息同步的功能。当用户在一端通过 updateUserName、updateUserAvatarUrl、updateUserExtendedData 接口更新了自己的信息后，其他在线客户端可通过注册 userInfoUpdated 事件监听用户信息被修改。

userInfoUpdated 处理示例

zim.on('userInfoUpdated', (zim, { info }) => {
    console.log(info.baseInfo.userName, info.userAvatarUrl, info.extendedData);
});

会话管理

删除单个服务端会话

当用户在一端通过 deleteConversation 接口删除服务端会话后（即 isAlsoDeleteServerConversation 为 true），其他在线客户端可通过注册 conversationChanged 事件监听会话被删除。

conversationChanged 示例

zim.on('conversationChanged', (zim, { infoList }) => {
    infoList.forEach((info) => {
        if (info.event == 3) {
            // 会话被删除
        }
    });
});

删除全部服务端会话

当用户在一端通过 deleteAllConversations 接口删除全部服务端会话后（即 isAlsoDeleteServerConversation 为 true），其他客户端可通过 conversationsAllDeleted 事件监听全部会话被删除。

conversationsAllDeleted 处理示例

zim.on('conversationsAllDeleted', (zim, { count }) => {
    console.log('被删除的会话数量', count);
});

清除全部会话未读

当用户在一端通过 clearConversationTotalUnreadMessageCount 清除全部会话未读时，其他客户端可通过 conversationTotalUnreadMessageCountUpdated 事件监听所有会话的未读都被清零的通知。

conversationTotalUnreadMessageCountUpdated 处理示例

zim.on('conversationTotalUnreadMessageCountUpdated', (zim, { totalUnreadMessageCount }) => {
    //其他端清除全部会话未读后，本端该通知 totalUnreadMessageCount 的值将为 0    
});

消息管理

消息同步

当用户登录新设备后，SDK 不会自动将旧设备中的已有消息同步到新设备上，用户需要主动调用 queryHistoryMessage 接口，才能获取存储于 ZIM 服务端的消息，详情请参考 获取历史消息。对于存储于旧设备的本地消息，则无法获取。

删除服务端消息

当用户在一端通过 deleteMessages、deleteAllMessage、deleteAllConversationMessages 接口删除会话的服务端消息后（即 isAlsoDeleteServerMessage 为 true），其他在线客户端可通过注册 messageDeleted 事件监听消息被删除。

调用接口示例

zim.on('messageDeleted', (zim, { conversationID, conversationType, isDeleteConversationAllMessage, messageList, messageDeleteType }) => {
    if (messageDeleteType == 2 ) {
        // 所有会话的消息被删除
    } else if (messageDeleteType == 1 ) {
        // 会话当前所有消息被删除
    } else if (messageDeleteType == 0) {
        // 会话指定消息被删除
    } 
});

设置消息回执已读

当用户在一端通过 sendMessageReceiptsRead、sendConversationMessageReceiptRead 接口设置消息回执已读后，其他在线客户端可通过注册 messageReceiptChanged、conversationMessageReceiptChanged 事件监听本帐号已设置消息回执为已读。

调用接口示例

zim.on('messageReceiptChanged', (zim, { infos }) => {
    infos.forEach((info) => {
        if (info.isSelfOperated) {
            // 用户自己设置的消息回执已读
        }
    });
});

zim.on('conversationMessageReceiptChanged', (zim, { infos }) => {
    infos.forEach((info) => {
        if (info.isSelfOperated) {
            // 用户自己设置的会话回执已读
        }
    });
});

房间管理

房间模块相关接口和事件不支持多端登录。用户在 A 设备加入房间后，然后在 B 设备再加入相同的房间后，会把 A 设备踢出房间，A 设备会通过 roomStateChanged 回调收到 event 为 KickedOutByOtherDevice。

// 用户在 A 设备加入房间后，然后在 B 设备再加入相同的房间后，会把 A 设备踢出房间
zim.on('roomStateChanged', (zim, { roomID, state, event }) => {
    if (state == 0 && event == 10) {
        // 多端登录加入房间，被踢出房间
    }
});

群组管理

在开通多端登录服务后，ZIM SDK 会自动在多端设备之间同步群组相关数据。

呼叫邀请管理

当用户同时登录设备 A 和 B，用户收到呼叫邀请，在设备 A 上接受邀请（调用 callAccept）或者拒绝邀请（调用 callReject) 后：

1. 设备 A 可以通过相关操作的回调（ZIMCallAcceptanceSentResult 或 ZIMCallRejectionSentResult） 得知操作结果，关闭邀请弹窗，实现其他业务操作；
2. 设备 B 应当通过 callUserStateChanged 回调，得知本用户的呼叫用户状态（ZIMCallUserState）是 Accepted 还是 Rejected，关闭邀请弹窗，实现其他业务操作

各个设备能收到该呼叫内的用户状态变更事件 callUserStateChanged 如下表所示：

调用接口示例

var selfUserID = '';
var curCallID = '';

// 设备 A 接受邀请
zim.callAccept(curCallID, { extendedData: '设备 A 接受邀请' }).then((res) => {
    // 关闭呼叫等待操作的弹框。开始推拉流，进行音视频通话。
});
// 设备 A 拒绝邀请
zim.callReject(curCallID, { extendedData: '设备 A 拒绝邀请' }).then((res) => {
    // 关闭呼叫等待操作的弹框，呼叫结束。
});

// 设备 B 监听 callUserStateChanged
zim.on('callUserStateChanged', (zim, { callID, callUserList }) => {
    if (curCallID == callID) {
        callUserList.forEach((item) => {
            if (item.userID == selfUserID && (item.state == 1 || item.state == 2)) {
                // 设备 A 已经接受或者拒绝时，关闭呼叫等待操作的弹框
            }
        });
    }
});