AnalyticsClient (AWS SDK for Android - Amazon Pinpoint 2.16.12 API)

java.lang.Object
- com.amazonaws.mobileconnectors.pinpoint.analytics.AnalyticsClient

All Implemented Interfaces:

com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable
```
public class AnalyticsClient
extends Object
implements com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable
```
AnalyticsClient is the entry point into the Amazon Pinpoint SDK where AnalyticsEvent objects are created, recorded, and submitted to the Amazon Pinpoint Service. Recording Events Example: // get the event client from your PinpointManager instance AnalyticsClient analyticsClient = pinpointManager.getAnalyticsClient(); // create and record an event Event level1CompleteEvent = analyticsClient.createEvent("level1Complete"); analyticsClient.recordEvent(level1CompleteEvent); Submitting Events: The example below demonstrates how to submit events to the Amazon Pinpoint Service. You have direct control over when events are submitted in your app. Events are submitted in a background thread. Example: // submit events to the website AnalyticsClient analyticsClient = pinpointManager.getAnalyticsClient(); analyticsClient.submitEvents(); Amazon recommends that you call submitEvents once you stop the session. Note: This client will store at most 5MiB of event data locally. Past that events will be dropped. When events successfully submitted, they are removed from the local database.

Constructor Summary

Constructors
Constructor and Description
`AnalyticsClient(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context)` A client to manage creating and sending analytics events.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addGlobalAttribute(String attributeName, String attributeValue)` Adds the specified attribute to all subsequently created events Note: The maximum allowed attributes and metrics on a single event is 40.
`void`	`addGlobalAttribute(String eventType, String attributeName, String attributeValue)` Adds the specified attribute to all subsequently created events with the specified event type Note: The maximum allowed attributes and metrics on a single event is 40.
`void`	`addGlobalMetric(String metricName, Double metricValue)` Adds the specified metric to all subsequently created events Note: The maximum allowed attributes and metrics on a single event is 40.
`void`	`addGlobalMetric(String eventType, String metricName, Double metricValue)` Adds the specified metric to all subsequently created events with the specified event type Note: The maximum allowed attributes and metrics on a single event is 40.
`void`	`closeDB()` Closes the database
`AnalyticsEvent`	`createEvent(String eventType)` Create an event with the specified eventType.
`protected AnalyticsEvent`	`createEvent(String eventType, long sessionStart, Long sessionEnd, Long sessionDuration)`
`List<org.json.JSONObject>`	`getAllEvents()` Returns a list of all events
`String`	`getSessionId()` Get the current sessionId
`long`	`getSessionStartTime()` Get the session start time
`void`	`recordEvent(AnalyticsEvent event)` Record the specified event to the local filestore Please note if the amount of data stored events takes up EXCEEDS 5MiB further recordings will be dropped
`void`	`removeGlobalAttribute(String attributeName)` Removes the specified attribute.
`void`	`removeGlobalAttribute(String eventType, String attributeName)` Removes the specified attribute.
`void`	`removeGlobalMetric(String metricName)` Removes the specified metric.
`void`	`removeGlobalMetric(String eventType, String metricName)` Removes the specified metric.
`void`	`setCampaignAttributes(Map<String,String> campaign)` Deprecated. see `updateEventSourceGlobally(Map)`
`void`	`setSessionId(String sessionId)` Sets the sessionId
`void`	`setSessionStartTime(long sessionStartTime)` Set the session start time
`void`	`submitEvents()` Submit all recorded events.
`org.json.JSONObject`	`toJSONObject()`
`String`	`toString()`
`void`	`updateEventSourceGlobally(Map<String,String> attributes)` Replaces the current event source attributes (if any) with a new set of event source attributes

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AnalyticsClient
```
public AnalyticsClient(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext context)
```
    A client to manage creating and sending analytics events.
    
    Parameters:
    
    context - The PinpointContext of the Pinpoint Manager
- Method Detail
  - createEvent
```
public AnalyticsEvent createEvent(String eventType)
```
    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.
    
    Parameters:
    
    eventType - the type of event to create
    
    Returns:
    
    an Event with the specified eventType
  - createEvent
```
protected AnalyticsEvent createEvent(String eventType,
                                     long sessionStart,
                                     Long sessionEnd,
                                     Long sessionDuration)
