IInAppMessage (Braze Android SDK 15.0.0)

All Superinterfaces:

IPutIntoJson<org.json.JSONObject>

All Known Subinterfaces:

IInAppMessageHtml, IInAppMessageImmersive, IInAppMessageZippedAssetHtml

All Known Implementing Classes:

InAppMessageBase, InAppMessageControl, InAppMessageFull, InAppMessageHtml, InAppMessageHtmlBase, InAppMessageHtmlFull, InAppMessageImmersiveBase, InAppMessageModal, InAppMessageSlideup, InAppMessageWithImageBase, InAppMessageZippedAssetHtmlBase
```
public interface IInAppMessage
extends IPutIntoJson<org.json.JSONObject>
```
InAppMessageBase is the base model interface for all in-app messages.
It implicitly defines policy for in-app message fields that can be changed from outside the object.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`getAnimateIn()` Gets whether this in-app message will animate in or appear suddenly.
`boolean`	`getAnimateOut()` Gets whether this in-app message will animate out or disappear suddenly.
`int`	`getBackgroundColor()` Gets the background color on this in-app message.
`ClickAction`	`getClickAction()` Gets the click action of this in-app message.
`CropType`	`getCropType()` Gets the crop type for this in-app message's image.
`DismissType`	`getDismissType()` Gets the dismiss type of this in-app message.
`int`	`getDurationInMilliseconds()` Gets the duration of this in-app message.
`long`	`getExpirationTimestamp()` Get the UTC timestamp at which this message expires and will not be displayed.
`java.util.Map<java.lang.String,java.lang.String>`	`getExtras()` Gets the extras on this in-app message as a map of key value pairs.
`java.lang.String`	`getIcon()` Gets the Font Awesome icon on this in-app message.
`int`	`getIconBackgroundColor()` Gets the icon background color on this in-app message.
`int`	`getIconColor()` Gets the icon color on this in-app message.
`java.util.Map<java.lang.String,java.lang.String>`	`getLocalPrefetchedAssetPaths()` Gets where to find the pre-fetched remote assets specified in `setLocalPrefetchedAssetPaths(Map)`.
`java.lang.String`	`getMessage()` Gets the message text on this in-app message.
`TextAlign`	`getMessageTextAlign()` Get the text alignment for the message text.
`int`	`getMessageTextColor()` Gets the message text color on this in-app message.
`MessageType`	`getMessageType()` The `MessageType` of this in-app message.
`boolean`	`getOpenUriInWebView()` Whether to use AppboyWebViewActivity to open deep links from this in-app message.
`Orientation`	`getOrientation()` Gets the preferred screen orientation for this in-app message.
`java.util.List<java.lang.String>`	`getRemoteAssetPathsForPrefetch()` Returns a path to remote assets that can be pre-fetched.
`android.net.Uri`	`getUri()` Gets the URI on this in-app message.
`boolean`	`isControl()` Gets whether this in-app message is a control for multivariate testing.
`boolean`	`logClick()` Logs a click on this in-app message.
`boolean`	`logDisplayFailure(InAppMessageFailureType failureType)` Logs a display failure on this in-app message.
`boolean`	`logImpression()` Logs an impression on this in-app message.
`void`	`onAfterClosed()` 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.
`void`	`setAnimateIn(boolean animateIn)` Sets whether this in-app message will animate in or appear suddenly.
`void`	`setAnimateOut(boolean animateOut)` Sets whether this in-app message will animate out or disappear suddenly.
`void`	`setBackgroundColor(int backgroundColor)` Sets the background color on this in-app message.
`boolean`	`setClickAction(ClickAction clickAction)` Sets the click action of this in-app message.
`boolean`	`setClickAction(ClickAction clickAction, android.net.Uri uri)` Sets the click action of this in-app message.
`void`	`setCropType(CropType cropType)` Sets the crop type for this in-app message's image.
`void`	`setDismissType(DismissType dismissType)` Sets the dismiss type of this in-app message.
`void`	`setDurationInMilliseconds(int durationInMilliseconds)` Sets the duration of this in-app message.
`void`	`setExpirationTimestamp(long expirationTimestamp)` Set the UTC timestamp at which this message expires and will not be displayed.
`void`	`setExtras(java.util.Map<java.lang.String,java.lang.String> extras)` Sets or overrides the extras on this in-app message as a map of key value pairs.
`void`	`setIcon(java.lang.String icon)` Sets the icon on this in-app message.
`void`	`setIconBackgroundColor(int iconColor)` Sets the icon background color on this in-app message.
`void`	`setIconColor(int iconColor)` Sets the icon color on this in-app message.
`void`	`setLocalPrefetchedAssetPaths(java.util.Map<java.lang.String,java.lang.String> remotePathToLocalAssetMap)` Instruct this in-app message where to find pre-fetched assets for remote assets specified in `getRemoteAssetPathsForPrefetch()`.
`void`	`setMessage(java.lang.String message)` Sets the message text of this in-app message.
`void`	`setMessageTextAlign(TextAlign textAlign)` Set the text alignment for the message text.
`void`	`setMessageTextColor(int textColor)` Sets the message text color on this in-app message.
`void`	`setOpenUriInWebView(boolean openUriInWebView)` Sets whether to use AppboyWebViewActivity to open deep links from this in-app message.
`void`	`setOrientation(Orientation orientation)` Sets the preferred screen orientation for this in-app message.

