IMSDK
即时通信 IM 提供全球接入、单聊、群聊、消息推送、资料关系链托管、账号鉴权等全方位解决方案，并提供完备的 App 接入、后台管理接口。
属性
V2TIMOfflinePushInfo

详细描述

自定义消息 push。

属性

NSString * title
 
NSString * desc
 
NSString * ext
 
BOOL disablePush
 
V2TIMIOSOfflinePushType iOSPushType
 
BOOL ignoreIOSBadge
 
NSString * iOSSound
 
NSString * iOSInterruptionLevel
 
BOOL enableIOSBackgroundNotification
 
NSString * AndroidSound
 
NSString * AndroidOPPOChannelID
 
NSString * AndroidFCMChannelID
 
NSString * AndroidXiaoMiChannelID
 
NSInteger AndroidVIVOClassification
 
NSString * AndroidVIVOCategory
 
NSString * AndroidHuaWeiCategory
 
NSString * AndroidOPPOCategory
 
NSInteger AndroidOPPONotifyLevel
 
NSString * AndroidHonorImportance
 
NSString * AndroidHuaWeiImage
 
NSString * AndroidHonorImage
 
NSString * AndroidFCMImage
 
NSString * iOSImage
 
NSString * HarmonyImage
 
NSString * HarmonyCategory
 
BOOL ignoreHarmonyBadge
 

属性说明

◆ title

- (NSString*) title
readwritenonatomicstrong

离线推送展示的标题。

◆ desc

- (NSString*) desc
readwritenonatomicstrong

离线推送展示的内容。 自定义消息进行离线推送，必须设置此字段内容。

◆ ext

- (NSString*) ext
readwritenonatomicstrong

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

◆ disablePush

- (BOOL) disablePush
readwritenonatomicassign

是否关闭推送（默认开启推送）。

◆ iOSPushType

- (V2TIMIOSOfflinePushType) iOSPushType
readwritenonatomicassign

iOS 离线推送的类型（仅对 iOS 生效） 默认值是 V2TIM_IOS_OFFLINE_PUSH_TYPE_APNS

◆ ignoreIOSBadge

- (BOOL) ignoreIOSBadge
readwritenonatomicassign

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

◆ iOSSound

- (NSString*) iOSSound
readwritenonatomicstrong

离线推送声音设置（仅对 iOS 生效）， 当 iOSSound = kIOSOfflinePushNoSound，表示接收时不会播放声音。 当 iOSSound = kIOSOfflinePushDefaultSound，表示接收时播放系统声音。 如果要自定义 iOSSound，需要先把语音文件链接进 Xcode 工程，然后把语音文件名（带后缀）设置给 iOSSound。

◆ iOSInterruptionLevel

- (NSString*) iOSInterruptionLevel
readwritenonatomicstrong

iOS 离线推送的通知级别 (iOS 15 及以上支持) "passive"，不会发出声音、振动或横幅提示，只会静默地出现在通知中心。适用于不紧急的信息，例如应用内的社交活动更新或推荐内容。 "active", 会发出声音或振动，并显示横幅提示。适用于一般的重要通知，例如消息提醒、日历事件等。（默认类型） "time-sensitive"，会发出声音或振动，并显示横幅提示，这种级别的通知会打扰用户，即使用户启用了“专注模式”（Focus Mode）。适用于需要用户立即关注的紧急通知，例如安全警报、重要的时间提醒等。打开需要在苹果开发者平台和 xcode 项目中增加相应的配置。 "critical", 会发出声音或振动，并显示横幅提示。这种级别的通知会打扰用户，即使设备处于静音模式。适用于极其重要的紧急通知，例如公共安全警报、严重的健康警告等。打开需要向 Apple 特殊申请。

◆ enableIOSBackgroundNotification

- (BOOL) enableIOSBackgroundNotification
readwritenonatomicassign

设置 iOS 后台透传消息 设置打开后，离线接收会唤起应用并透传消息内容 ext

◆ AndroidSound

- (NSString*) AndroidSound
readwritenonatomicstrong

离线推送声音设置（仅对 Android 生效, 仅 imsdk 6.1 及以上版本支持） 只有华为和谷歌手机支持设置铃音提示，小米铃音设置请您参照：https://dev.mi.com/console/doc/detail?pId=1278%23_3_0 另外，谷歌手机 FCM 推送在 Android 8.0 及以上系统设置声音提示，需要在 channel 通道配置，请参照接口 AndroidFCMChannelID AndroidSound: Android 工程里 raw 目录中的铃声文件名，不需要后缀名。

