Public 成员函数
	V2TIMOfflinePushInfo ()

String	getTitle ()

void	setTitle (String title)

String	getDesc ()

void	setDesc (String description)

void	setExt (byte[] ext)

byte []	getExt ()

void	disablePush (boolean disable)

boolean	isDisablePush ()

void	setIOSSound (String sound)

void	setAndroidSound (String sound)

void	setIgnoreIOSBadge (boolean ignoreIOSBadge)

void	setAndroidOPPOChannelID (String channelID)

void	setAndroidFCMChannelID (String channelID)

void	setAndroidXiaoMiChannelID (String channelID)

void	setAndroidVIVOClassification (int classification)

void	setAndroidVIVOCategory (String category)

void	setIOSPushType (int iosPushType)

void	setAndroidHuaWeiCategory (String category)

void	setAndroidHuaWeiImage (String imageUrl)

void	setAndroidHonorImage (String imageUrl)

void	setAndroidFCMImage (String imageUrl)

void	setIOSImage (String imageUrl)

void	setHarmonyImage (String imageUrl)

void	setHarmonyCategory (String category)

void	setIgnoreHarmonyBadge (boolean ignoreHarmonyBadge)

静态 Public 属性
static final String	IOS_OFFLINE_PUSH_NO_SOUND = "push.no_sound"

static final String	IOS_OFFLINE_PUSH_DEFAULT_SOUND = "default"

static final int	IOS_OFFLINE_PUSH_TYPE_APNS = 0

static final int	IOS_OFFLINE_PUSH_TYPE_VOIP = 1

构造及析构函数说明

◆ V2TIMOfflinePushInfo()

V2TIMOfflinePushInfo ( )

inline

成员函数说明

◆ getTitle()

String getTitle ( )

inline

获取离线推送通知标题

返回: 通知标题

◆ setTitle()

void setTitle ( String title )

inline

设置离线推送展示标题。

参数

title 通知栏标题

◆ getDesc()

String getDesc ( )

inline

获取离线推送通知内容

返回: 通知内容

◆ setDesc()

void setDesc ( String description )

inline

设置离线推送展示内容。

注意: 自定义消息进行离线推送，必须设置此字段内容

参数

description 通知栏内容

◆ setExt()

void setExt ( byte [] ext )

inline

设置离线推送透传的扩展字段。

参数

ext 通知栏透传信息

◆ getExt()

byte [] getExt ( )

inline

获取离线推送透传的扩展字段。

◆ disablePush()

void disablePush ( boolean disable )

inline

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

参数

disable true：关闭；false：打开

◆ isDisablePush()

boolean isDisablePush ( )

inline

获取是否关闭离线推送状态。

返回: 关闭状态。true：关闭；false：打开

◆ setIOSSound()

void setIOSSound ( String sound )

inline

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

参数

sound iOS 声音路径

◆ setAndroidSound()

void setAndroidSound ( String sound )

inline

离线推送声音设置（仅对 Android 生效, IMSDK 6.1 及以上版本支持）。只有华为和谷歌手机支持设置声音提示，小米手机设置声音提示，请您参照：https://dev.mi.com/console/doc/detail?pId=1278%23_3_0 另外，谷歌手机 FCM 推送在 Android 8.0 及以上系统设置声音提示，必须调用 setAndroidFCMChannelID 设置好 channelID，才能生效。

参数

sound Android 工程里 raw 目录中的铃声文件名，不需要后缀名。

◆ setIgnoreIOSBadge()

void setIgnoreIOSBadge ( boolean ignoreIOSBadge )

inline

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

参数

ignoreIOSBadge iOS 应用图标未读计数状态。true：忽略；false：开启

◆ setAndroidOPPOChannelID()

void setAndroidOPPOChannelID ( String channelID )

inline

离线推送设置 OPPO 手机 8.0 系统及以上的渠道 ID。

参数

channelID OPPO 手机的渠道 ID

◆ setAndroidFCMChannelID()

void setAndroidFCMChannelID ( String channelID )

inline

离线推送设置 FCM 通道手机 8.0 系统及以上的渠道 ID。

参数

channelID FCM 推送的渠道 ID

◆ setAndroidXiaoMiChannelID()

void setAndroidXiaoMiChannelID ( String channelID )

inline

离线推送设置小米手机 8.0 系统及以上的渠道 ID。

参数

channelID 小米推送的渠道 ID

◆ setAndroidVIVOClassification()

void setAndroidVIVOClassification ( int classification )

inline

离线推送设置 VIVO 推送消息分类 (待废弃接口，VIVO 推送服务于 2023 年 4 月 3 日优化消息分类规则，推荐使用 setAndroidVIVOCategory 设置消息类别)

参数

classification VIVO 手机离线推送消息分类，0：运营消息 1：系统消息，默认取值为 1

◆ setAndroidVIVOCategory()

void setAndroidVIVOCategory ( String category )

inline

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

参数

category vivo 推送消息类别

◆ setIOSPushType()

void setIOSPushType ( int iosPushType )

inline

iOS 离线推送的类型（仅对 iOS 生效）

