com.localytics.android

Class InAppCampaign

java.lang.Object

com.localytics.android.Campaign

com.localytics.android.WebViewCampaign

com.localytics.android.InAppCampaign

All Implemented Interfaces:

android.os.Parcelable

public final class InAppCampaign
extends WebViewCampaign

The in-app campaign class from which user can get the in-app campaign information. An in-app campaign object is passed to the user through the messaging listener.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<InAppCampaign>	CREATOR

Fields inherited from class com.localytics.android.WebViewCampaign

localCreativeUri, webViewAttributes

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
int	describeContents()
float	getAspectRatio()
float	getBackgroundAlpha()
protected java.lang.String	getConversionEventName()
Localytics.InAppMessageDismissButtonLocation	getDismissButtonLocation() Get the location of the dismiss button (left or right)
java.lang.String	getDisplayLocation() Get the location where the campaign creative displays on the device.
java.util.Map<java.lang.String,java.lang.String>	getEventAttributes() Get the event attributes associated with the campaign triggering event.
java.lang.String	getEventName() Get the event name that triggered the campaign.
protected java.util.Map<java.lang.String,java.lang.String>	getExtraCampaignEventAttributes(java.lang.String action)
int	getOffset()
boolean	isDismissButtonHidden() Get whether the dismiss button is hidden
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class com.localytics.android.WebViewCampaign

getCreativeFilePath, getWebViewAttributes

Methods inherited from class com.localytics.android.Campaign

getAbTest, getAttributes, getCampaignId, getName, getRuleName, getSchemaVersion, getVersion

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<InAppCampaign> CREATOR

Method Detail

getAspectRatio

public float getAspectRatio()

getOffset

public int getOffset()

getBackgroundAlpha

public float getBackgroundAlpha()

getDisplayLocation

@Nullable
public java.lang.String getDisplayLocation()

Get the location where the campaign creative displays on the device. (top, center, etc.)

Returns:

the location where the campaign creative displays on the device.

isDismissButtonHidden

public boolean isDismissButtonHidden()

Get whether the dismiss button is hidden

Returns:

boolean indicating whether the dismiss button is hidden

getDismissButtonLocation

@NonNull
public Localytics.InAppMessageDismissButtonLocation getDismissButtonLocation()

Get the location of the dismiss button (left or right)

Returns:

the InAppMessageDismissButtonLocation enum indicating the location of the dismiss button

getEventName

@Nullable
public java.lang.String getEventName()

Get the event name that triggered the campaign. Can only be null when campaign is triggered from test mode.

Returns:

the event name that triggered the campaign

See Also:

getEventAttributes()

getEventAttributes

@NonNull
public java.util.Map<java.lang.String,java.lang.String> getEventAttributes()

Get the event attributes associated with the campaign triggering event.

Returns:

the attributes associated with the campaign triggering event.

See Also:

getEventName()

getExtraCampaignEventAttributes

@NonNull
protected java.util.Map<java.lang.String,java.lang.String> getExtraCampaignEventAttributes(@Nullable
                                                                                                    java.lang.String action)

Specified by:

getExtraCampaignEventAttributes in class WebViewCampaign

getConversionEventName

@NonNull
protected java.lang.String getConversionEventName()

Specified by:

getConversionEventName in class WebViewCampaign

toString

@NonNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

describeContents

public int describeContents()

writeToParcel

public void writeToParcel(@NonNull
                          android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

Overrides:

writeToParcel in class WebViewCampaign