自定义推送规则
2026-04-02
多端登录场景下，如果用户希望当某些平台的账号在线时，部分其他平台上的账号不收到离线推送通知，可以通过自定义推送规则实现。
前提条件
在实现“自定义推送规则”功能之前，请确保：
- 已实现 多端登录.
实现流程
用户离线推送规则变化通知
如需用户自定义规则时收到通知，请监听 userRuleUpdated 回调。
// 监听用户自定义规则
@Override
public void onUserRuleUpdated(ZIM zim, ZIMUserRule rule) {
// 离线推送规则
userRule.offlinePushRule;
}// 监听用户自定义规则
@Override
public void onUserRuleUpdated(ZIM zim, ZIMUserRule rule) {
// 离线推送规则
userRule.offlinePushRule;
}// 监听用户自定义规则
- (void)zim:(ZIM *)zim userRuleUpdated:(ZIMUserRule *)userRule{
// 离线推送规则
userRule.offlinePushRule;
}// 监听用户自定义规则
- (void)zim:(ZIM *)zim userRuleUpdated:(ZIMUserRule *)userRule{
// 离线推送规则
userRule.offlinePushRule;
}// 监听用户自定义规则
@Override
void onUserRuleUpdated(ZIM * /*zim*/, const ZIMUserRule & userRule) {
// 离线推送规则
userRule.offlinePushRule;
}// 监听用户自定义规则
@Override
void onUserRuleUpdated(ZIM * /*zim*/, const ZIMUserRule & userRule) {
// 离线推送规则
userRule.offlinePushRule;
}// 监听用户自定义规则
ZIMEventHandler.onUserRuleUpdated = (ZIM zim, ZIMUserRule userRule){
// 离线推送规则
userRule.offlinePushRule;
};// 监听用户自定义规则
ZIMEventHandler.onUserRuleUpdated = (ZIM zim, ZIMUserRule userRule){
// 离线推送规则
userRule.offlinePushRule;
};// 监听用户自定义规则
zim.on('userRuleUpdated', (zim: ZIM, data: ZIMEventOfUserRuleUpdatedResult) => {
// 离线推送规则
const offlinePushRule = data.userRule.offlinePushRule;
});// 监听用户自定义规则
zim.on('userRuleUpdated', (zim: ZIM, data: ZIMEventOfUserRuleUpdatedResult) => {
// 离线推送规则
const offlinePushRule = data.userRule.offlinePushRule;
});UTS 插件
// 监听用户自定义规则
zim.onUserRuleUpdated(data) => {
// 离线推送规则
const offlinePushRule = data.userRule.offlinePushRule;
});// 监听用户自定义规则
zim.onUserRuleUpdated(data) => {
// 离线推送规则
const offlinePushRule = data.userRule.offlinePushRule;
});设置离线推送规则
如需支持用户自定义推送规则时，开发者需要构造 ZIMUserOfflinePushRule，规定用户在哪些平台上在线（onlinePlatforms）时，哪些平台无需接收离线推送（notToReceiveOfflinePushPlatforms）。
调用 updateUserOfflinePushRule 接口，设置上述规则。
// 构造 ZIMUserOfflinePushRule
ArrayList<Integer> onlinePlatforms = new ArrayList<>();
// 当用户 win、MacOS、Linux 平台登录时
ArrayList<Integer> onlinePlatforms = new ArrayList<>();
onlinePlatforms.add(ZIMPlatformType.WIN.value());
onlinePlatforms.add(ZIMPlatformType.MAC_OS.value());
onlinePlatforms.add(ZIMPlatformType.LINUX.value());
offlineRule.setOnlinePlatforms(onlinePlatforms);
// 用户在 iPhoneOS、iPadOS、Android 上不收到离线推送
ArrayList<Integer> notToReceiveOfflinePushPlatforms = new ArrayList<>();
notToReceiveOfflinePushPlatforms.add(ZIMPlatformType.IPHONE_OS.value());
notToReceiveOfflinePushPlatforms.add(ZIMPlatformType.IPAD_OS.value());
notToReceiveOfflinePushPlatforms.add(ZIMPlatformType.ANDROID.value());
offlineRule.setNotToReceiveOfflinePushPlatforms(notToReceiveOfflinePushPlatforms);
// 调用 updateUserOfflinePushRule 方法
ZIM.getInstance().updateUserOfflinePushRule(offlineRule, new ZIMUserOfflinePushRuleUpdatedCallback() {
@Override
public void onUserOfflinePushRuleUpdated(ZIMUserOfflinePushRule updatedOfflinePushRule, ZIMError errorInfo) {
}
});// 构造 ZIMUserOfflinePushRule
ArrayList<Integer> onlinePlatforms = new ArrayList<>();
// 当用户 win、MacOS、Linux 平台登录时
ArrayList<Integer> onlinePlatforms = new ArrayList<>();
onlinePlatforms.add(ZIMPlatformType.WIN.value());
onlinePlatforms.add(ZIMPlatformType.MAC_OS.value());
onlinePlatforms.add(ZIMPlatformType.LINUX.value());
offlineRule.setOnlinePlatforms(onlinePlatforms);
// 用户在 iPhoneOS、iPadOS、Android 上不收到离线推送
ArrayList<Integer> notToReceiveOfflinePushPlatforms = new ArrayList<>();
notToReceiveOfflinePushPlatforms.add(ZIMPlatformType.IPHONE_OS.value());
notToReceiveOfflinePushPlatforms.add(ZIMPlatformType.IPAD_OS.value());
notToReceiveOfflinePushPlatforms.add(ZIMPlatformType.ANDROID.value());
offlineRule.setNotToReceiveOfflinePushPlatforms(notToReceiveOfflinePushPlatforms);
// 调用 updateUserOfflinePushRule 方法
ZIM.getInstance().updateUserOfflinePushRule(offlineRule, new ZIMUserOfflinePushRuleUpdatedCallback() {
@Override
public void onUserOfflinePushRuleUpdated(ZIMUserOfflinePushRule updatedOfflinePushRule, ZIMError errorInfo) {
}
});// 构造 ZIMUserOfflinePushRule
ZIMUserOfflinePushRule *offlineRule = [[ZIMUserOfflinePushRule alloc] init];
// 当用户 win、MacOS、Linux 平台登录时
offlineRule.onlinePlatforms = @[@(ZIMPlatformTypeWin),@(ZIMPlatformTypeMacOS),@(ZIMPlatformTypeLinux)];
// 用户在 iPhoneOS、iPadOS、Android 上不收到离线推送
offlineRule.notToReceiveOfflinePushPlatforms = @[@(ZIMPlatformTypeIPhoneOS),@(ZIMPlatformTypeIPadOS),@(ZIMPlatformTypeAndroid)];
[[ZIM getInstance] updateUserOfflinePushRule:offlineRule callback:^(ZIMUserOfflinePushRule * _Nonnull offlinePushRule, ZIMError * _Nonnull errorInfo) {
}];// 构造 ZIMUserOfflinePushRule
ZIMUserOfflinePushRule *offlineRule = [[ZIMUserOfflinePushRule alloc] init];
// 当用户 win、MacOS、Linux 平台登录时
offlineRule.onlinePlatforms = @[@(ZIMPlatformTypeWin),@(ZIMPlatformTypeMacOS),@(ZIMPlatformTypeLinux)];
// 用户在 iPhoneOS、iPadOS、Android 上不收到离线推送
offlineRule.notToReceiveOfflinePushPlatforms = @[@(ZIMPlatformTypeIPhoneOS),@(ZIMPlatformTypeIPadOS),@(ZIMPlatformTypeAndroid)];
[[ZIM getInstance] updateUserOfflinePushRule:offlineRule callback:^(ZIMUserOfflinePushRule * _Nonnull offlinePushRule, ZIMError * _Nonnull errorInfo) {
}];// 构造 ZIMUserOfflinePushRule
zim::ZIM::ZIMUserOfflinePushRule offlineRule;
// 当用户 win、MacOS、Linux 平台登录时
offlineRule.onlinePlatforms = {ZIM_PLATFORM_TYPE_WIN, ZIM_PLATFORM_TYPE_MACOS, ZIM_PLATFORM_TYPE_LINUX};
// 用户在 iPhoneOS、iPadOS、Android 上不收到离线推送
offlineRule.notToReceiveOfflinePushPlatforms = {ZIM_PLATFORM_TYPE_IPHONEOS, ZIM_PLATFORM_TYPE_IPADOS, ZIM_PLATFORM_TYPE_ANDROID};
// 调用 updateUserOfflinePushRule 方法
zim::ZIM::ZIM.getInstance()->updateUserOfflinePushRule(offlineRule, [](const zim::ZIM::ZIMUserOfflinePushRule& updatedOfflinePushRule, const zim::ZIM::ZIMError& errorInfo) {});// 构造 ZIMUserOfflinePushRule
zim::ZIM::ZIMUserOfflinePushRule offlineRule;
// 当用户 win、MacOS、Linux 平台登录时
offlineRule.onlinePlatforms = {ZIM_PLATFORM_TYPE_WIN, ZIM_PLATFORM_TYPE_MACOS, ZIM_PLATFORM_TYPE_LINUX};
// 用户在 iPhoneOS、iPadOS、Android 上不收到离线推送
offlineRule.notToReceiveOfflinePushPlatforms = {ZIM_PLATFORM_TYPE_IPHONEOS, ZIM_PLATFORM_TYPE_IPADOS, ZIM_PLATFORM_TYPE_ANDROID};
// 调用 updateUserOfflinePushRule 方法
zim::ZIM::ZIM.getInstance()->updateUserOfflinePushRule(offlineRule, [](const zim::ZIM::ZIMUserOfflinePushRule& updatedOfflinePushRule, const zim::ZIM::ZIMError& errorInfo) {});try{
ZIMUserOfflinePushRule rule = ZIMUserOfflinePushRule();
// 当用户 win、MacOS、Linux 平台登录时
rule.onlinePlatforms = [ZIMPlatformType.win,ZIMPlatformType.macOS, ZIMPlatformType.linux];
// 用户在 iPhoneOS、iPadOS、Android 上不收到离线推送
rule.notToReceiveOfflinePushPlatforms = [ZIMPlatformType.iPhoneOS, ZIMPlatformType.iPadOS, ZIMPlatformType.android];
// 调用 updateUserOfflinePushRule 方法
ZIMUserOfflinePushRuleUpdatedResult result = await ZIM.getInstance()!.updateUserOfflinePushRule(rule);
} on PlatformException catch (onError) {
onError.code;
onError.message;
}try{
ZIMUserOfflinePushRule rule = ZIMUserOfflinePushRule();
// 当用户 win、MacOS、Linux 平台登录时
rule.onlinePlatforms = [ZIMPlatformType.win,ZIMPlatformType.macOS, ZIMPlatformType.linux];
// 用户在 iPhoneOS、iPadOS、Android 上不收到离线推送
rule.notToReceiveOfflinePushPlatforms = [ZIMPlatformType.iPhoneOS, ZIMPlatformType.iPadOS, ZIMPlatformType.android];
// 调用 updateUserOfflinePushRule 方法
ZIMUserOfflinePushRuleUpdatedResult result = await ZIM.getInstance()!.updateUserOfflinePushRule(rule);
} on PlatformException catch (onError) {
onError.code;
onError.message;
}const offlinePushRule: ZIMUserOfflinePushRule = {
// 当用户 Win、MacOS、Linux 平台登录时
onlinePlatforms: [1, 4, 5],
// 用户在 iPhoneOS、iPadOS、Android 上不收到离线推送
notToReceiveOfflinePushPlatforms: [2, 3, 9],
};
zim.updateUserOfflinePushRule(offlinePushRule)
.then((res: ZIMUserOfflinePushRuleUpdatedResult) => {
// success
})
.catch((err: ZIMError) => {
// error
});const offlinePushRule: ZIMUserOfflinePushRule = {
// 当用户 Win、MacOS、Linux 平台登录时
onlinePlatforms: [1, 4, 5],
// 用户在 iPhoneOS、iPadOS、Android 上不收到离线推送
notToReceiveOfflinePushPlatforms: [2, 3, 9],
};
zim.updateUserOfflinePushRule(offlinePushRule)
.then((res: ZIMUserOfflinePushRuleUpdatedResult) => {
// success
})
.catch((err: ZIMError) => {
// error
});查询用户定义的推送规则
通过调用 querySelfUserInfo，即可在回调中的 selfUserInfo.userRule.offlinePushRule 获取当前用户自定义的离线推送规则。
ZIM.getInstance().querySelfUserInfo(new ZIMSelfUserInfoQueriedCallback() {
@Override
public void onSelfUserInfoQueried(ZIMSelfUserInfo selfUserInfo, ZIMError errorInfo) {
selfUserInfo.userRule.offlinePushRule; // 当前用户定义的离线推送规则
}
});ZIM.getInstance().querySelfUserInfo(new ZIMSelfUserInfoQueriedCallback() {
@Override
public void onSelfUserInfoQueried(ZIMSelfUserInfo selfUserInfo, ZIMError errorInfo) {
selfUserInfo.userRule.offlinePushRule; // 当前用户定义的离线推送规则
}
});[[ZIM getInstance] querySelfUserInfo:^(ZIMSelfUserInfo * _Nonnull selfUserInfo, ZIMError * _Nonnull errorInfo) {
selfUserInfo.userRule.offlinePushRule; // 当前用户定义的离线推送规则
}];[[ZIM getInstance] querySelfUserInfo:^(ZIMSelfUserInfo * _Nonnull selfUserInfo, ZIMError * _Nonnull errorInfo) {
selfUserInfo.userRule.offlinePushRule; // 当前用户定义的离线推送规则
}];zim::ZIM::ZIM.getInstance()->querySelfUserInfo([](const zim::ZIM::ZIMSelfUserInfo& selfUserInfo, const zim::ZIM::ZIMError& errorInfo) {
selfUserInfo.userRule.offlinePushRule; // 当前用户定义的离线推送规则
});zim::ZIM::ZIM.getInstance()->querySelfUserInfo([](const zim::ZIM::ZIMSelfUserInfo& selfUserInfo, const zim::ZIM::ZIMError& errorInfo) {
selfUserInfo.userRule.offlinePushRule; // 当前用户定义的离线推送规则
});// 查询用户定义的推送规则
try{
ZIMSelfUserInfoQueriedResult result = await ZIM.getInstance()!.querySelfUserInfo();
result.selfUserInfo.userFullInfo; // 当前用户的用户信息
result.selfUserInfo.userRule.offlinePushRule; // 当前用户定义的离线推送规则
} on PlatformException catch (onError) {
onError.code;
onError.message;
}// 查询用户定义的推送规则
try{
ZIMSelfUserInfoQueriedResult result = await ZIM.getInstance()!.querySelfUserInfo();
result.selfUserInfo.userFullInfo; // 当前用户的用户信息
result.selfUserInfo.userRule.offlinePushRule; // 当前用户定义的离线推送规则
} on PlatformException catch (onError) {
onError.code;
onError.message;
}zim.querySelfUserInfo()
.then((res: ZIMSelfUserInfoQueriedResult) => {
});zim.querySelfUserInfo()
.then((res: ZIMSelfUserInfoQueriedResult) => {
});