Methods inherited from interface com.braze.models.IPutIntoJson
forJsonPut

- Method Detail
  - getMessage
```
java.lang.String getMessage()
```
    Gets the message text on this in-app message.
    
    Returns:
    
    the message text on this in-app message.
  - getExtras
```
java.util.Map<java.lang.String,java.lang.String> getExtras()
```
    Gets the extras on this in-app message as a map of key value pairs.
    
    Returns:
    
    a map of extras on this in-app message.
  - setExtras
```
void setExtras(java.util.Map<java.lang.String,java.lang.String> extras)
```
    Sets or overrides the extras on this in-app message as a map of key value pairs.
    
    Parameters:
    
    extras - A map of extras on this in-app message.
  - getDurationInMilliseconds
```
int getDurationInMilliseconds()
```
    Gets the duration of this in-app message.
    
    Returns:
    
    the duration of this in-app message.
  - getBackgroundColor
```
int getBackgroundColor()
```
    Gets the background color on this in-app message.
    
    Returns:
    
    See Color
  - getIconColor
```
int getIconColor()
```
    Gets the icon color on this in-app message.
    See getIconColor()
    
    Returns:
    
    See Color
  - getIconBackgroundColor
```
int getIconBackgroundColor()
```
    Gets the icon background color on this in-app message.
    See setIconBackgroundColor(int)
    
    Returns:
    
    See Color
  - getMessageTextColor
```
int getMessageTextColor()
```
    Gets the message text color on this in-app message.
    
    Returns:
    
    See Color
  - getIcon
```
java.lang.String getIcon()
```
    Gets the Font Awesome icon on this in-app message.
    
    Returns:
    
    Unicode string for the Font Awesome icon.
  - getAnimateIn
```
boolean getAnimateIn()
```
    Gets whether this in-app message will animate in or appear suddenly.
    
    Returns:
    
    whether the in-app message will animate in.
  - getAnimateOut
```
boolean getAnimateOut()
```
    Gets whether this in-app message will animate out or disappear suddenly.
    
    Returns:
    
    whether the in-app message will animate out.
  - getClickAction
```
ClickAction getClickAction()
```
    Gets the click action of this in-app message.
    See ClickAction
    
    Returns:
    
    the click action on this in-app message.
  - getUri
```
android.net.Uri getUri()
```
    Gets the URI on this in-app message.
    See setClickAction(ClickAction, android.net.Uri)
    
    Returns:
    
    the URI on this in-app message, or null if not set.
  - getDismissType
```
DismissType getDismissType()
```
    Gets the dismiss type of this in-app message.
    See DismissType
    
    Returns:
    
    the dismiss type of this in-app message.
  - getRemoteAssetPathsForPrefetch
```
java.util.List<java.lang.String> getRemoteAssetPathsForPrefetch()
```
    Returns a path to remote assets that can be pre-fetched. To point this in-app message to pre-fetched assets, use setLocalPrefetchedAssetPaths(Map)
    
    Returns:
    
    Paths to remote assets that could be pre-fetched. Note that this list should not contain null or blank values.
  - getOrientation
