XuqmGroup-RNSDK/packages/push/README.md

1.4 KiB

@xuqm/rn-push

XuqmGroup RN SDK 推送模块。自动检测设备厂商并完成推送 token 注册。

安装

pnpm add @xuqm/rn-common @xuqm/rn-push

Peer dependenciesreact-native >= 0.76

使用

Push 不提供独立初始化或登录入口。宿主调用一次 XuqmSDK.login() 后,SDK 自动完成:

  1. 检测设备厂商(华为/小米/OPPO/vivo/荣耀/FCM/APNs
  2. 从平台获取该厂商推送配置
  3. 调用厂商 SDK 完成设备注册
  4. 收到 token 后自动上报绑定到平台
import { PushSDK } from '@xuqm/rn-push'

// 通常不需要手动调用,XuqmSDK.login() 会自动触发
// 设置离线推送开关
await PushSDK.setOfflinePushEnabled(false)

// 设置免打扰时间段24 小时制)
await PushSDK.setQuietHours('22:00', '08:00')

// 清除免打扰
await PushSDK.clearQuietHours()

// 主动登出通常不需要,XuqmSDK.logout() 自动触发)
await PushSDK.logout()

API

API 说明
PushSDK.setOfflinePushEnabled(enabled) 设置离线推送开关
PushSDK.setQuietHours(start, end) 设置免打扰时间段
PushSDK.clearQuietHours() 清除免打扰设置
PushSDK.logout() 解绑推送 token

支持厂商

HUAWEI / XIAOMI / OPPO / VIVO / HONOR / FCM / APNS

依赖

需要原生模块 NativeModules.XuqmPushModule 已链接到宿主 App。