com.deltadna.android.sdk

Class EngageFactory

java.lang.Object

com.deltadna.android.sdk.EngageFactory

public class EngageFactory
extends java.lang.Object

Helps with creating the different types of action available from the Engage service. It makes the request to Engage and notifies on a callback when the request completes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EngageFactory.Callback<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected DDNA	analytics

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EngageFactory(DDNA analytics)

Method Summary

Modifier and Type	Method and Description
protected static Engagement	build(java.lang.String decisionPoint, Params parameters)
void	requestGameParameters(java.lang.String decisionPoint, EngageFactory.Callback<org.json.JSONObject> callback) Requests game parameters at decisionPoint.
void	requestGameParameters(java.lang.String decisionPoint, Params parameters, EngageFactory.Callback<org.json.JSONObject> callback) Requests game parameters at decisionPoint with parameters.
void	requestImageMessage(java.lang.String decisionPoint, EngageFactory.Callback<ImageMessage> callback) Requests an ImageMessage at decisionPoint.
void	requestImageMessage(java.lang.String decisionPoint, Params parameters, EngageFactory.Callback<ImageMessage> callback) Requests an ImageMessage at decisionPoint with parameters.

Methods inherited from class java.lang.Object

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

Field Detail

analytics

protected final DDNA analytics

Constructor Detail

EngageFactory

protected EngageFactory(DDNA analytics)

Method Detail

requestGameParameters

public void requestGameParameters(java.lang.String decisionPoint,
                                  EngageFactory.Callback<org.json.JSONObject> callback)

Requests game parameters at decisionPoint.

Parameters:

decisionPoint - the decision point

callback - the callback for completion notification

Throws:

java.lang.IllegalArgumentException - if the decisionPoint is null or empty

requestGameParameters

public void requestGameParameters(java.lang.String decisionPoint,
                                  @Nullable
                                  Params parameters,
                                  EngageFactory.Callback<org.json.JSONObject> callback)

Requests game parameters at decisionPoint with parameters.

Parameters:

decisionPoint - the decision point

parameters - the parameters for the request

callback - the callback for completion notification

Throws:

java.lang.IllegalArgumentException - if the decisionPoint is null or empty

requestImageMessage

public void requestImageMessage(java.lang.String decisionPoint,
                                EngageFactory.Callback<ImageMessage> callback)

Requests an ImageMessage at decisionPoint.

The image message needs to be prepared before being shown with ImageMessage.prepare(ImageMessage.PrepareListener).

Parameters:

decisionPoint - the decision point

callback - the callback for completion notification

Throws:

java.lang.IllegalArgumentException - if the decisionPoint is null or empty

requestImageMessage

public void requestImageMessage(java.lang.String decisionPoint,
                                @Nullable
                                Params parameters,
                                EngageFactory.Callback<ImageMessage> callback)

Requests an ImageMessage at decisionPoint with parameters.

The image message needs to be prepared before being shown with ImageMessage.prepare(ImageMessage.PrepareListener).

Parameters:

decisionPoint - the decision point

parameters - the parameters for the request

callback - the callback for completion notification

Throws:

java.lang.IllegalArgumentException - if the decisionPoint is null or empty

build

protected static Engagement build(java.lang.String decisionPoint,
                                  @Nullable
                                  Params parameters)