```
Orientation getOrientation()
```
    Gets the preferred screen orientation for this in-app message.
    In-app messages will only display if the preferred orientation matches the current activity orientation. However, there is an important exception for tablets For in-app messages that have a preferred orientation and are being displayed on tablet, the in-app message will appear in the style of the preferred orientation regardless of actual screen orientation.
    
    Returns:
    
    the preferred screen orientation for this in-app message
  - getCropType
```
CropType getCropType()
```
    Gets the crop type for this in-app message's image.
    
    Returns:
    
    the image crop type for this in-app message's image.
  - getMessageTextAlign
```
TextAlign getMessageTextAlign()
```
    Get the text alignment for the message text.
    
    Returns:
    
    the text alignment for the message text
  - getExpirationTimestamp
```
long getExpirationTimestamp()
```
    Get the UTC timestamp at which this message expires and will not be displayed.
    
    Returns:
    
    the expiration timestamp for the message
  - getOpenUriInWebView
```
boolean getOpenUriInWebView()
```
    Whether to use AppboyWebViewActivity to open deep links from this in-app message.
    When true, the SDK will make a best effort to use AppboyWebViewActivity to open the deep link.
    When false, deep links are opened using an Intent.ACTION_VIEW intent.
    See setOpenUriInWebView(boolean)
    
    Returns:
    
    true if AppboyWebViewActivity should be used to open deep links from this in-app message.
  - getMessageType
```
MessageType getMessageType()
```
    The MessageType of this in-app message.
  - setOpenUriInWebView
```
void setOpenUriInWebView(boolean openUriInWebView)
```
    Sets whether to use AppboyWebViewActivity to open deep links from this in-app message.
    See getOpenUriInWebView()
    
    Parameters:
    
    openUriInWebView - whether AppboyWebViewActivity should be used to open deep links from this in-app message.
  - setExpirationTimestamp
```
void setExpirationTimestamp(long expirationTimestamp)
```
    Set the UTC timestamp at which this message expires and will not be displayed.
    
    Parameters:
    
    expirationTimestamp - expiration timestamp for the message
  - setMessageTextAlign
```
void setMessageTextAlign(TextAlign textAlign)
```
    Set the text alignment for the message text.
    
    Parameters:
    
    textAlign - the text alignment for the message text
  - setCropType
```
void setCropType(CropType cropType)
```
    Sets the crop type for this in-app message's image.
    
    Parameters:
    
    cropType - the image crop type for this in-app message's image.
  - setOrientation
```
void setOrientation(Orientation orientation)
```
    Sets the preferred screen orientation for this in-app message.
    In-app messages will only display if the preferred orientation matches the current activity orientation. However, there is an important exception for tablets For in-app messages that have a preferred orientation and are being displayed on tablet, the in-app message will appear in the style of the preferred orientation regardless of actual screen orientation.
    
    Parameters:
    
    orientation - the preferred screen orientation for this in-app message
  - setMessage
```
void setMessage(java.lang.String message)
```
    Sets the message text of this in-app message.
    
    Parameters:
    
    message - the desired message text for this in-app message.
  - setAnimateIn
```
void setAnimateIn(boolean animateIn)
```
    Sets whether this in-app message will animate in or appear suddenly. The recommended default is true.
    
    Parameters:
    
    animateIn - whether to animate the in-app message in.
  - setAnimateOut
```
void setAnimateOut(boolean animateOut)
```
    Sets whether this in-app message will animate out or disappear suddenly. The recommended default is true.
    
    Parameters:
    
    animateOut - whether to animate the in-app message out.
  - setClickAction
```
boolean setClickAction(ClickAction clickAction)
```
    Sets the click action of this in-app message.
    See ClickAction
    
    Parameters:
    
    clickAction - The desired click action.
    
    Returns:
    
    true if the click action was successfully set.
  - setClickAction
```
boolean setClickAction(ClickAction clickAction,
                       android.net.Uri uri)
```
    Sets the click action of this in-app message.
    See ClickAction
    
    Parameters:
    
    clickAction - The desired click action.
    
    uri - A valid Uri to navigate to on click. To set the Uri, the click action must be set to URI and a non-null Uri must be specified.
    
    Returns:
    
    true if the click action was successfully set.
  - setDismissType
```
void setDismissType(DismissType dismissType)
```
    Sets the dismiss type of this in-app message.
    See DismissType
    
    Parameters:
    
    dismissType - Desired dismiss type.
  - setDurationInMilliseconds
