com.braze.models.inappmessage

Class InAppMessageControl

java.lang.Object

com.braze.models.inappmessage.InAppMessageBase

com.braze.models.inappmessage.InAppMessageControl

All Implemented Interfaces:

IInAppMessage, IInAppMessageThemeable, IPutIntoJson<org.json.JSONObject>

public class InAppMessageControl
extends InAppMessageBase

If the user is enrolled in the control group of an in-app message campaign, an InAppMessageControl should be instantiated. InAppMessageControl instances can be serialized and used for analytics only. They should never be used to back an actual in-app message for display.

Field Summary

Fields inherited from class com.braze.models.inappmessage.InAppMessageBase

ANIMATE_IN, ANIMATE_OUT, CROP_TYPE, INAPP_MESSAGE_DURATION_DEFAULT_MILLIS, INAPP_MESSAGE_DURATION_MIN_MILLIS, IS_CONTROL, mBrazeManager, mCropType, MESSAGE_TEXT_ALIGN, mInAppMessageDarkThemeWrapper, mJsonObject, mMessageTextAlign, mOpenUriInWebview, OPEN_URI_IN_WEBVIEW, TYPE

Constructor Summary

Constructors

Constructor and Description
InAppMessageControl(org.json.JSONObject object, IBrazeManager appboyManager)

Method Summary

Modifier and Type	Method and Description
MessageType	getMessageType() The MessageType of this in-app message.
boolean	logImpression() Logs an impression on this in-app message.

Methods inherited from class com.braze.models.inappmessage.InAppMessageBase

enableDarkTheme, forJsonPut, getAnimateIn, getAnimateOut, getBackgroundColor, getClickAction, getCropType, getDismissType, getDurationInMilliseconds, getExpirationTimestamp, getExtras, getIcon, getIconBackgroundColor, getIconColor, getLocalPrefetchedAssetPaths, getMessage, getMessageTextAlign, getMessageTextColor, getOpenUriInWebView, getOrientation, getRemoteAssetPathsForPrefetch, getUri, isControl, logClick, logDisplayFailure, onAfterClosed, setAnimateIn, setAnimateOut, setBackgroundColor, setClickAction, setClickAction, setCropType, setDismissType, setDurationInMilliseconds, setExpirationTimestamp, setExtras, setIcon, setIconBackgroundColor, setIconColor, setLocalPrefetchedAssetPaths, setMessage, setMessageTextAlign, setMessageTextColor, setOpenUriInWebView, setOrientation

Methods inherited from class java.lang.Object

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

Constructor Detail

InAppMessageControl

public InAppMessageControl(org.json.JSONObject object,
                           IBrazeManager appboyManager)
                    throws org.json.JSONException

Throws:

org.json.JSONException

Method Detail

getMessageType

public MessageType getMessageType()

Description copied from interface: IInAppMessage

The MessageType of this in-app message.

logImpression

public boolean logImpression()

Description copied from interface: IInAppMessage

Logs an impression on this in-app message. Impressions may only be logged once per in-app message instance.

See IInAppMessage.logClick()

Specified by:

logImpression in interface IInAppMessage

Overrides:

logImpression in class InAppMessageBase

Returns:

true iff the impression was successfully logged.