IMSDK
IM features a comprehensive suite of solutions including global access, one-to-one chat, group chat, message push, profile and relationship chain hosting, and account authentication. It also provides complete app access and backend management APIs.
V2TIMOfflinePushInfo

Public Member Functions

 V2TIMOfflinePushInfo ()
 
 V2TIMOfflinePushInfo (const V2TIMOfflinePushInfo &)
 
 ~V2TIMOfflinePushInfo ()
 

Data Fields

V2TIMString title
 
V2TIMString desc
 
V2TIMString ext
 
bool disablePush
 
V2TIMIOSOfflinePushType iOSPushType
 
bool ignoreIOSBadge
 
V2TIMString iOSSound
 
V2TIMString AndroidSound
 
V2TIMString AndroidOPPOChannelID
 
V2TIMString AndroidFCMChannelID
 
V2TIMString AndroidXiaoMiChannelID
 
int AndroidVIVOClassification
 
V2TIMString AndroidVIVOCategory
 
V2TIMString AndroidHuaWeiCategory
 

Constructor & Destructor Documentation

◆ V2TIMOfflinePushInfo() [1/2]

◆ V2TIMOfflinePushInfo() [2/2]

◆ ~V2TIMOfflinePushInfo()

Field Documentation

◆ title

V2TIMString title

Notification title(This field must be set for custom message offline push)

◆ desc

Notification content.

◆ ext

Extended field passed through by offline push The party that receives the offline push can get this field in UIApplicationDelegate -> didReceiveRemoteNotification -> userInfo, and use this field to make UI jump logic.

◆ disablePush

bool disablePush

Whether to disable push (push enabled by default)

◆ iOSPushType

The type of offline push on iOS (valid only for iOS) Default value is V2TIM_IOS_OFFLINE_PUSH_TYPE_APNS

◆ ignoreIOSBadge

bool ignoreIOSBadge

Whether to ignore the badge count for offline push (valid only for iOS)

If this parameter is set to YES, the unread message count on the app badge will not increase when the message is received by the iOS device.

◆ iOSSound

V2TIMString iOSSound

Offline push sound setting (valid only for iOS)

When iOSSound is kIOSOfflinePushNoSound, no sound is played when a message is received. When iOSSound is kIOSOfflinePushDefaultSound, the system alert sound is played when a message is received. To customize iOSSound, link the audio file to the Xcode project and set iOSSound to the audio filename (with the extension name).

◆ AndroidSound

V2TIMString AndroidSound

Offline push sound setting (valid only for Android, supported only in imsdk 6.1 and later versions)

Only Huawei and Google phones support setting ringtone. And Xiaomi needs refer to https://dev.mi.com/console/doc/detail?pId=1278%23_3_0 .

In addition, Google phones using FCM to set the sound prompt on Android 8.0 and above systems, which needs to be configured in notification channel, please refer to the interface setAndroidFCMChannelID.

To customize AndroidSound: The ringtone file name in the raw directory of the Android project, no suffix is required.

◆ AndroidOPPOChannelID

V2TIMString AndroidOPPOChannelID

Offline push channel ID for OPPO phones that run Android 8.0 or later.

◆ AndroidFCMChannelID

V2TIMString AndroidFCMChannelID

Offline push channel ID for Google FCM phones that run Android 8.0 or later.

◆ AndroidXiaoMiChannelID

V2TIMString AndroidXiaoMiChannelID

Offline push channel ID for XiaoMi phones that run Android 8.0 or later.

◆ AndroidVIVOClassification

int AndroidVIVOClassification

Offline push setting for VIVO push classification. (It is deprecated and discouraged to call this function. The VIVO push service has optimize the message classification rules on April 3, 2023. Please call API AndroidVIVOCategory instead.) Offline push message classification for vivo phones. 0: operation message; 1: system message. The default value is 1.

◆ AndroidVIVOCategory

V2TIMString AndroidVIVOCategory

Offline push setting for VIVO push category,See details:https://dev.vivo.com.cn/documentCenter/doc/359. (The VIVO push service has optimize the message classification rules on April 3, 2023. Please call API AndroidVIVOCategory instead.)

◆ AndroidHuaWeiCategory

V2TIMString AndroidHuaWeiCategory

Offline push setting for HuaWei push category,See details:https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835.