离线推送展示的标题
离线推送展示的内容
自定义消息进行离线推送,该字段不能为空字符串
Optional
ext离线推送透传的扩展字段
iOS:收到离线推送的一方可以在 UIApplicationDelegate -> didReceiveRemoteNotification -> userInfo 拿到这个字段,该字段可以做 UI 跳转逻辑
鸿蒙:收到离线推送的一方可以在 UIAbility -> onCreate/onNewWant -> Want.parameters.ext 拿到这个字段,该字段可以做 UI 跳转逻辑
Optional
disable是否关闭推送
Optional
iOSPushiOS 离线推送的类型(仅对 iOS 生效) 默认 V2TIM_IOS_OFFLINE_PUSH_TYPE_APNS
Optional
ignoreIOSBadge离线推送忽略 badge 计数(仅对 iOS 生效) 如果设置为 true,在 iOS 接收端,这条消息不会使 APP 的应用图标未读计数增加
Optional
iOSSound离线推送声音设置(仅对 iOS 生效)
当 iOSSound == "kIOSOfflinePushNoSound",表示接收时不会播放声音 当 iOSSound == "kIOSOfflinePushDefaultSound",表示接收时播放系统声音
如果要自定义 iOSSound,需要先把语音文件链接进 Xcode 工程,然后把语音文件名(带后缀)设置给 iOSSound
Optional
iOSInterruptioniOS 离线推送的通知级别 (iOS 15 及以上支持)
通知级别 "passive",不会发出声音、振动或横幅提示,只会静默地出现在通知中心。适用于不紧急的信息,例如应用内的社交活动更新或推荐内容。 "active", 会发出声音或振动,并显示横幅提示。适用于一般的重要通知,例如消息提醒、日历事件等。(默认类型) "time-sensitive",会发出声音或振动,并显示横幅提示,这种级别的通知会打扰用户,即使用户启用了“专注模式”(Focus Mode)。适用于需要用户立即关注的紧急通知,例如安全警报、重要的时间提醒等。打开需要在苹果开发者平台和 xcode 项目中增加相应的配置。 "critical", 会发出声音或振动,并显示横幅提示。这种级别的通知会打扰用户,即使设备处于静音模式。适用于极其重要的紧急通知,例如公共安全警报、严重的健康警告等。打开需要向 Apple 特殊申请。
Optional
enableIOSBackground设置 iOS 后台透传消息(仅对 iOS 生效)
设置打开后,离线接收会唤起应用并透传消息内容 ext
Optional
Android离线推送声音设置(仅对 Android 生效, 仅 IM SDK 6.1 及以上版本支持) 只有华为和谷歌手机支持设置铃音提示,小米铃音设置请您参照:https://dev.mi.com/console/doc/detailpId=1278%23_3_0 另外,谷歌手机 FCM 推送在 Android 8.0 及以上系统设置声音提示,必须调用 setAndroidFCMChannelID 设置好 channelID,才能生效
AndroidSound: Android 工程里 raw 目录中的铃声文件名,不需要后缀名
Optional
AndroidOPPOChannelID离线推送设置 OPPO 手机 8.0 系统及以上的渠道 ID(仅对 Android 生效)
Optional
AndroidFCMChannelID离线推送设置 FCM 通道手机 8.0 系统及以上的渠道 ID(仅对 Android 生效)
Optional
Android离线推送设置小米通道手机 8.0 系统及以上的渠道 ID(仅对 Android 生效)
Optional
AndroidVIVOClassification离线推送设置 VIVO 手机 (仅对 Android 生效) VIVO 手机离线推送消息分类,0:运营消息,1:系统消息,默认 1
Optional
AndroidVIVOCategory离线推送设置 VIVO 推送消息类别,详见:https://dev.vivo.com.cn/documentCenter/doc/359
VIVO 推送服务于 2023 年 4 月 3 日优化消息分类规则,推荐使用 AndroidVIVOCategory 设置消息类别, 不需要再关注和设置 AndroidVIVOClassification
Optional
AndroidOptional
AndroidOPPOCategory离线推送设置 OPPO 推送消息分类,详见:https://open.oppomobile.com/new/developmentDoc/info?id=13189
OPPO 推送消息分类 1、通讯与服务类型有:"IM","ACCOUNT"等 2、内容与营销类型有:"NEWS","CONTENT"等
Optional
AndroidOPPONotify离线推送设置 OPPO 推送通知栏消息提醒等级,详见:https://open.oppomobile.com/new/developmentDoc/info?id=13189
使用生效前,需要先 setAndroidOPPOCategory 指定 category 为 IM 类消息
OPPO 通知栏消息提醒等级 1 通知栏 2 通知栏 + 锁屏 (默认) 16 通知栏 + 锁屏 + 横幅 + 震动 + 铃声
Optional
Android离线推送设置 Honor 推送消息分类,详见:https://developer.honor.com/cn/docs/11002/guides/notification-class
Honor 推送消息分类 "NORMAL", 表示消息为服务通讯类 "LOW", 表示消息为资讯营销类
Optional
Android设置华为设备离线推送的通知图片 imageUrl 使用的协议必须是 HTTPS 协议,取值样例:https://example.com/image.png 图片文件须小于 512KB,规格建议为 40dp x 40dp,弧角大小为 8dp。超出建议规格的图片会存在图片压缩或图片显示不全的情况。图片格式建议使用 JPG/JPEG/PNG。
Optional
Android设置荣耀设备离线推送的通知图片 imageUrl 使用的协议必须是 HTTPS 协议,取值样例:https://example.com/image.png 图标文件大小须小于 100KB,图标建议规格大小:160px x 160px,弧角大小为 32px,超出规格大小的图标会存在图片压缩或显示不全的情况。
Optional
AndroidFCMImage设置 Google FCM 设备离线推送的通知图片,未展开消息时显示为大图标,展开消息后展示为大图片 imageUrl 使用的协议必须是 HTTPS 协议,取值样例:https://example.com/image.png 图标文件大小须小于 1 MB,超出规格大小的图标会存在图片压缩或显示不全的情况。
Optional
iOSImage设置 APNs 离线推送的通知图片, 借助 iOS 10 Service Extension 特性,可以下载并展示在弹窗上. iOSImage 使用的协议必须是 HTTPS 协议,取值样例:https://example.com/image.png 限制说明:
Optional
Harmony设置鸿蒙设备离线推送通知右侧大图标的 URL
URL 协议:HTTPS,例如:https://example.com/image.png 图片格式:png、jpg、jpeg、heif、gif、bmp 图片大小:长 * 宽 < 25000 像素
Optional
Harmony设置鸿蒙设备离线推送通知消息类别。完成自分类权益申请后,用于标识通知消息类型,不同的通知消息类型影响消息展示和提醒方式
Optional
ignore离线推送忽略 badge 计数(仅对 HarmonyOS 生效) 如果设置为 true,在 HarmonyOS 接收端,这条消息不会使 APP 的应用图标未读计数增加
Generated using TypeDoc
自定义消息 push。