com.localytics.android

Class InAppConfiguration

java.lang.Object

com.localytics.android.InAppConfiguration

All Implemented Interfaces:

android.os.Parcelable

public final class InAppConfiguration
extends java.lang.Object

An object designed to contain all mutable display state of an in-app message. An in-app configuration object is passed to the user through the MessagingListenerV2.

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<InAppConfiguration>	CREATOR
static float	DEFAULT_VIDEO_CONVERSION_PERCENTAGE
protected static java.util.regex.Pattern	FILE_META_TAG_REGEX
protected com.localytics.android.MarketingLogger	logger
protected float	videoConversionPercentage

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
int	describeContents()
protected java.lang.String[]	getKeyValueConfigurationForCreative(java.lang.String filePath) Get key value pairs for injecting into the creative campaign
float	getVideoConversionPercentage()
protected void	handleKeyValuePairs(java.lang.String[] pairs)
boolean	isBottomBannerCampaign() Get whether the in-app will be presented as a bottom banner campaign.
boolean	isCenterCampaign() Get whether the in-app will be presented as a center campaign.
boolean	isFullScreenCampaign() Get whether the in-app will be presented as a full screen campaign.
boolean	isTopBannerCampaign() Get whether the in-app will be presented as a top banner campaign.
void	setAspectRatio(float aspectRatio) Set the aspect ratio for this in-app.
void	setBackgroundAlpha(float backgroundAlpha) Set the background alpha for this in-app.
void	setBannerOffsetDps(int offsetDps) Set the offset for this in-app.
void	setDismissButtonImage(android.content.res.Resources resources, android.graphics.Bitmap image) Set the dismiss button image for this in-app.
void	setDismissButtonImage(android.content.res.Resources resources, int id) Set the dismiss button image for this in-app.
void	setDismissButtonLocation(Localytics.InAppMessageDismissButtonLocation dismissButtonLocation) Set the dismiss button location for this in-app.
void	setDismissButtonVisibility(int visibility) Set the dismiss button image for this in-app.
void	setShouldRenderInNotch(boolean renderInNotch)
void	setVideoConversionPercentage(float percent) Sets what percentage of the total duration of the video to fire the "Localytics Video Played" event.
protected void	updateValuesWithContentsOfCreative(WebViewCampaign c)
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

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

DEFAULT_VIDEO_CONVERSION_PERCENTAGE

public static final float DEFAULT_VIDEO_CONVERSION_PERCENTAGE

See Also:

Constant Field Values

FILE_META_TAG_REGEX

protected static java.util.regex.Pattern FILE_META_TAG_REGEX

logger

protected com.localytics.android.MarketingLogger logger

videoConversionPercentage

protected float videoConversionPercentage

Method Detail

isCenterCampaign

public boolean isCenterCampaign()

Get whether the in-app will be presented as a center campaign.

Returns:

boolean indicating whether the in-app is a center campaign

isTopBannerCampaign

public boolean isTopBannerCampaign()

Get whether the in-app will be presented as a top banner campaign.

Returns:

boolean indicating whether the in-app is a top banner campaign

isBottomBannerCampaign

public boolean isBottomBannerCampaign()

Get whether the in-app will be presented as a bottom banner campaign.

Returns:

boolean indicating whether the in-app is a bottom banner campaign

isFullScreenCampaign

public boolean isFullScreenCampaign()

Get whether the in-app will be presented as a full screen campaign.

Returns:

boolean indicating whether the in-app is a full screen campaign

setAspectRatio

public void setAspectRatio(float aspectRatio)

Set the aspect ratio for this in-app. The aspect ratio should be a float value representing a ratio of width to height (example 16:9 display is 1.77).

Accepted values must be greater than 0.

This property is only relevant for center in-app Campaigns

Parameters:

aspectRatio - a float value greater than 0 representing the aspect ratio of the campaign.

setBackgroundAlpha

public void setBackgroundAlpha(float backgroundAlpha)

Set the background alpha for this in-app. The background alpha should be a float value representing the desired transparency for the backdrop of the creative.

Accepted values must be greater than 0 and less than 1.

This property is only relevant for center and full screen in-app Campaigns

Parameters:

backgroundAlpha - a float value greater than 0 and less than 1 representing the transparency of the campaign backdrop.

setBannerOffsetDps

public void setBannerOffsetDps(int offsetDps)

Set the offset for this in-app. The offset should be an int value representing the desired offset from the edge of the screen in density independent pixels.

This property is only relevant for banner in-app Campaigns

Parameters:

offsetDps - an int value representing the offset from the edge of the screen.

setDismissButtonLocation

public void setDismissButtonLocation(Localytics.InAppMessageDismissButtonLocation dismissButtonLocation)

Set the dismiss button location for this in-app. This value will override any values set globally with Localytics.setInAppMessageDismissButtonLocation(com.localytics.android.Localytics.InAppMessageDismissButtonLocation).

Parameters:

dismissButtonLocation - Either InAppMessageDismissButtonLocation.LEFT or InAppMessageDismissButtonLocation.RIGHT

setDismissButtonImage

public void setDismissButtonImage(@NonNull
                                  android.content.res.Resources resources,
                                  @DrawableRes
                                  int id)

Set the dismiss button image for this in-app. This value will override any values set globally with Localytics.setInAppMessageDismissButtonImage(Resources, int) or Localytics.setInAppMessageDismissButtonImage(Resources, Bitmap).

Parameters:

resources - The Resources instance for your application's package.

id - The image resource id for the close button appearance.

setDismissButtonImage

public void setDismissButtonImage(@NonNull
                                  android.content.res.Resources resources,
                                  @Nullable
                                  android.graphics.Bitmap image)

Set the dismiss button image for this in-app. This value will override any values set globally with Localytics.setInAppMessageDismissButtonImage(Resources, int) or Localytics.setInAppMessageDismissButtonImage(Resources, Bitmap).

Parameters:

resources - The Resources instance for your application's package.

image - The bitmap object for the close button appearance.

setDismissButtonVisibility

public void setDismissButtonVisibility(int visibility)

Set the dismiss button image for this in-app. This value will override any values set globally with Localytics.setInAppMessageDismissButtonVisibility(int).

Parameters:

visibility - The visibility state of the dismiss button

See Also:

View.setVisibility(int)

setShouldRenderInNotch

public void setShouldRenderInNotch(boolean renderInNotch)

describeContents

public int describeContents()

writeToParcel

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

Specified by:

writeToParcel in interface android.os.Parcelable

updateValuesWithContentsOfCreative

protected void updateValuesWithContentsOfCreative(WebViewCampaign c)

handleKeyValuePairs

protected void handleKeyValuePairs(java.lang.String[] pairs)

getKeyValueConfigurationForCreative

protected java.lang.String[] getKeyValueConfigurationForCreative(java.lang.String filePath)

Get key value pairs for injecting into the creative campaign

Parameters:

filePath - The path to the creative

Returns:

An array of key val pairs. Split on "=" and inject those into the creative

setVideoConversionPercentage

public void setVideoConversionPercentage(float percent)

Sets what percentage of the total duration of the video to fire the "Localytics Video Played" event. The default value is 70.0f. If a video is 10 seconds long, this would trigger the event at 7 seconds by default.

Parameters:

percent - The percentage of the video

getVideoConversionPercentage

public float getVideoConversionPercentage()