Package com.batch.android

Class BatchInAppMessage

java.lang.Object

com.batch.android.BatchMessage

com.batch.android.BatchInAppMessage

All Implemented Interfaces:

InAppMessageUserActionSource, UserActionSource

public class BatchInAppMessage
extends BatchMessage
implements InAppMessageUserActionSource

A subclass of BatchMessage that represents an In-App message

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchInAppMessage.Content	Interface defining a BatchInAppMessage content model object.

Nested classes/interfaces inherited from class com.batch.android.BatchMessage

BatchMessage.Format

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	KIND

Fields inherited from class com.batch.android.BatchMessage

MESSAGING_EXTRA_PAYLOAD_KEY

Constructor Summary

Constructors

Constructor	Description
BatchInAppMessage(java.lang.String campaignToken, java.lang.String campaignID, JSONObject eventData, JSONObject landingPayload, JSONObject customPayload)

Method Summary

Modifier and Type	Method	Description
protected android.os.Bundle	getBundleRepresentation()
java.lang.String	getCampaignToken()	Get the campaign token.
BatchInAppMessage.Content	getContent()	Get an In-App Message's visual contents.
JSONObject	getCustomPayload()
protected JSONObject	getCustomPayloadInternal()
protected JSONObject	getJSON()
protected java.lang.String	getKind()

Methods inherited from class com.batch.android.BatchMessage

getFormat, getMessageForBundle, writeToBundle, writeToIntent

Methods inherited from class java.lang.Object

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

Field Detail

KIND

public static final java.lang.String KIND

See Also:

Constant Field Values

Constructor Detail

BatchInAppMessage

public BatchInAppMessage(@Nullable
                         java.lang.String campaignToken,
                         @NonNull
                         java.lang.String campaignID,
                         @NonNull
                         JSONObject eventData,
                         @NonNull
                         JSONObject landingPayload,
                         @NonNull
                         JSONObject customPayload)

Method Detail

getJSON

protected JSONObject getJSON()

Specified by:

getJSON in class BatchMessage

getCustomPayloadInternal

protected JSONObject getCustomPayloadInternal()

Specified by:

getCustomPayloadInternal in class BatchMessage

getKind

protected java.lang.String getKind()

Specified by:

getKind in class BatchMessage

getBundleRepresentation

protected android.os.Bundle getBundleRepresentation()

Specified by:

getBundleRepresentation in class BatchMessage

getCustomPayload

@NonNull
public JSONObject getCustomPayload()

Specified by:

getCustomPayload in interface InAppMessageUserActionSource

getContent

@Nullable
public BatchInAppMessage.Content getContent()

Get an In-App Message's visual contents.

Since an In-App message's contents can change a lot between formats, you will need to cast this to one of the classes implementing BatchInAppMessage.Content, such as BatchAlertContent, BatchInterstitialContent, BatchBannerContent, BatchImageContent or BatchWebViewContent
More types might be added in the future, so don't make any assumptions on the instance returned.

Returns:

The In-App message's visual contents. Can be null if an error occurred or if not applicable

getCampaignToken

@Nullable
public java.lang.String getCampaignToken()

Get the campaign token. This is the same token as you see when opening the In-App Campaign in your browser, when on the dashboard.

Can be null.