com.deltadna.android.sdk

Class ImageMessage

java.lang.Object

com.deltadna.android.sdk.ImageMessage

All Implemented Interfaces:

java.io.Serializable

public final class ImageMessage
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImageMessage.Button Description of an image message button.
static interface	ImageMessage.PrepareListener

Method Summary

Modifier and Type	Method and Description
static ImageMessage	create(Engagement engagement) Creates an Image Message from an Engagement once it has been populated with response data after a successful request.
void	prepare(ImageMessage.PrepareListener listener) Prepares the Image Message for use, by downloading the image.
boolean	prepared() Gets the prepared state.
void	show(android.app.Activity activity, int requestCode) Opens the ImageMessageActivity for showing this Image Message.

Methods inherited from class java.lang.Object

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

Method Detail

prepared

public boolean prepared()

Gets the prepared state.

Returns:

true if ready to use, else false

prepare

public void prepare(ImageMessage.PrepareListener listener)

Prepares the Image Message for use, by downloading the image.

Parameters:

listener - the listener for receiving prepared state

show

public void show(android.app.Activity activity,
                 int requestCode)

Opens the ImageMessageActivity for showing this Image Message.

Parameters:

activity - the Activity from which the request is being started

requestCode - the request code that will be used in Activity.onActivityResult(int, int, Intent) for the result

Throws:

java.lang.IllegalStateException - if the Image Message is not prepared

create

@Nullable
public static ImageMessage create(Engagement engagement)

Creates an Image Message from an Engagement once it has been populated with response data after a successful request.

null may be returned in case the Engagement was not set-up to display an Image Message.

Parameters:

engagement - the Engagement with response data

Returns:

the Image Message created from engagement, else null