Class V2TIMOfflinePushInfo

自定义消息 push。

title: string

离线推送展示的标题

desc: string

离线推送展示的内容

Note

自定义消息进行离线推送,该字段不能为空字符串

ext?: string

离线推送透传的扩展字段

iOS:收到离线推送的一方可以在 UIApplicationDelegate -> didReceiveRemoteNotification -> userInfo 拿到这个字段,该字段可以做 UI 跳转逻辑

鸿蒙:收到离线推送的一方可以在 UIAbility -> onCreate/onNewWant -> Want.parameters.ext 拿到这个字段,该字段可以做 UI 跳转逻辑

disablePush?: boolean

是否关闭推送

iOS 离线推送的类型(仅对 iOS 生效) 默认 V2TIM_IOS_OFFLINE_PUSH_TYPE_APNS

ignoreIOSBadge?: boolean

离线推送忽略 badge 计数(仅对 iOS 生效) 如果设置为 true,在 iOS 接收端,这条消息不会使 APP 的应用图标未读计数增加

iOSSound?: string

离线推送声音设置(仅对 iOS 生效)

当 iOSSound == "kIOSOfflinePushNoSound",表示接收时不会播放声音 当 iOSSound == "kIOSOfflinePushDefaultSound",表示接收时播放系统声音

如果要自定义 iOSSound,需要先把语音文件链接进 Xcode 工程,然后把语音文件名(带后缀)设置给 iOSSound

AndroidSound?: string

离线推送声音设置(仅对 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 目录中的铃声文件名,不需要后缀名

AndroidOPPOChannelID?: string

离线推送设置 OPPO 手机 8.0 系统及以上的渠道 ID(仅对 Android 生效)

AndroidFCMChannelID?: string

离线推送设置 FCM 通道手机 8.0 系统及以上的渠道 ID(仅对 Android 生效)

AndroidXiaoMiChannelID?: string

离线推送设置小米通道手机 8.0 系统及以上的渠道 ID(仅对 Android 生效)

AndroidVIVOClassification?: number

离线推送设置 VIVO 手机 (仅对 Android 生效) VIVO 手机离线推送消息分类,0:运营消息,1:系统消息,默认 1

AndroidVIVOCategory?: string

离线推送设置 VIVO 推送消息类别,详见:https://dev.vivo.com.cn/documentCenter/doc/359

VIVO 推送服务于 2023 年 4 月 3 日优化消息分类规则,推荐使用 AndroidVIVOCategory 设置消息类别, 不需要再关注和设置 AndroidVIVOClassification

AndroidHuaWeiCategory?: string
AndroidHuaWeiImage?: string

设置华为设备离线推送的通知图片 imageUrl 使用的协议必须是 HTTPS 协议,取值样例:https://example.com/image.png 图片文件须小于 512KB,规格建议为 40dp x 40dp,弧角大小为 8dp。超出建议规格的图片会存在图片压缩或图片显示不全的情况。图片格式建议使用 JPG/JPEG/PNG。

AndroidHonorImage?: string

设置荣耀设备离线推送的通知图片 imageUrl 使用的协议必须是 HTTPS 协议,取值样例:https://example.com/image.png 图标文件大小须小于 100KB,图标建议规格大小:160px x 160px,弧角大小为 32px,超出规格大小的图标会存在图片压缩或显示不全的情况。

AndroidFCMImage?: string

设置 Google FCM 设备离线推送的通知图片,未展开消息时显示为大图标,展开消息后展示为大图片 imageUrl 使用的协议必须是 HTTPS 协议,取值样例:https://example.com/image.png 图标文件大小须小于 1 MB,超出规格大小的图标会存在图片压缩或显示不全的情况。

iOSImage?: string

设置 APNs 离线推送的通知图片, 借助 iOS 10 Service Extension 特性,可以下载并展示在弹窗上. iOSImage 使用的协议必须是 HTTPS 协议,取值样例:https://example.com/image.png 限制说明:

  • 图片:支持 JPEG、GIF、PNG,大小不超过 10 MB 使用说明:
  • 需要在 IM 控制台打开 mutable-content 属性,支持 iOS 10 Service Extension 特性
  • 获取 iOSImage 资源的 key 值是 "image"
HarmonyImage?: string

设置鸿蒙设备离线推送通知右侧大图标的 URL

URL 协议:HTTPS,例如:https://example.com/image.png 图片格式:png、jpg、jpeg、heif、gif、bmp 图片大小:长 * 宽 < 25000 像素

HarmonyCategory?: string

设置鸿蒙设备离线推送通知消息类别。完成自分类权益申请后,用于标识通知消息类型,不同的通知消息类型影响消息展示和提醒方式

ignoreHarmonyBadge?: boolean

离线推送忽略 badge 计数(仅对 HarmonyOS 生效) 如果设置为 true,在 HarmonyOS 接收端,这条消息不会使 APP 的应用图标未读计数增加

Generated using TypeDoc