自定义推送规则

多端登录场景下，如果用户希望当某些平台的账号在线时，部分其他平台上的账号不收到离线推送通知，可以通过自定义推送规则实现。

前提条件

在实现“自定义推送规则”功能之前，请确保：

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

• 已实现 多端登录。

实现流程

用户离线推送规则变化通知

如需在用户自定义规则时收到通知，请注册 userRuleUpdated 事件实现。

// 监听用户自定义规则
zim.on('userRuleUpdated', (zim, data) => {
    // 离线推送规则
    const offlinePushRule = data.userRule.offlinePushRule;
});

设置离线推送规则

如需支持用户自定义推送规则时，开发者需要构造 ZIMUserOfflinePushRule 类型参数，规定用户在哪些平台上在线（onlinePlatforms）时，哪些平台无需接收离线推送（notToReceiveOfflinePushPlatforms）。

调用 updateUserOfflinePushRule 接口，设置上述规则。

// 设置离线推送规则

var offlinePushRule = {
    // 当用户 Win、MacOS、Linux 平台登录时
    onlinePlatforms: [1, 4, 5],
    // 用户在 iPhoneOS、iPadOS、Android 上不收到离线推送
    notToReceiveOfflinePushPlatforms: [2, 3, 9],
};

zim.updateUserOfflinePushRule(offlinePushRule)
    .then((res) => {
        // success
    })
    .catch((err) => {
        // error
    });

查询用户定义的推送规则

通过调用 querySelfUserInfo 即可获取当前用户自定义的离线推送规则。

zim.querySelfUserInfo().then((res) => {
    const { offlinePushRule } = res.selfUserInfo.userRule;
});