com.mapbox.services.android.telemetry

Class MapboxTelemetry

java.lang.Object

com.mapbox.services.android.telemetry.MapboxTelemetry

All Implemented Interfaces:

LocationEngineListener, okhttp3.Callback

public class MapboxTelemetry
extends java.lang.Object
implements okhttp3.Callback, LocationEngineListener

This is the entry point to manage Mapbox telemetry

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.CopyOnWriteArrayList<TelemetryListener>	telemetryListeners

Method Summary

Modifier and Type	Method and Description
void	addAbsoluteDistanceToDestination(int absoluteDistanceToDestination, java.util.Hashtable<java.lang.String,java.lang.Object> eventWithAttributes)
void	addCommentToCancel(java.lang.String comment, java.util.Hashtable<java.lang.String,java.lang.Object> eventWithAttributes)
void	addLocationEngineName(java.lang.String locationEngineName, java.util.Hashtable<java.lang.String,java.lang.Object> eventWithAttributes)
protected void	addLocationEvent(android.location.Location location) Adds a Location Event to the system for processing
void	addPercentTimeInForeground(int percentTimeInForeground, java.util.Hashtable<java.lang.String,java.lang.Object> eventWithAttributes)
void	addPercentTimeInPortrait(int percentTimeInPortrait, java.util.Hashtable<java.lang.String,java.lang.Object> eventWithAttributes)
void	addRatingToCancel(int rating, java.util.Hashtable<java.lang.String,java.lang.Object> eventWithAttributes)
void	addTelemetryListener(TelemetryListener listener)
void	flushEventsQueueImmediately(boolean hasTurnstileEvent) Immediately attempt to send all events data in the queue to the server.
java.util.Hashtable<java.lang.String,java.lang.Object>	getCustomTurnstileEvent()
static MapboxTelemetry	getInstance() Primary access method (using singleton pattern)
void	initialize(android.content.Context context, java.lang.String accessToken, java.lang.String userAgent) Initialize MapboxTelemetry.
void	initialize(android.content.Context context, java.lang.String accessToken, java.lang.String userAgent, LocationEngine locationEngine) Initialize MapboxTelemetry.
void	initialize(android.content.Context context, java.lang.String accessToken, java.lang.String userAgent, java.lang.String sdkIdentifier, java.lang.String sdkVersion) Initialize MapboxTelemetry - with sdkIdentifier + sdkVersion
boolean	isDebugLoggingEnabled()
boolean	isTelemetryEnabled()
void	newUserAgent(java.lang.String userAgent)
void	onConnected()
void	onFailure(okhttp3.Call call, java.io.IOException e) Called when the request could not be executed due to cancellation, a connectivity problem or timeout.
void	onLocationChanged(android.location.Location location)
void	onResponse(okhttp3.Call call, okhttp3.Response response) Called when the HTTP response was successfully returned by the remote server.
void	pushEvent(java.util.Hashtable<java.lang.String,java.lang.Object> eventWithAttributes) Push interactive events to the system for processing
boolean	removeTelemetryListener(TelemetryListener listener)
void	setAccessToken(java.lang.String accessToken) Set the access token, for internal use only.
void	setCustomTurnstileEvent(java.util.Hashtable<java.lang.String,java.lang.Object> customTurnstileEvent)
void	setDebugLoggingEnabled(boolean debugLoggingEnabled)
void	setSessionIdRotationTime(int sessionIdRotationTime)
void	setTelemetryEnabled(boolean telemetryEnabled) Enables / disables telemetry

Methods inherited from class java.lang.Object

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

Field Detail

telemetryListeners

protected java.util.concurrent.CopyOnWriteArrayList<TelemetryListener> telemetryListeners

Method Detail

getInstance

public static MapboxTelemetry getInstance()

Primary access method (using singleton pattern)

Returns:

MapboxTelemetry

initialize

public void initialize(@NonNull
                       android.content.Context context,
                       @NonNull
                       java.lang.String accessToken,
                       @NonNull
                       java.lang.String userAgent,
                       @NonNull
                       LocationEngine locationEngine)

Initialize MapboxTelemetry.

Parameters:

context - The context associated with the application

accessToken - The accessToken associated with the application

userAgent - source of requests

locationEngine - Initialize telemetry with a custom location engine

initialize

public void initialize(@NonNull
                       android.content.Context context,
                       @NonNull
                       java.lang.String accessToken,
                       @NonNull
                       java.lang.String userAgent,
                       @NonNull
                       java.lang.String sdkIdentifier,
                       @NonNull
                       java.lang.String sdkVersion)

Initialize MapboxTelemetry - with sdkIdentifier + sdkVersion