```
void setDurationInMilliseconds(int durationInMilliseconds)
```
    Sets the duration of this in-app message.
    
    Parameters:
    
    durationInMilliseconds - Desired in-app message duration. Inappropriately low or high values should be set to a reasonable default.
  - setBackgroundColor
```
void setBackgroundColor(int backgroundColor)
```
    Sets the background color on this in-app message.
    
    Parameters:
    
    backgroundColor - See Color
  - setIconBackgroundColor
```
void setIconBackgroundColor(int iconColor)
```
    Sets the icon background color on this in-app message. This will set the color of the icon background itself (not the icon itself).
    See setIconColor(int)
    
    Parameters:
    
    iconColor - See Color
  - setIconColor
```
void setIconColor(int iconColor)
```
    Sets the icon color on this in-app message. This will set the color of the icon itself (not the background).
    See setIconBackgroundColor(int)
    
    Parameters:
    
    iconColor - See Color
  - setMessageTextColor
```
void setMessageTextColor(int textColor)
```
    Sets the message text color on this in-app message.
    
    Parameters:
    
    textColor - See Color
  - setIcon
```
void setIcon(java.lang.String icon)
```
    Sets the icon on this in-app message.
    
    Parameters:
    
    icon - Unicode string for the desired Font Awesome icon.
  - setLocalPrefetchedAssetPaths
```
void setLocalPrefetchedAssetPaths(java.util.Map<java.lang.String,java.lang.String> remotePathToLocalAssetMap)
```
    Instruct this in-app message where to find pre-fetched assets for remote assets specified in getRemoteAssetPathsForPrefetch().
    
    Parameters:
    
    remotePathToLocalAssetMap - A map of remote assets Uris to local asset Uri paths.
  - getLocalPrefetchedAssetPaths
```
java.util.Map<java.lang.String,java.lang.String> getLocalPrefetchedAssetPaths()
```
    Gets where to find the pre-fetched remote assets specified in setLocalPrefetchedAssetPaths(Map).
    
    Returns:
    
    A Map of remote assets Uris to local asset Uri paths.
  - logImpression
```
boolean logImpression()
```
    Logs an impression on this in-app message. Impressions may only be logged once per in-app message instance.
    See logClick()
    
    Returns:
    
    true iff the impression was successfully logged.
  - logClick
```
boolean logClick()
```
    Logs a click on this in-app message. Clicks may only be logged once per in-app message instance.
    See logImpression()
    
    Returns:
    
    true iff the click was successfully logged.
  - logDisplayFailure
```
boolean logDisplayFailure(InAppMessageFailureType failureType)
```
    Logs a display failure on this in-app message. Failures can only be logged once per in-app message instance and should be logged as early as possible in the display process.
    In-app message display failures may affect campaign statistics so care should be taken when logging display failures.
    
    Parameters:
    
    failureType - The precise type of the display failure.
    
    Returns:
    
    true if the display failure was successfully logged.
  - onAfterClosed
```
void onAfterClosed()
```
    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.
  - isControl
```
boolean isControl()
```
    Gets whether this in-app message is a control for multivariate testing. Control in-app messages should not be displayed to users.
    
    Returns:
    
    whether this in-app message is a control.

Interface IInAppMessage

Method Summary

Methods inherited from interface com.braze.models.IPutIntoJson

Method Detail

getMessage

getExtras

setExtras

getDurationInMilliseconds

getBackgroundColor

getIconColor

getIconBackgroundColor

getMessageTextColor

getIcon

getAnimateIn

getAnimateOut

getClickAction

getUri

getDismissType

getRemoteAssetPathsForPrefetch

getOrientation

getCropType

getMessageTextAlign

getExpirationTimestamp

getOpenUriInWebView

getMessageType

setOpenUriInWebView

setExpirationTimestamp

setMessageTextAlign

setCropType

setOrientation

setMessage

setAnimateIn

setAnimateOut

setClickAction

setClickAction

setDismissType

setDurationInMilliseconds

setBackgroundColor

setIconBackgroundColor

setIconColor

setMessageTextColor

setIcon

setLocalPrefetchedAssetPaths

getLocalPrefetchedAssetPaths

logImpression

logClick

logDisplayFailure

onAfterClosed

isControl