com.batch.android.plugin.hms

Class BatchHms.Push

java.lang.Object

com.batch.android.plugin.hms.BatchHms.Push

Enclosing class:

BatchHms

public static final class BatchHms.Push
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BATCH_BUNDLE_KEY Key used in a push bundle

Method Summary

Modifier and Type	Method and Description
static void	appendBatchData(com.huawei.hms.push.RemoteMessage remoteMessage, android.content.Intent openIntent) Append Batch data to your open intent so that opens from this push will be tracked by Batch and displayed into your dashboard.
static void	displayNotification(android.content.Context context, com.huawei.hms.push.RemoteMessage remoteMessage) Call this method to display the notification for this message.
static void	displayNotification(android.content.Context context, com.huawei.hms.push.RemoteMessage remoteMessage, com.batch.android.BatchNotificationInterceptor interceptor) Call this method to display the notification for this message.
static boolean	isBatchPush(com.huawei.hms.push.RemoteMessage remoteMessage) Check if the received push is a Batch one.
static android.app.PendingIntent	makePendingIntent(android.content.Context context, android.content.Intent intent, com.huawei.hms.push.RemoteMessage remoteMessage) Make a PendingIntent suitable for notifications from a given Intent.
static android.app.PendingIntent	makePendingIntentForDeeplink(android.content.Context context, java.lang.String deeplink, com.huawei.hms.push.RemoteMessage remoteMessage) Make a PendingIntent suitable for notifications from a given deeplink.
static void	onNotificationDisplayed(android.content.Context context, com.huawei.hms.push.RemoteMessage remoteMessage) Call this method when you just displayed a Batch push notification by yourself.
static boolean	shouldDisplayPush(android.content.Context context, com.huawei.hms.push.RemoteMessage remoteMessage) Should the developer handle and display this push, or will Batch display it? Use this method to know if Batch will ignore this push, and that displaying it is your responsibility

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BATCH_BUNDLE_KEY

public static final java.lang.String BATCH_BUNDLE_KEY

Key used in a push bundle

See Also:

Constant Field Values

Method Detail

isBatchPush

public static boolean isBatchPush(com.huawei.hms.push.RemoteMessage remoteMessage)

Check if the received push is a Batch one. If you have a custom push implementation into your app you should call this method before doing anything else. If it returns true, you should not handle the push.

Parameters:

remoteMessage - Huawei RemoteMessage

Returns:

true if the push is for Batch and you shouldn't handle it, false otherwise

appendBatchData

public static void appendBatchData(@NonNull
                                   com.huawei.hms.push.RemoteMessage remoteMessage,
                                   @NonNull
                                   android.content.Intent openIntent)

Append Batch data to your open intent so that opens from this push will be tracked by Batch and displayed into your dashboard. It also powers other features, such as but not limited to mobile landings.

Parameters:

remoteMessage - the Huawei message content

openIntent - the intent of the notification the will be triggered when the user clicks on it

makePendingIntent

@NonNull
public static android.app.PendingIntent makePendingIntent(@NonNull
                                                                   android.content.Context context,
                                                                   @NonNull
                                                                   android.content.Intent intent,
                                                                   @NonNull
                                                                   com.huawei.hms.push.RemoteMessage remoteMessage)

Make a PendingIntent suitable for notifications from a given Intent. This is useful for custom receivers, or BatchNotificationInterceptor implementations.

Warning: it will override the intent's action with a unique name, to ensure that existing notifications are not updated with this PendingIntent's content. If you rely on a custom action, you will have to make your own PendingIntent.

Parameters:

context - Context. Cannot be null.

intent - The intent you want to be triggered when performing the pending intent. Must be an intent compatible with PendingIntent.getActivity(Context, int, Intent, int). Cannot be null.

remoteMessage - Raw Huawei message, used to copy data used by Batch to power features such as direct opens, or mobile landings. Cannot be null. If these extras don't have valid Batch data in it, a valid PendingIntent will still be returned, but some features might not work correctly.

Returns:

A PendingIntent instance, wrapping the given Intent.

makePendingIntentForDeeplink

@Nullable
public static android.app.PendingIntent makePendingIntentForDeeplink(@NonNull
                                                                               android.content.Context context,
                                                                               @NonNull
                                                                               java.lang.String deeplink,
                                                                               @NonNull
                                                                               com.huawei.hms.push.RemoteMessage remoteMessage)

Make a PendingIntent suitable for notifications from a given deeplink. It will use Batch's builtin action activity.

This is useful for custom receivers, or BatchNotificationInterceptor implementations.

Parameters:

context - Context. Cannot be null.

deeplink - Deeplink string. Cannot be null.

remoteMessage - Raw Huawei message content, used to copy data used by Batch to power features such as direct opens, or mobile landings. Cannot be null. If these extras don't have valid Batch data in it, a valid PendingIntent will still be returned, but some features might not work correctly.

Returns:

A PendingIntent set to open Batch's builtin action activity to open the specified deeplink. Can be null if the deeplink is not valid.

shouldDisplayPush

public static boolean shouldDisplayPush(android.content.Context context,
                                        com.huawei.hms.push.RemoteMessage remoteMessage)

Should the developer handle and display this push, or will Batch display it? Use this method to know if Batch will ignore this push, and that displaying it is your responsibility

Parameters:

context - Context

remoteMessage - The Huawei message

Returns:

true if the push will not be processed by Batch and should be handled, false otherwise

displayNotification

public static void displayNotification(android.content.Context context,
                                       com.huawei.hms.push.RemoteMessage remoteMessage)

Call this method to display the notification for this message. Note that this method will spawn a new thread if ran on the main thread, and thus becomes asynchronous.

Parameters:

context - Context

remoteMessage - The Huawei message

displayNotification

public static void displayNotification(@NonNull
                                       android.content.Context context,
                                       @NonNull
                                       com.huawei.hms.push.RemoteMessage remoteMessage,
                                       @Nullable
                                       com.batch.android.BatchNotificationInterceptor interceptor)

Call this method to display the notification for this message. Allows an interceptor to be set for this call, overriding the global one set using Batch.Push#setNotificationInterceptor(BatchNotificationInterceptor) Note that this method will spawn a new thread if ran on the main thread, and thus becomes asynchronous.

Parameters:

context - Context

remoteMessage - The Huawei message

interceptor - Interceptor to use

onNotificationDisplayed

public static void onNotificationDisplayed(android.content.Context context,
                                           com.huawei.hms.push.RemoteMessage remoteMessage)

Call this method when you just displayed a Batch push notification by yourself.

Parameters:

context - Context

remoteMessage - The Huawei message