com.amazonaws.mobileconnectors.pinpoint.analytics

Class AnalyticsEvent

java.lang.Object

com.amazonaws.mobileconnectors.pinpoint.analytics.AnalyticsEvent

All Implemented Interfaces:

com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable

public class AnalyticsEvent
extends Object
implements com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable

Represents the any useful action you wish to record within your application

The example below demonstrates how to record events.

 // get the event client from your amazon PinpointManager instance
 EventClient analyticsClient = mobileAnalyticsManager.getAnalyticsClient();

 // create and record the view event
 Event level1CompleteEvent = analyticsClient.createEvent("level1Complete");
 analyticsClient.recordEvent(level1CompleteEvent);

 // record if the user bought an upgrade (conversion)
 if (userBoughtUpgrade) {
     Event level1UserBoughtUpgradeEvent = analyticsClient.createEvent("level1UserBoughtUpgrade");
     analyticsClient.recordEvent(level1UserBoughtUpgradeEvent);
 }
 

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String name, String value) Adds an attribute to this AnalyticsEvent with the specified key.
void	addMetric(String name, Double value) Adds a metric to this AnalyticsEvent with the specified key.
com.amazonaws.mobileconnectors.pinpoint.internal.event.ClientContext	createClientContext(String networkType)
static AnalyticsEvent	createFromEvent(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context, String sessionId, long timestamp, AnalyticsEvent copyEvent)
Map<String,String>	getAllAttributes() Returns a map of all attributes contained within this AnalyticsEvent
Map<String,Double>	getAllMetrics() Returns a map of all metrics contained within this AnalyticsEvent
String	getAttribute(String name) Returns the value of the attribute with the specified name.
String	getEventId()
Long	getEventTimestamp()
String	getEventType() Returns the name/type of this AnalyticsEvent
Double	getMetric(String name) Returns the value of the metric with the specified name.
String	getSdkName()
String	getSdkVersion()
PinpointSession	getSession()
String	getUniqueId()
boolean	hasAttribute(String attributeName) Determines if this AnalyticsEvent contains a specific attribute
boolean	hasMetric(String metricName) Determines if this AnalyticsEvent contains a specific metric.
static AnalyticsEvent	newInstance(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context, String sessionId, Long sessionStart, Long sessionEnd, Long duration, long timestamp, String eventType)
static AnalyticsEvent	newInstance(String eventId, String eventType, Map<String,String> attributes, Map<String,Double> metrics, com.amazonaws.mobileconnectors.pinpoint.internal.core.util.SDKInfo sdkInfo, String sessionId, Long sessionStart, Long sessionStop, Long sessionDuration, long timestamp, String uniqueId, com.amazonaws.mobileconnectors.pinpoint.internal.core.system.AndroidAppDetails appDetails, com.amazonaws.mobileconnectors.pinpoint.internal.core.system.AndroidDeviceDetails deviceDetails)
org.json.JSONObject	toJSONObject()
String	toString()
static org.json.JSONObject	translateFromEvent(AnalyticsEvent source)
static AnalyticsEvent	translateToEvent(org.json.JSONObject source)
AnalyticsEvent	withAttribute(String name, String value) Adds an attribute to this AnalyticsEvent with the specified key.
AnalyticsEvent	withMetric(String name, Double value) Adds a metric to this AnalyticsEvent with the specified key.

Methods inherited from class java.lang.Object

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

Method Detail

createFromEvent

public static AnalyticsEvent createFromEvent(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context,
                                             String sessionId,
                                             long timestamp,
                                             AnalyticsEvent copyEvent)

newInstance

public static AnalyticsEvent newInstance(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context,
                                         String sessionId,
                                         Long sessionStart,
                                         Long sessionEnd,
                                         Long duration,
                                         long timestamp,
                                         String eventType)

newInstance

public static AnalyticsEvent newInstance(String eventId,
                                         String eventType,
                                         Map<String,String> attributes,
                                         Map<String,Double> metrics,
                                         com.amazonaws.mobileconnectors.pinpoint.internal.core.util.SDKInfo sdkInfo,
                                         String sessionId,
                                         Long sessionStart,
                                         Long sessionStop,
                                         Long sessionDuration,
                                         long timestamp,
                                         String uniqueId,
                                         com.amazonaws.mobileconnectors.pinpoint.internal.core.system.AndroidAppDetails appDetails,
                                         com.amazonaws.mobileconnectors.pinpoint.internal.core.system.AndroidDeviceDetails deviceDetails)

