Package com.batch.android.core

Class InternalPushData

  • public class InternalPushData
extends java.lang.Object
    Class to easily access the push data

    • Field Detail

      • BATCH_BUNDLE_KEY

        public static final java.lang.String BATCH_BUNDLE_KEY
        Key this data is contained in when stored in a push bundle
        See Also:
        Constant Field Values

    • Constructor Detail

      • InternalPushData

        public InternalPushData​(java.lang.String batchData)

      • InternalPushData

        public InternalPushData​(JSONObject batchData)

    • Method Detail

      • getPushDataForReceiverIntent

        public static InternalPushData getPushDataForReceiverIntent​(@NonNull
                                                            android.content.Intent intent)

      • getPushDataForReceiverBundle

        public static InternalPushData getPushDataForReceiverBundle​(@Nullable
                                                            android.os.Bundle extras)

      • getPushDataForFirebaseMessage

        public static InternalPushData getPushDataForFirebaseMessage​(@Nullable
                                                             com.google.firebase.messaging.RemoteMessage message)

      • getJsonPayload

        public java.lang.String getJsonPayload()

      • isSilent

        public boolean isSilent()

      • isLocalCampainsRefresh

        public boolean isLocalCampainsRefresh()

      • hasScheme

        public boolean hasScheme()

      • isSchemeEmpty

        public boolean isSchemeEmpty()

      • getScheme

        public java.lang.String getScheme()

      • getPushId

        public java.lang.String getPushId()

      • getInstallId

        public java.lang.String getInstallId()

      • hasLandingMessage

        public boolean hasLandingMessage()

      • getLandingMessage

        public JSONObject getLandingMessage()

      • hasCustomBigIcon

        public boolean hasCustomBigIcon()

      • getCustomBigIconURL

        public java.lang.String getCustomBigIconURL()

      • getCustomBigIconAvailableDensity

        public java.util.List<java.lang.Double> getCustomBigIconAvailableDensity()

      • hasCustomBigImage

        public boolean hasCustomBigImage()

      • getCustomBigImageURL

        public java.lang.String getCustomBigImageURL()

      • getCustomBigImageAvailableDensity

        public java.util.List<java.lang.Double> getCustomBigImageAvailableDensity()

      • getReceiptMinDelay

        public long getReceiptMinDelay()

      • getReceiptMaxDelay

        public long getReceiptMaxDelay()

      • getChannel

        public java.lang.String getChannel()
        Returns the channel for Android 8.0

      • getGroup

        public java.lang.String getGroup()
        Get the notification group name. Meant to be used with NotificationCompat.Builder.setGroup(String)
        Returns:
        Group name string, null if none

      • isGroupSummary

        public boolean isGroupSummary()
        Get the notification group name. Meant to be used with NotificationCompat.Builder.setGroupSummary(boolean)
        Returns:
        Whether this notification should be a group summary or not

      • getVisibility

        public int getVisibility()
        Get the notification's visibility.

        See NotificationCompat.Builder.setVisibility(int)

        Returns:
        The wanted visibility. Default is Notification.VISIBILITY_PUBLIC

      • getNotificationFormat

        public InternalPushData.Format getNotificationFormat()
        Get the notification format A format is like a Messaging message format

      • getNotificationFormatArguments

        @Nullable
public JSONObject getNotificationFormatArguments()
        Get the notification format arguments

      • getExtraParameters

        public java.util.Map<java.lang.String,​java.lang.Object> getExtraParameters()

      • getOpenData

        public java.util.Map<java.lang.String,​java.lang.Object> getOpenData()
        Get the open data as map
        Returns:

      • getReceiptEventData

        public java.util.Map<java.lang.String,​java.lang.Object> getReceiptEventData()
        Get the event data for the display receipt
        Returns:

      • shouldUseLegacyBigPictureIconBehaviour

        public boolean shouldUseLegacyBigPictureIconBehaviour()
        Returns whether the old custom icon fallback behaviour for BigPictureStyle (which changed in 1.14.1) should be used or not.

        Default false