Parameters:

context - The context associated with the application

accessToken - The accessToken associated with the application

userAgent - source of requests

sdkIdentifier - Identifies which sdk is sending the event

sdkVersion - version of the sdk sending the event

initialize

public void initialize(@NonNull
                       android.content.Context context,
                       @NonNull
                       java.lang.String accessToken,
                       @NonNull
                       java.lang.String userAgent)

Initialize MapboxTelemetry.

Parameters:

context - The context associated with the application

accessToken - The accessToken associated with the application

userAgent - source of requests

addTelemetryListener

public void addTelemetryListener(TelemetryListener listener)

removeTelemetryListener

public boolean removeTelemetryListener(TelemetryListener listener)

getCustomTurnstileEvent

public java.util.Hashtable<java.lang.String,java.lang.Object> getCustomTurnstileEvent()

setCustomTurnstileEvent

public void setCustomTurnstileEvent(java.util.Hashtable<java.lang.String,java.lang.Object> customTurnstileEvent)

setSessionIdRotationTime

public void setSessionIdRotationTime(int sessionIdRotationTime)

isDebugLoggingEnabled

public boolean isDebugLoggingEnabled()

setDebugLoggingEnabled

public void setDebugLoggingEnabled(boolean debugLoggingEnabled)

newUserAgent

public void newUserAgent(java.lang.String userAgent)

isTelemetryEnabled

public boolean isTelemetryEnabled()

setTelemetryEnabled

public void setTelemetryEnabled(boolean telemetryEnabled)

Enables / disables telemetry

Parameters:

telemetryEnabled - True to start telemetry, false to stop it

onConnected

public void onConnected()

Specified by:

onConnected in interface LocationEngineListener

onLocationChanged

public void onLocationChanged(android.location.Location location)

Specified by:

onLocationChanged in interface LocationEngineListener

addLocationEvent

protected void addLocationEvent(android.location.Location location)

Adds a Location Event to the system for processing

Parameters:

location - Location event

pushEvent

public void pushEvent(java.util.Hashtable<java.lang.String,java.lang.Object> eventWithAttributes)

Push interactive events to the system for processing

Parameters:

eventWithAttributes - Event with attributes

flushEventsQueueImmediately

public void flushEventsQueueImmediately(boolean hasTurnstileEvent)

Immediately attempt to send all events data in the queue to the server.

onFailure

public void onFailure(okhttp3.Call call,
                      java.io.IOException e)

Called when the request could not be executed due to cancellation, a connectivity problem or timeout. Because networks can fail during an exchange, it is possible that the remote server accepted the request before the failure.

Specified by:

onFailure in interface okhttp3.Callback

onResponse

public void onResponse(okhttp3.Call call,
                       okhttp3.Response response)
                throws java.io.IOException

Called when the HTTP response was successfully returned by the remote server. The callback may proceed to read the response body with Response.body. The response is still live until its response body is closed. The recipient of the callback may consume the response body on another thread.

Note that transport-layer success (receiving a HTTP response code, headers and body) does not necessarily indicate application-layer success: response may still indicate an unhappy HTTP response code like 404 or 500.

Specified by:

onResponse in interface okhttp3.Callback

Throws:

java.io.IOException

setAccessToken

public void setAccessToken(@NonNull
                           java.lang.String accessToken)

Set the access token, for internal use only.

This is an experimental API. Experimental APIs are quickly evolving and might change or be removed in minor versions.

Parameters:

accessToken - the new access token

addLocationEngineName

public void addLocationEngineName(@NonNull
                                  java.lang.String locationEngineName,
                                  java.util.Hashtable<java.lang.String,java.lang.Object> eventWithAttributes)

addAbsoluteDistanceToDestination

public void addAbsoluteDistanceToDestination(int absoluteDistanceToDestination,
                                             java.util.Hashtable<java.lang.String,java.lang.Object> eventWithAttributes)

addPercentTimeInForeground

public void addPercentTimeInForeground(int percentTimeInForeground,
                                       java.util.Hashtable<java.lang.String,java.lang.Object> eventWithAttributes)

addPercentTimeInPortrait

public void addPercentTimeInPortrait(int percentTimeInPortrait,
                                     java.util.Hashtable<java.lang.String,java.lang.Object> eventWithAttributes)

addRatingToCancel

public void addRatingToCancel(int rating,
                              java.util.Hashtable<java.lang.String,java.lang.Object> eventWithAttributes)

addCommentToCancel

public void addCommentToCancel(java.lang.String comment,
                               java.util.Hashtable<java.lang.String,java.lang.Object> eventWithAttributes)