com.amazonaws.mobileconnectors.amazonmobileanalytics.internal.event

Class DefaultEventClient

java.lang.Object

com.amazonaws.mobileconnectors.amazonmobileanalytics.internal.event.DefaultEventClient

All Implemented Interfaces:

EventClient, JSONSerializable, InternalEventClient

public class DefaultEventClient
extends java.lang.Object
implements InternalEventClient, JSONSerializable

Method Summary

Methods

Modifier and Type	Method and Description
void	addEventObserver(EventObserver observer)
void	addGlobalAttribute(java.lang.String attributeName, java.lang.String attributeValue) Adds the specified attribute to all subsequently recorded events Note: The maximum allowed attributes and metrics on a single event is 40.
void	addGlobalAttribute(java.lang.String eventType, java.lang.String attributeName, java.lang.String attributeValue) Adds the specified attribute to all subsequently recorded events with the specified event type Note: The maximum allowed attributes and metrics on a single event is 40.
void	addGlobalMetric(java.lang.String metricName, java.lang.Double metricValue) Adds the specified metric to all subsequently recorded events Note: The maximum allowed attributes and metrics on a single event is 40.
void	addGlobalMetric(java.lang.String eventType, java.lang.String metricName, java.lang.Double metricValue) Adds the specified metric to all subsequently recorded events with the specified event type Note: The maximum allowed attributes and metrics on a single event is 40.
AnalyticsEvent	createEvent(java.lang.String eventType) Create an event with the specified eventType.
AnalyticsEvent	createEvent(java.lang.String eventType, boolean applyGlobalAttributes)
InternalEvent	createInternalEvent(java.lang.String eventType, long sessionStart, java.lang.Long sessionEnd, java.lang.Long sessionDuration)
boolean	getAllowEventCollection()
protected java.util.List<EventObserver>	getEventObservers()
static DefaultEventClient	newInstance(AnalyticsContext context, boolean allowEventCollection)
protected void	notifyObservers(InternalEvent event)
void	recordEvent(AnalyticsEvent event) Record the specified event to the local filestore
void	removeEventObserver(EventObserver observer)
void	removeGlobalAttribute(java.lang.String attributeName) Removes the specified attribute.
void	removeGlobalAttribute(java.lang.String eventType, java.lang.String attributeName) Removes the specified attribute.
void	removeGlobalMetric(java.lang.String metricName) Removes the specified metric.
void	removeGlobalMetric(java.lang.String eventType, java.lang.String metricName) Removes the specified metric.
void	setSessionId(java.lang.String sessionId)
void	setSessionStartTime(long sessionStartTime)
void	submitEvents() Submit all recorded events.
org.json.JSONObject	toJSONObject()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static DefaultEventClient newInstance(AnalyticsContext context,
                             boolean allowEventCollection)

recordEvent

public void recordEvent(AnalyticsEvent event)

Description copied from interface: EventClient

Record the specified event to the local filestore

Specified by:

recordEvent in interface EventClient

Parameters:

event - The event to persist

createEvent

public AnalyticsEvent createEvent(java.lang.String eventType)

Description copied from interface: EventClient

Create an event with the specified eventType. The eventType is a developer defined String that can be used to distinguish between different scenarios within an application. Note: You can have at most 1,500 different eventTypes per app.

Specified by:

createEvent in interface EventClient

Parameters:

eventType - the type of event to create

Returns:

an Event with the specified eventType

createEvent

public AnalyticsEvent createEvent(java.lang.String eventType,
                         boolean applyGlobalAttributes)

Specified by:

createEvent in interface InternalEventClient

createInternalEvent

public InternalEvent createInternalEvent(java.lang.String eventType,
                                long sessionStart,
                                java.lang.Long sessionEnd,
                                java.lang.Long sessionDuration)

Specified by:

createInternalEvent in interface InternalEventClient

submitEvents

public void submitEvents()

Description copied from interface: EventClient

Submit all recorded events. If a submission occurred in the last minute, this request is ignored. If the device is off line, this is a no-op. See AnalyticsConfig for customizing which Internet connection the SDK can submit on.

Specified by:

submitEvents in interface EventClient