参数

iosPushType IOS_OFFLINE_PUSH_TYPE_APNS：普通的 APNs 推送; IOS_OFFLINE_PUSH_TYPE_VOIP：VoIP 推送，默认取值为 IOS_OFFLINE_PUSH_TYPE_APNS

◆ setAndroidHuaWeiCategory()

void setAndroidHuaWeiCategory ( String category )

inline

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

参数

category 华为推送消息分类

◆ setAndroidHuaWeiImage()

void setAndroidHuaWeiImage ( String imageUrl )

inline

设置华为设备离线推送的通知图片

参数

imageUrl 使用的协议必须是 HTTPS 协议，取值样例：https://example.com/image.png

注意: 说明：图片文件须小于 512KB，规格建议为 40dp x 40dp，弧角大小为 8dp。超出建议规格的图片会存在图片压缩或图片显示不全的情况。图片格式建议使用 JPG/JPEG/PNG。

◆ setAndroidHonorImage()

void setAndroidHonorImage ( String imageUrl )

inline

设置荣耀设备离线推送的通知图片

参数

imageUrl 使用的协议必须是 HTTPS 协议，取值样例：https://example.com/image.png

注意: 说明：图标文件大小须小于 100KB，图标建议规格大小：160px x 160px，弧角大小为 32px，超出规格大小的图标会存在图片压缩或显示不全的情况。

◆ setAndroidFCMImage()

void setAndroidFCMImage ( String imageUrl )

inline

设置 Google FCM 设备离线推送的通知图片，未展开消息时显示为大图标，展开消息后展示为大图片

参数

imageUrl 使用的协议必须是 HTTPS 协议，取值样例：https://example.com/image.png

注意: 说明：图标文件大小须小于 1 MB，超出规格大小的图标会存在图片压缩或显示不全的情况。

◆ setIOSImage()

void setIOSImage ( String imageUrl )

inline

设置 APNs 离线推送的通知图片, 借助 iOS 10 Service Extension 特性，可以下载并展示在弹窗上

参数

imageUrl 使用的协议必须是 HTTPS 协议，取值样例：https://example.com/image.png

注意

限制说明：支持 JPEG、GIF、PNG，大小不超过 10 MB

使用说明：

需要在 IM 控制台打开 mutable-content 属性，支持 iOS 10 Service Extension 特性
获取 imageUrl 资源的 key 值是 "image"

◆ setHarmonyImage()

void setHarmonyImage ( String imageUrl )

inline

设置鸿蒙设备离线推送的通知图片

参数

imageUrl 使用的协议必须是HTTPS协议，取值样例：https://example.com/image.png。

注意: 说明：支持图片格式为png、jpg、jpeg、heif、gif、bmp，图片长*宽 < 25000像素

◆ setHarmonyCategory()

void setHarmonyCategory ( String category )

inline

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

参数

category 鸿蒙推送消息分类

◆ setIgnoreHarmonyBadge()

void setIgnoreHarmonyBadge ( boolean ignoreHarmonyBadge )

inline

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

参数

ignoreHarmonyBadge Harmony 应用图标未读计数状态。true：忽略；false：开启

结构体成员变量说明

◆ IOS_OFFLINE_PUSH_NO_SOUND

final String IOS_OFFLINE_PUSH_NO_SOUND = "push.no_sound"

static

◆ IOS_OFFLINE_PUSH_DEFAULT_SOUND

final String IOS_OFFLINE_PUSH_DEFAULT_SOUND = "default"

static

◆ IOS_OFFLINE_PUSH_TYPE_APNS

final int IOS_OFFLINE_PUSH_TYPE_APNS = 0

static

◆ IOS_OFFLINE_PUSH_TYPE_VOIP

final int IOS_OFFLINE_PUSH_TYPE_VOIP = 1

static

Public 成员函数

静态 Public 属性

构造及析构函数说明

◆ V2TIMOfflinePushInfo()

成员函数说明

◆ getTitle()

◆ setTitle()

◆ getDesc()

◆ setDesc()

◆ setExt()

◆ getExt()

◆ disablePush()

◆ isDisablePush()

◆ setIOSSound()

◆ setAndroidSound()

◆ setIgnoreIOSBadge()

◆ setAndroidOPPOChannelID()

◆ setAndroidFCMChannelID()

◆ setAndroidXiaoMiChannelID()

◆ setAndroidVIVOClassification()

◆ setAndroidVIVOCategory()

◆ setIOSPushType()

◆ setAndroidHuaWeiCategory()

◆ setAndroidHuaWeiImage()

◆ setAndroidHonorImage()

◆ setAndroidFCMImage()

◆ setIOSImage()

◆ setHarmonyImage()

◆ setHarmonyCategory()

◆ setIgnoreHarmonyBadge()

结构体成员变量说明

◆ IOS_OFFLINE_PUSH_NO_SOUND

◆ IOS_OFFLINE_PUSH_DEFAULT_SOUND

◆ IOS_OFFLINE_PUSH_TYPE_APNS

◆ IOS_OFFLINE_PUSH_TYPE_VOIP