◆ AndroidOPPOChannelID

- (NSString*) AndroidOPPOChannelID
readwritenonatomicstrong

离线推送设置 OPPO 手机推送的 ChannelID, 仅支持 8.0 系统及以上。（应用配置接入 OPPO 推送的必须要设置）

◆ AndroidFCMChannelID

- (NSString*) AndroidFCMChannelID
readwritenonatomicstrong

离线推送设置 Google FCM 手机推送的 ChannelID, 仅支持 8.0 系统及以上。

◆ AndroidXiaoMiChannelID

- (NSString*) AndroidXiaoMiChannelID
readwritenonatomicstrong

离线推送设置小米手机推送的 ChannelID, 仅支持 8.0 系统及以上。

◆ AndroidVIVOClassification

- (NSInteger) AndroidVIVOClassification
readwritenonatomicassign

离线推送设置 VIVO 推送消息分类 (待废弃接口，VIVO 推送服务于 2023 年 4 月 3 日优化消息分类规则，推荐使用 AndroidVIVOCategory 设置消息类别) VIVO 手机离线推送消息分类，0：运营消息，1：系统消息。默认取值为 1 。

◆ AndroidVIVOCategory

- (NSString*) AndroidVIVOCategory
readwritenonatomicstrong

离线推送设置 VIVO 推送消息类别，详见：https://dev.vivo.com.cn/documentCenter/doc/359。(VIVO 推送服务于 2023 年 4 月 3 日优化消息分类规则，推荐使用 AndroidVIVOCategory 设置消息类别，不需要再关注和设置 AndroidVIVOClassification)

◆ AndroidHuaWeiCategory

- (NSString*) AndroidHuaWeiCategory
readwritenonatomicstrong

离线推送设置华为推送消息分类，详见：https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835

◆ AndroidOPPOCategory

- (NSString*) AndroidOPPOCategory
readwritenonatomicstrong

离线推送设置 OPPO 推送消息分类，详见：https://open.oppomobile.com/new/developmentDoc/info?id=13189 通讯与服务类型有："IM"，"ACCOUNT"等；内容与营销类型有："NEWS"，"CONTENT"等

◆ AndroidOPPONotifyLevel

- (NSInteger) AndroidOPPONotifyLevel
readwritenonatomicassign

离线推送设置 OPPO 推送通知栏消息提醒等级，详见：https://open.oppomobile.com/new/developmentDoc/info?id=13189 使用生效前，需要先设置 AndroidOPPOCategory 指定 category 为 IM 类消息。消息提醒等级有：1，通知栏；2，通知栏 + 锁屏 （默认）；16，通知栏 + 锁屏 + 横幅 + 震动 + 铃声；

◆ AndroidHonorImportance

- (NSString*) AndroidHonorImportance
readwritenonatomicstrong

离线推送设置 Honor 推送消息分类，详见：https://developer.honor.com/cn/docs/11002/guides/notification-class Honor 推送消息分类: "NORMAL", 表示消息为服务通讯类; "LOW", 表示消息为资讯营销类

◆ AndroidHuaWeiImage

- (NSString*) AndroidHuaWeiImage
readwritenonatomicstrong

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

◆ AndroidHonorImage

- (NSString*) AndroidHonorImage
readwritenonatomicstrong

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

◆ AndroidFCMImage

- (NSString*) AndroidFCMImage
readwritenonatomicstrong

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

◆ iOSImage

- (NSString*) iOSImage
readwritenonatomicstrong

设置 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

- (NSString*) HarmonyImage
readwritenonatomicstrong

设置鸿蒙设备离线推送的通知图片，URL使用的协议必须是HTTPS协议，取值样例：https://example.com/image.png。 支持图片格式为png、jpg、jpeg、heif、gif、bmp，图片长*宽 < 25000像素。

◆ HarmonyCategory

- (NSString*) HarmonyCategory
readwritenonatomicstrong

设置鸿蒙设备离线推送通知消息类别，详见：https://developer.huawei.com/consumer/cn/doc/HMSCore-Guides/message-classification-0000001149358835

◆ ignoreHarmonyBadge

- (BOOL) ignoreHarmonyBadge
readwritenonatomicassign

离线推送忽略 badge 计数（仅对 Harmony 生效）， 如果设置为 YES，在 Harmony 接收端，这条消息不会使 APP 的应用图标未读计数增加。