IIn App Message Immersive
InAppMessageBase is the base model interface for all immersive in-app messages.
An immersive in-app message is defined as an in-app message that takes up the entire screen and/or 'blocks' the user from interacting with the app until the message is dismissed. Immersive messages extend the base in-app message with header text, message buttons, and a close button.
Inheritors
Properties
Whether this in-app message will animate out or disappear suddenly.
The android.graphics.Color background color on this in-app message.
The click action of this in-app message.
The close button color on this in-app message.
The dismiss type of this in-app message.
Gets the duration of this in-app message. Only valid for DismissType.AUTO_DISMISS.
The UTC timestamp at which this message expires and will not be displayed.
The frame color for this in-app message. The frame refers to the area surrounding a modal in-app message.
The text alignment for the header text.
The header text color on this in-app message.
The icon background color on this in-app message. This will set the color of the icon background itself (not the icon itself).
The icon color (android.graphics.Color) of this in-app message. This is the color of the icon itself (not the background).
The image style on this in-app message.
Is this in-app message from a test send.
The message buttons for this in-app message.
The message extras on this in-app message as a string. This field will be absent if there is no value.
The text alignment for the message text.
The message text color on this in-app message.
The MessageType of this in-app message.
Sets whether to use BrazeWebViewActivity to open deep links from this in-app message.
The preferred screen orientation for this in-app message.
Functions
Gets where to find the pre-fetched remote assets specified in setLocalPrefetchedAssetPaths.
Returns a path to remote assets that can be pre-fetched. To point this in-app message to pre-fetched assets, use .setLocalPrefetchedAssetPaths
Logs a click on this message button.
Logs a click on this in-app message. Clicks (either with or without button IDs) may only be logged once per in-app message instance.
Logs a button click on this in-app message. Clicks (either with or without button IDs) may only be logged once per in-app message instance.
Logs an impression on this in-app message. Impressions may only be logged once per in-app message instance.
Should be called on the in-app message once it is no longer being displayed, to allow it to perform any cleanup or trigger further actions.
Convenience method that calls setClickBehavior(clickAction, null)
.
Sets the click action and/or Uri of this in-app message.
Instruct this in-app message where to find pre-fetched assets for remote assets specified in .getRemoteAssetPathsForPrefetch.