即时通讯
当前页

自定义推送规则

2026-11-06

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

前提条件

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

实现流程

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

如需用户自定义规则时收到通知,请监听 userRuleUpdated 回调。

// 监听用户自定义规则
- (void)zim:(ZIM *)zim userRuleUpdated:(ZIMUserRule *)userRule{
    // 离线推送规则
    userRule.offlinePushRule;
}

设置离线推送规则

如需支持用户自定义推送规则时,开发者需要构造 ZIMUserOfflinePushRule,规定用户在哪些平台上在线(onlinePlatforms)时,哪些平台无需接收离线推送(notToReceiveOfflinePushPlatforms)。

自 3.3.0 版本起,ZIMUserOfflinePushRule 新增以下字段:

字段说明
offlinePushEnabled离线推送总开关,默认开启。关闭后,消息和呼叫的离线推送均不下发。
messageOfflinePushEnabled消息离线推送开关,默认开启。仅影响消息离线推送,不影响呼叫离线推送。
callOfflinePushEnabled呼叫离线推送开关,默认开启。仅影响呼叫离线推送,不影响消息离线推送。
doNotDisturbRule免打扰时间规则,规则生效期间,消息和呼叫的离线推送均不下发。详细请参考 设置免打扰时间规则。

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

// 构造 ZIMUserOfflinePushRule
ZIMUserOfflinePushRule *offlineRule = [[ZIMUserOfflinePushRule alloc] init];
// 当用户 win、MacOS、Linux 平台登录时
offlineRule.onlinePlatforms = @[@(ZIMPlatformTypeWin),@(ZIMPlatformTypeMacOS),@(ZIMPlatformTypeLinux)];
// 用户在 iPhoneOS、iPadOS、Android 上不收到离线推送
offlineRule.notToReceiveOfflinePushPlatforms = @[@(ZIMPlatformTypeIPhoneOS),@(ZIMPlatformTypeIPadOS),@(ZIMPlatformTypeAndroid)];

// 离线推送总开关,默认开启(自 3.3.0 版本起支持)
offlineRule.offlinePushEnabled = YES;
// 消息离线推送开关,仅影响消息离线推送,默认开启(自 3.3.0 版本起支持)
offlineRule.messageOfflinePushEnabled = YES;
// 呼叫离线推送开关,仅影响呼叫离线推送,默认开启(自 3.3.0 版本起支持)
offlineRule.callOfflinePushEnabled = YES;

[[ZIM getInstance] updateUserOfflinePushRule:offlineRule callback:^(ZIMUserOfflinePushRule * _Nonnull offlinePushRule, ZIMError * _Nonnull errorInfo) {
}];

设置免打扰时间规则

自 3.3.0 版本起,ZIMUserOfflinePushRule 支持通过 doNotDisturbRule 字段设置免打扰时间规则。规则生效期间,消息和呼叫的离线推送均不下发。

说明

调用 updateUserOfflinePushRule 接口时,离线推送规则会按传入对象的成员属性全量更新。如需修改免打扰时间规则等单个配置项,请先调用 querySelfUserInfo 查询当前完整的离线推送规则,修改后再全量提交,避免覆盖其他已有配置。

ZIMUserOfflinePushDoNotDisturbRule 字段说明如下:

字段说明
enabled是否启用免打扰规则。
startHour / startMinute免打扰时段的开始时间,小时取值范围 [0, 23],分钟取值范围 [0, 59]。
endHour / endMinute免打扰时段的结束时间,小时取值范围 [0, 23],分钟取值范围 [0, 59]。结束时间早于开始时间时,表示时段跨过零点,例如 22:00 至次日 08:00。
repeatMode重复模式:
  • None(1):不重复,规则仅在保存当天生效。
  • Daily(2):每天重复。
  • Custom(3):自定义重复日,配合 customRepeatDays 使用。
默认为 Unknown(未设置),SDK 会向服务端上报 0,规则仅在保存当天生效(不重复)。
customRepeatDays自定义重复日,位掩码格式,bit0 表示周一,bit6 表示周日。仅在 repeatMode 为 Custom 时生效。
onceEndTimestamp当 repeatMode 为 None 时,仅生效一次的免打扰时段结束的 UNIX 时间戳(秒),由服务端在保存规则时记录。只读字段,更新规则时传入的值会被忽略,由服务端重新计算。
timeZoneID免打扰时段的 IANA 时区 ID,例如 "Asia/Shanghai"。空字符串表示未指定,服务端按 UTC 计算时段;非空时由服务端校验(非法 ID 返回错误码),并按该时区计算时段(感知夏令时)。如需跟随设备时区,请显式获取并传入本机 IANA 时区 ID。
// 先查询当前完整的离线推送规则
[[ZIM getInstance] querySelfUserInfo:^(ZIMSelfUserInfo * _Nonnull selfUserInfo, ZIMError * _Nonnull errorInfo) {
    if (errorInfo.code == ZIMErrorCodeSuccess) {
        ZIMUserOfflinePushRule *offlineRule = selfUserInfo.userRule.offlinePushRule;

        // 修改免打扰时间规则(自 3.3.0 版本起支持)
        ZIMUserOfflinePushDoNotDisturbRule *doNotDisturbRule = [[ZIMUserOfflinePushDoNotDisturbRule alloc] init];
        doNotDisturbRule.enabled = YES;
        // 免打扰时段:每天 22:00 至次日 08:00
        doNotDisturbRule.startHour = 22;
        doNotDisturbRule.startMinute = 0;
        doNotDisturbRule.endHour = 8;
        doNotDisturbRule.endMinute = 0;
        // 每天重复
        doNotDisturbRule.repeatMode = ZIMUserOfflinePushDoNotDisturbRepeatModeDaily;
        // 时区,建议显式传入本机 IANA 时区 ID
        doNotDisturbRule.timeZoneID = @"Asia/Shanghai";
        offlineRule.doNotDisturbRule = doNotDisturbRule;

        // 全量更新离线推送规则
        [[ZIM getInstance] updateUserOfflinePushRule:offlineRule callback:^(ZIMUserOfflinePushRule * _Nonnull offlinePushRule, ZIMError * _Nonnull errorInfo) {
        }];
    }
}];

查询用户定义的推送规则

通过调用 querySelfUserInfo,即可在回调中的 selfUserInfo.userRule.offlinePushRule 获取当前用户自定义的离线推送规则。

[[ZIM getInstance] querySelfUserInfo:^(ZIMSelfUserInfo * _Nonnull selfUserInfo, ZIMError * _Nonnull errorInfo) {
    selfUserInfo.userRule.offlinePushRule; // 当前用户定义的离线推送规则
}];

上一篇

resourcesID 说明

下一篇

在聊天页面中渲染对话消息

当前页

返回到顶部