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

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)
 

静态 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()

成员函数说明

◆ 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

是否关闭推送(默认开启推送)。

参数
disabletrue:关闭;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。

参数
soundiOS 声音路径

◆ 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,才能生效。

参数
soundAndroid 工程里 raw 目录中的铃声文件名,不需要后缀名。

◆ setIgnoreIOSBadge()

void setIgnoreIOSBadge ( boolean  ignoreIOSBadge)
inline

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

参数
ignoreIOSBadgeiOS 应用图标未读计数状态。true:忽略;false:开启

◆ setAndroidOPPOChannelID()

void setAndroidOPPOChannelID ( String  channelID)
inline

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

参数
channelIDOPPO 手机的渠道 ID

◆ setAndroidFCMChannelID()

void setAndroidFCMChannelID ( String  channelID)
inline

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

参数
channelIDFCM 推送的渠道 ID

◆ setAndroidXiaoMiChannelID()

void setAndroidXiaoMiChannelID ( String  channelID)
inline

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

参数
channelID小米推送的渠道 ID

◆ setAndroidVIVOClassification()

void setAndroidVIVOClassification ( int  classification)
inline

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

参数
classificationVIVO 手机离线推送消息分类,0:运营消息 1:系统消息,默认取值为 1

◆ setAndroidVIVOCategory()

void setAndroidVIVOCategory ( String  category)
inline

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

参数
categoryvivo 推送消息类别

◆ setIOSPushType()

void setIOSPushType ( int  iosPushType)
inline

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

参数
iosPushTypeIOS_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华为推送消息分类

结构体成员变量说明

◆ 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