com.netease.nimlib.sdk.mixpush

Interface MixPushService

public interface MixPushService

Third-party push service Supported third-party push services: Xiaomi, Huawei, Meizu, and FCM

Method Summary

Modifier and Type	Method and Description
InvocationFuture<java.lang.Void>	enable(boolean enable) Enable or disable third-party push service
NoDisturbConfig	getPushNoDisturbConfig() Get the configuration of Do-Not-Disturb for push services
boolean	isEnable() Check if the third-party push service is enabled.
boolean	isFCMIntent(Intent intent) Activity starts by click FCM notifications
boolean	isPushNoDisturbConfigExist() Check if the Do-Not-Disturb setting is applied for push services in the SDK .
boolean	isPushShowNoDetail() Get the setting to hide or show the push details
java.lang.String	parseFCMPayload(Intent intent) Parse strings in FCM payload
InvocationFuture<java.lang.Void>	setPushNoDisturbConfig(boolean isOpen, java.lang.String startTime, java.lang.String stopTime) Set Do-Not Disturb period for push notifications in HH:mm format UTC+8.
InvocationFuture<java.lang.Void>	setPushShowNoDetail(boolean showNoDetail) Hide or show details of a push notification

Method Detail

enable

InvocationFuture<java.lang.Void> enable(boolean enable)

Enable or disable third-party push service

Parameters:

enable - true: enable the third-party push service. The SDK will send a confimation request to the CommsEase server. False: disable the third-party push service. The SDK also needs to send a notification to CommsEase server.

Returns:

InvocationFuture callback Only when the confirmation with the CommsEase server is complete, the setting takes effect. If an error occurs, a specific error code will be returned.

isEnable

boolean isEnable()

Check if the third-party push service is enabled.

Returns:

By default, the third-party push service is enabled.

setPushNoDisturbConfig

InvocationFuture<java.lang.Void> setPushNoDisturbConfig(boolean isOpen,
                                                        java.lang.String startTime,
                                                        java.lang.String stopTime)

Set Do-Not Disturb period for push notifications in HH:mm format UTC+8. No push notifications will be received during the specified period. For users with SDK v3.2.0 or earilier, sync the settings of Do-Not-Disturb of the application with the push setting. Call setPushNoDisturbConfig. If developers do not use the new third-party push service, the old push service will not be affected. In addition, users must set push Do-Not-Disturb in the Do-Not-Disturb setting interface at the same time

Parameters:

isOpen - enable or disable Do-Not-Disturb

startTime - start time in HH:mm format

stopTime - end time in Hh:mm format

Returns:

InvocationFuture callback A successful message will be returned for a success call and an error message will be returned for failures.

setPushShowNoDetail

InvocationFuture<java.lang.Void> setPushShowNoDetail(boolean showNoDetail)

Hide or show details of a push notification

Parameters:

showNoDetail - Hide or show details

Returns:

InvocationFuture callback A successful message will be returned for a success call and an error message will be returned for failures.

isPushShowNoDetail

boolean isPushShowNoDetail()

Get the setting to hide or show the push details

Returns:

result

getPushNoDisturbConfig

NoDisturbConfig getPushNoDisturbConfig()

Get the configuration of Do-Not-Disturb for push services

Returns:

NoDisturbConfig

isPushNoDisturbConfigExist

boolean isPushNoDisturbConfigExist()

Check if the Do-Not-Disturb setting is applied for push services in the SDK .

Returns:

result

isFCMIntent

boolean isFCMIntent(Intent intent)

Activity starts by click FCM notifications

Parameters:

intent - activity intent

Returns:

result

parseFCMPayload

java.lang.String parseFCMPayload(Intent intent)

Parse strings in FCM payload

Parameters:

intent - activity intent

Returns: