com.braze.models.inappmessage

Class InAppMessageWithImageBase

java.lang.Object

com.braze.models.inappmessage.InAppMessageBase

com.braze.models.inappmessage.InAppMessageWithImageBase

All Implemented Interfaces:

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

Direct Known Subclasses:

InAppMessageImmersiveBase, InAppMessageSlideup

public abstract class InAppMessageWithImageBase
extends InAppMessageBase
implements IInAppMessageWithImage

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

Modifier	Constructor and Description
protected	InAppMessageWithImageBase()
	InAppMessageWithImageBase(org.json.JSONObject object, IBrazeManager appboyManager)

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	forJsonPut() Storing in-app messages serialized with this method is primarily for storage as triggered actions.
android.graphics.Bitmap	getBitmap() Gets the bitmap on this in-app message.
boolean	getImageDownloadSuccessful() Returns the status of the image download on this in-app message.
java.lang.String	getImageUrl() Gets the image url on this in-app message.
java.lang.String	getLocalImageUrl() Gets the local image url on this in-app message.
java.util.List<java.lang.String>	getRemoteAssetPathsForPrefetch() Returns a path to remote assets that can be pre-fetched.
java.lang.String	getRemoteImageUrl() Gets the remote image url on this in-app message.
void	setBitmap(android.graphics.Bitmap bitmap) Explicitly sets the bitmap on this in-app message.
void	setImageDownloadSuccessful(boolean imageDownloadSuccessful) Sets the status of the image download on this in-app message.
void	setImageUrl(java.lang.String remoteImageUrl)
void	setLocalImageUrl(java.lang.String localImageUrl) Sets the image on this in-app message to a local uri.
void	setLocalPrefetchedAssetPaths(java.util.Map<java.lang.String,java.lang.String> remotePathToLocalAssetMap) The base In-App Message class does not have assets of its own.
void	setRemoteImageUrl(java.lang.String remoteImageUrl) Sets the image on this in-app message to a remote uri.

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.braze.models.inappmessage.IInAppMessage

getMessageType

Constructor Detail

InAppMessageWithImageBase

protected InAppMessageWithImageBase()

InAppMessageWithImageBase

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

Throws:

org.json.JSONException

Method Detail

setImageUrl

public void setImageUrl(java.lang.String remoteImageUrl)

Specified by:

setImageUrl in interface IInAppMessageWithImage

getImageUrl

public java.lang.String getImageUrl()

Description copied from interface: IInAppMessageWithImage

Gets the image url on this in-app message. Equivalent to calling IInAppMessageWithImage.getRemoteImageUrl().

Specified by:

getImageUrl in interface IInAppMessageWithImage

Returns:

the image Url.

setRemoteImageUrl

public void setRemoteImageUrl(java.lang.String remoteImageUrl)

Description copied from interface: IInAppMessageWithImage

Sets the image on this in-app message to a remote uri. If a bitmap and remote image url are both set, the bitmap will be prioritized. Local uris will be prioritized over remote uris. To set a local uri, use IInAppMessageWithImage.setLocalImageUrl(String) See IInAppMessageWithImage.setBitmap(android.graphics.Bitmap)

Specified by:

setRemoteImageUrl in interface IInAppMessageWithImage

Parameters:

remoteImageUrl - Url for the desired image.

getRemoteImageUrl

public java.lang.String getRemoteImageUrl()

Description copied from interface: IInAppMessageWithImage

Gets the remote image url on this in-app message.

Specified by:

getRemoteImageUrl in interface IInAppMessageWithImage

Returns:

the image Url.

setLocalImageUrl

public void setLocalImageUrl(java.lang.String localImageUrl)

Description copied from interface: IInAppMessageWithImage

Sets the image on this in-app message to a local uri. If a bitmap and local image url are both set, the bitmap will be prioritized. Local uris will be prioritized over remote uris. To set a remote uri, use IInAppMessageWithImage.setRemoteImageUrl(String) See IInAppMessageWithImage.setBitmap(android.graphics.Bitmap)

