com.braze.models.inappmessage

Interface IInAppMessageWithImage

All Known Implementing Classes:

InAppMessageFull, InAppMessageImmersiveBase, InAppMessageModal, InAppMessageSlideup, InAppMessageWithImageBase

public interface IInAppMessageWithImage

Method Summary

Modifier and Type	Method and Description
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.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 imageUrl) Deprecated. Please call setRemoteImageUrl(String) instead.
void	setLocalImageUrl(java.lang.String imageUrl) Sets the image on this in-app message to a local uri.
void	setRemoteImageUrl(java.lang.String imageUrl) Sets the image on this in-app message to a remote uri.

Method Detail

getImageUrl

java.lang.String getImageUrl()

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

Returns:

the image Url.

getRemoteImageUrl

java.lang.String getRemoteImageUrl()

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

Returns:

the image Url.

getLocalImageUrl

java.lang.String getLocalImageUrl()

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

Returns:

the image Url.

getBitmap

android.graphics.Bitmap getBitmap()

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

Returns:

the bitmap image on this in-app message.

getImageDownloadSuccessful

boolean getImageDownloadSuccessful()

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

Returns:

true if the image was downloaded successfully

setImageUrl

@Deprecated
void setImageUrl(java.lang.String imageUrl)

Deprecated. Please call setRemoteImageUrl(String) instead.

setLocalImageUrl

void setLocalImageUrl(java.lang.String imageUrl)

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 setRemoteImageUrl(String) See setBitmap(android.graphics.Bitmap)

Parameters:

imageUrl - Url for the desired image.

setImageDownloadSuccessful

void setImageDownloadSuccessful(boolean imageDownloadSuccessful)

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

Parameters:

imageDownloadSuccessful - value for the success of the image download

setRemoteImageUrl

void setRemoteImageUrl(java.lang.String imageUrl)

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 setLocalImageUrl(String) See setBitmap(android.graphics.Bitmap)

Parameters:

imageUrl - Url for the desired image.

setBitmap

void setBitmap(android.graphics.Bitmap bitmap)

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

Parameters:

bitmap - An optimized bitmap image.