```
  - recordEvent
```
public void recordEvent(AnalyticsEvent event)
```
    Record the specified event to the local filestore Please note if the amount of data stored events takes up EXCEEDS 5MiB further recordings will be dropped
    
    Parameters:
    
    event - The event to persist
  - submitEvents
```
public void submitEvents()
```
    Submit all recorded events. If the device is off line, this is a no-op. See PinpointConfiguration for customizing which Internet connection the SDK can submit on.
  - addGlobalAttribute
```
public void addGlobalAttribute(String attributeName,
                               String attributeValue)
```
    Adds the specified attribute to all subsequently created events Note: The maximum allowed attributes and metrics on a single event is 40. Attempts to add more may be ignored
    
    Parameters:
    
    attributeName - the name of the attribute to add
    
    attributeValue - the value of the attribute
  - addGlobalAttribute
```
public void addGlobalAttribute(String eventType,
                               String attributeName,
                               String attributeValue)
```
    Adds the specified attribute to all subsequently created 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
    
    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(String metricName,
                            Double metricValue)
```
    Adds the specified metric to all subsequently created events Note: The maximum allowed attributes and metrics on a single event is 40. Attempts to add more may be ignored
    
    Parameters:
    
    metricName - the name of the metric to add
    
    metricValue - the value of the metric
  - addGlobalMetric
```
public void addGlobalMetric(String eventType,
                            String metricName,
                            Double metricValue)
```
    Adds the specified metric to all subsequently created 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
    
    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
  - removeGlobalAttribute
```
public void removeGlobalAttribute(String attributeName)
```
    Removes the specified attribute. All subsequently created events will no longer have this global attribute.
    
    Parameters:
    
    attributeName - the name of the attribute to remove
  - removeGlobalAttribute
```
public void removeGlobalAttribute(String eventType,
                                  String attributeName)
```
    Removes the specified attribute. All subsequently created events with the specified event type will no longer have this global attribute.
    
    Parameters:
    
    eventType - the type of events to remove the attribute from
    
    attributeName - the name of the attribute to remove
  - removeGlobalMetric
```
public void removeGlobalMetric(String metricName)
```
    Removes the specified metric. All subsequently created events will no longer have this global metric.
    
    Parameters:
    
    metricName - the name of the metric to remove
  - removeGlobalMetric
```
public void removeGlobalMetric(String eventType,
                               String metricName)
```
    Removes the specified metric. All subsequently created events with the specified event type will no longer have this global metric.
    
    Parameters:
    
    eventType - the type of events to remove the metric from
    
    metricName - the name of the metric to remove
  - setCampaignAttributes
```
@Deprecated
public void setCampaignAttributes(Map<String,String> campaign)
```
    Deprecated. see updateEventSourceGlobally(Map)
    
    Parameters:
    
    campaign -
  - updateEventSourceGlobally
```
public void updateEventSourceGlobally(Map<String,String> attributes)
```
    Replaces the current event source attributes (if any) with a new set of event source attributes
    
    Parameters:
    
    attributes - map of attribute 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
  - closeDB
```
public void closeDB()
```
    Closes the database
  - getAllEvents
```
public List<org.json.JSONObject> getAllEvents()
```
    Returns a list of all events
    
    Returns:
    
    List of events
  - getSessionId
```
public String getSessionId()
```
    Get the current sessionId
    
    Returns:
    
    the sessionId
  - setSessionId
```
public void setSessionId(String sessionId)
```
    Sets the sessionId
    
    Parameters:
    
    sessionId - The sessionId
  - getSessionStartTime
```
public long getSessionStartTime()
```
    Get the session start time
    
    Returns:
    
    The Session Start Time
  - setSessionStartTime
```
public void setSessionStartTime(long sessionStartTime)
```
    Set the session start time
    
    Parameters:
    
    sessionStartTime - The sessionStartTime

Class AnalyticsClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnalyticsClient

Method Detail

createEvent

createEvent

recordEvent

submitEvents

addGlobalAttribute

addGlobalAttribute

addGlobalMetric

addGlobalMetric

removeGlobalAttribute

removeGlobalAttribute

removeGlobalMetric

removeGlobalMetric

setCampaignAttributes

updateEventSourceGlobally

toString

toJSONObject

closeDB

getAllEvents

getSessionId

setSessionId

getSessionStartTime

setSessionStartTime