Specified by:

setLocalImageUrl in interface IInAppMessageWithImage

Parameters:

localImageUrl - Url for the desired image.

getLocalImageUrl

public java.lang.String getLocalImageUrl()

Description copied from interface: IInAppMessageWithImage

Gets the local image url on this in-app message.

Specified by:

getLocalImageUrl in interface IInAppMessageWithImage

Returns:

the image Url.

setImageDownloadSuccessful

public void setImageDownloadSuccessful(boolean imageDownloadSuccessful)

Description copied from interface: IInAppMessageWithImage

Sets the status of the image download on this in-app message. See IInAppMessageWithImage.getImageDownloadSuccessful(). See IInAppMessage#getImageDownloadSuccessful().

Specified by:

setImageDownloadSuccessful in interface IInAppMessageWithImage

Parameters:

imageDownloadSuccessful - value for the success of the image download

getImageDownloadSuccessful

public boolean getImageDownloadSuccessful()

Description copied from interface: IInAppMessageWithImage

Returns the status of the image download on this in-app message. If the image specified by IInAppMessageWithImage.getRemoteImageUrl() could not be downloaded successfully then this should return false. Returns false by default.

Specified by:

getImageDownloadSuccessful in interface IInAppMessageWithImage

Returns:

true if the image was downloaded successfully

setBitmap

public void setBitmap(android.graphics.Bitmap bitmap)

Description copied from interface: IInAppMessageWithImage

Explicitly sets the bitmap on this in-app message. If a bitmap and image url are both set, the bitmap will be prioritized. See IInAppMessageWithImage.setLocalImageUrl(String) See IInAppMessageWithImage.setRemoteImageUrl(String)

Specified by:

setBitmap in interface IInAppMessageWithImage

Parameters:

bitmap - An optimized bitmap image.

getBitmap

public android.graphics.Bitmap getBitmap()

Description copied from interface: IInAppMessageWithImage

Gets the bitmap on this in-app message. See IInAppMessageWithImage.setBitmap(android.graphics.Bitmap)

Specified by:

getBitmap in interface IInAppMessageWithImage

Returns:

the bitmap image on this in-app message.

setLocalPrefetchedAssetPaths

public void setLocalPrefetchedAssetPaths(java.util.Map<java.lang.String,java.lang.String> remotePathToLocalAssetMap)

Description copied from class: InAppMessageBase

The base In-App Message class does not have assets of its own. Subclasses provide and manage assets.

Specified by:

setLocalPrefetchedAssetPaths in interface IInAppMessage

Overrides:

setLocalPrefetchedAssetPaths in class InAppMessageBase

Parameters:

remotePathToLocalAssetMap - A map of remote assets Uris to local asset Uri paths.

getRemoteAssetPathsForPrefetch

public java.util.List<java.lang.String> getRemoteAssetPathsForPrefetch()

Description copied from interface: IInAppMessage

Returns a path to remote assets that can be pre-fetched. To point this in-app message to pre-fetched assets, use IInAppMessage.setLocalPrefetchedAssetPaths(Map)

Specified by:

getRemoteAssetPathsForPrefetch in interface IInAppMessage

Overrides:

getRemoteAssetPathsForPrefetch in class InAppMessageBase

Returns:

An empty list. The base In-App Message class does not have assets of its own. Subclasses provide and manage assets.

forJsonPut

public org.json.JSONObject forJsonPut()

Description copied from class: InAppMessageBase

Storing in-app messages serialized with this method is primarily for storage as triggered actions. This allows in-app messages to be stored to disk and retrieved later for display when an in-app message triggered action is triggered.

Specified by:

forJsonPut in interface IPutIntoJson<org.json.JSONObject>

Overrides:

forJsonPut in class InAppMessageBase

Returns:

a JSON representation of this in-app message sufficient for restoring it as a triggered action.