com.proxama.tappoint.trigger

Class Trigger

java.lang.Object

com.proxama.tappoint.trigger.Trigger

public class Trigger
extends java.lang.Object

This object represents a trigger that is defined on TapPoint. This includes any custom payload data as defined on TapPoint that has been recently synchronised.

Field Summary

Fields

Modifier and Type	Field and Description
static	CREATOR Parcelable creator for this model.

Method Summary

Methods

Modifier and Type	Method and Description
int	describeContents()
java.lang.String	getTriggerId() Retrieves the unique ID for a trigger.
JSONObject	getTriggerPayload() Retrieves the trigger's custom payload.
TriggerRateStatistics	getTriggerRateStatistics() Retrieves the trigger's rate statistics object.
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final  CREATOR

Parcelable creator for this model.

Method Detail

getTriggerId

public java.lang.String getTriggerId()

Retrieves the unique ID for a trigger.

Returns:

the trigger's unique ID.

getTriggerPayload

public JSONObject getTriggerPayload()

Retrieves the trigger's custom payload.

Returns:

a JSONObject representing the trigger payload.

getTriggerRateStatistics

public TriggerRateStatistics getTriggerRateStatistics()

Retrieves the trigger's rate statistics object. This object holds statistical information about the occurrence of trigger events. This should be used to identify whether your application provides an appropriate number of trigger events to the user over periods of time.

Returns:

TriggerRateStatistics object. Can be null.

describeContents

public int describeContents()

writeToParcel

public void writeToParcel(Parcel dest,
                 int flags)