getEventId

public String getEventId()

addAttribute

public void addAttribute(String name,
                         String value)

Adds an attribute to this AnalyticsEvent with the specified key. Only 40 attributes/metrics are allowed to be added to an Event. If 40 attribute/metrics already exist on this Event, the call may be ignored.

Parameters:

name - The name of the attribute. The name will be truncated if it exceeds 50 characters.

value - The value of the attribute. The value will be truncated if it exceeds 200 characters.

hasAttribute

public boolean hasAttribute(String attributeName)

Determines if this AnalyticsEvent contains a specific attribute

Parameters:

attributeName - The name of the attribute

Returns:

true if this AnalyticsEvent has an attribute with the specified name, false otherwise

addMetric

public void addMetric(String name,
                      Double value)

Adds a metric to this AnalyticsEvent with the specified key. Only 40 attributes/metrics are allowed to be added to an Event. If 50 attribute/metrics already exist on this Event, the call may be ignored.

Parameters:

name - The name of the metric. The name will be truncated if it exceeds 50 characters.

value - The value of the metric.

hasMetric

public boolean hasMetric(String metricName)

Determines if this AnalyticsEvent contains a specific metric.

Parameters:

metricName - The name of the metric

Returns:

true if this AnalyticsEvent has a metric with the specified name, false otherwise

getEventType

public String getEventType()

Returns the name/type of this AnalyticsEvent

Returns:

the name/type of this AnalyticsEvent

getAttribute

public String getAttribute(String name)

Returns the value of the attribute with the specified name.

Parameters:

name - The name of the attribute to return

Returns:

The attribute with the specified name, or null if attribute does not exist

getMetric

public Double getMetric(String name)

Returns the value of the metric with the specified name.

Parameters:

name - The name of the metric to return

Returns:

The metric with the specified name, or null if metric does not exist

getSession

public PinpointSession getSession()

getEventTimestamp

public Long getEventTimestamp()

getUniqueId

public String getUniqueId()

getSdkName

public String getSdkName()

getSdkVersion

public String getSdkVersion()

withAttribute

public AnalyticsEvent withAttribute(String name,
                                    String value)

Adds an attribute to this AnalyticsEvent with the specified key. Only 40 attributes/metrics are allowed to be added to an AnalyticsEvent. If 40 attribute/metrics already exist on this AnalyticsEvent, the call may be ignored.

Parameters:

name - The name of the attribute. The name will be truncated if it exceeds 50 characters.

value - The value of the attribute. The value will be truncated if it exceeds 200 characters.

Returns:

The same AnalyticsEvent instance is returned to allow for method chaining.

withMetric

public AnalyticsEvent withMetric(String name,
                                 Double value)

Adds a metric to this AnalyticsEvent with the specified key. Only 40 attributes/metrics are allowed to be added to an AnalyticsEvent. If 40 attribute/metrics already exist on this AnalyticsEvent, the call may be ignored.

Parameters:

name - The name of the metric. The name will be truncated if it exceeds 50 characters.

value - The value of the metric.

Returns:

The same AnalyticsEvent instance is returned to allow for method chaining.

getAllAttributes

public Map<String,String> getAllAttributes()

Returns a map of all attributes contained within this AnalyticsEvent

Returns:

a map of all attributes, where the attribute names are the keys and the attribute values are the values

getAllMetrics

public Map<String,Double> getAllMetrics()

Returns a map of all metrics contained within this AnalyticsEvent

Returns:

a map of all metrics, where the metric names are the keys and the metric values are the values

toString

public String toString()

Overrides:

toString in class Object

toJSONObject

public org.json.JSONObject toJSONObject()

Specified by:

toJSONObject in interface com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable

createClientContext

public com.amazonaws.mobileconnectors.pinpoint.internal.event.ClientContext createClientContext(String networkType)

translateFromEvent

public static org.json.JSONObject translateFromEvent(AnalyticsEvent source)

translateToEvent

public static AnalyticsEvent translateToEvent(org.json.JSONObject source)
                                       throws org.json.JSONException

Throws:

org.json.JSONException