addGlobalAttribute

public void addGlobalAttribute(java.lang.String attributeName,
                      java.lang.String attributeValue)

Description copied from interface: EventClient

Adds the specified attribute to all subsequently recorded events Note: The maximum allowed attributes and metrics on a single event is 40. Attempts to add more may be ignored

Specified by:

addGlobalAttribute in interface EventClient

Parameters:

attributeName - the name of the attribute to add

attributeValue - the value of the attribute

addGlobalAttribute

public void addGlobalAttribute(java.lang.String eventType,
                      java.lang.String attributeName,
                      java.lang.String attributeValue)

Description copied from interface: EventClient

Adds the specified attribute to all subsequently recorded events with the specified event type Note: The maximum allowed attributes and metrics on a single event is 40. Attempts to add more may be ignored

Specified by:

addGlobalAttribute in interface EventClient

Parameters:

eventType - the type of events to add the attribute to

attributeName - the name of the attribute to add

attributeValue - the value of the attribute

addGlobalMetric

public void addGlobalMetric(java.lang.String metricName,
                   java.lang.Double metricValue)

Description copied from interface: EventClient

Adds the specified metric to all subsequently recorded events Note: The maximum allowed attributes and metrics on a single event is 40. Attempts to add more may be ignored

Specified by:

addGlobalMetric in interface EventClient

Parameters:

metricName - the name of the metric to add

metricValue - the value of the metric

addGlobalMetric

public void addGlobalMetric(java.lang.String eventType,
                   java.lang.String metricName,
                   java.lang.Double metricValue)

Description copied from interface: EventClient

Adds the specified metric to all subsequently recorded events with the specified event type Note: The maximum allowed attributes and metrics on a single event is 40. Attempts to add more may be ignored

Specified by:

addGlobalMetric in interface EventClient

Parameters:

eventType - the type of events to add the metric to

metricName - the name of the metric to add

metricValue - the value of the metric

addEventObserver

public void addEventObserver(EventObserver observer)

Specified by:

addEventObserver in interface InternalEventClient

removeEventObserver

public void removeEventObserver(EventObserver observer)

Specified by:

removeEventObserver in interface InternalEventClient

getEventObservers

protected java.util.List<EventObserver> getEventObservers()

notifyObservers

protected void notifyObservers(InternalEvent event)

removeGlobalAttribute

public void removeGlobalAttribute(java.lang.String attributeName)

Description copied from interface: EventClient

Removes the specified attribute. All subsequently recorded events will no longer have this global attribute.

Specified by:

removeGlobalAttribute in interface EventClient

Parameters:

attributeName - the name of the attribute to remove

removeGlobalAttribute

public void removeGlobalAttribute(java.lang.String eventType,
                         java.lang.String attributeName)

Description copied from interface: EventClient

Removes the specified attribute. All subsequently recorded events with the specified event type will no longer have this global attribute.

Specified by:

removeGlobalAttribute in interface EventClient

Parameters:

eventType - the type of events to remove the attribute from

attributeName - the name of the attribute to remove

removeGlobalMetric

public void removeGlobalMetric(java.lang.String metricName)

Description copied from interface: EventClient

Removes the specified metric. All subsequently recorded events will no longer have this global metric.

Specified by:

removeGlobalMetric in interface EventClient

Parameters:

metricName - the name of the metric to remove

removeGlobalMetric

public void removeGlobalMetric(java.lang.String eventType,
                      java.lang.String metricName)

Description copied from interface: EventClient

Removes the specified metric. All subsequently recorded events with the specified event type will no longer have this global metric.

Specified by:

removeGlobalMetric in interface EventClient

Parameters:

eventType - the type of events to remove the metric from

metricName - the name of the metric to remove

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toJSONObject

public org.json.JSONObject toJSONObject()

Specified by:

toJSONObject in interface JSONSerializable

getAllowEventCollection

public boolean getAllowEventCollection()

setSessionId

public void setSessionId(java.lang.String sessionId)

Specified by:

setSessionId in interface InternalEventClient

setSessionStartTime

public void setSessionStartTime(long sessionStartTime)

Specified by:

setSessionStartTime in interface InternalEventClient