com.deltadna.android.sdk

Class Engagement<T extends Engagement<T>>

java.lang.Object

com.deltadna.android.sdk.Event<T>

com.deltadna.android.sdk.Engagement<T>

public class Engagement<T extends Engagement<T>>
extends Event<T>

Constructs an engagement Event.

Field Summary

Fields inherited from class com.deltadna.android.sdk.Event

name, params

Constructor Summary

Constructors

Constructor and Description
Engagement(java.lang.String decisionPoint) Creates a new instance.
Engagement(java.lang.String decisionPoint, Params params) Creates a new instance, with parameters.
Engagement(java.lang.String decisionPoint, java.lang.String flavour) Creates a new instance, with a flavour.
Engagement(java.lang.String decisionPoint, java.lang.String flavour, Params params) Creates a new instance, with a flavour and parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDecisionPoint()
java.lang.String	getError() Gets the error message of the response after the Engage request has completed with a failure.
org.json.JSONObject	getJson() Gets the JSON body of the response after the Engage request has completed with a success.
int	getStatusCode() Gets the status code of the response after the Engage request has completed.
boolean	isCached() Gets whether the response was retrieved from the cache.
boolean	isSuccessful() Gets whether the response was successful after the Engage request has completed.
T	putParam(java.lang.String key, JsonParams value) Puts nested parameters under the key.
T	putParam(java.lang.String key, java.lang.Object value) Puts the key/value pair into the event parameters.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Engagement

public Engagement(java.lang.String decisionPoint)

Creates a new instance.

Parameters:

decisionPoint - the decision point

Engagement

public Engagement(java.lang.String decisionPoint,
                  Params params)

Creates a new instance, with parameters.

Parameters:

decisionPoint - the decision point

params - the parameters

Engagement

public Engagement(java.lang.String decisionPoint,
                  java.lang.String flavour)

Creates a new instance, with a flavour.

Parameters:

decisionPoint - the decision point

flavour - the flavour

Engagement

public Engagement(java.lang.String decisionPoint,
                  java.lang.String flavour,
                  Params params)

Creates a new instance, with a flavour and parameters.

Parameters:

decisionPoint - the decision point

flavour - the flavour

params - the parameters

Method Detail

putParam

public T putParam(java.lang.String key,
                  java.lang.Object value)

Description copied from class: Event

Puts the key/value pair into the event parameters.

Overrides:

putParam in class Event<T extends Engagement<T>>

Parameters:

key - the key

value - the value

Returns:

this T instance

putParam

public T putParam(java.lang.String key,
                  JsonParams value)

Description copied from class: Event

Puts nested parameters under the key.

Overrides:

putParam in class Event<T extends Engagement<T>>

Parameters:

key - the key

value - the value

Returns:

this T instance

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getStatusCode

public int getStatusCode()

Gets the status code of the response after the Engage request has completed.

The status code may be outside of the successful HTTP range of 2xx in the case where the request has failed, but a previous response was successfully retrieved from the cache.

Returns:

the status code of the response, or 0 if the request hasn't completed yet

isCached

public boolean isCached()

Gets whether the response was retrieved from the cache.

Returns:

true if the response is cached, else false

isSuccessful

public boolean isSuccessful()

Gets whether the response was successful after the Engage request has completed.

Returns:

true if the response was a success, else false

getJson

@Nullable
public org.json.JSONObject getJson()

Gets the JSON body of the response after the Engage request has completed with a success.

Returns:

the JSON body of the response, or null if the request failed

getError

@Nullable
public java.lang.String getError()

Gets the error message of the response after the Engage request has completed with a failure.

Returns:

the error message of the response, or null if the request succeeded

getDecisionPoint

public java.lang.String getDecisionPoint()