io.embrace.android.embracesdk

Class Embrace

java.lang.Object

io.embrace.android.embracesdk.Embrace

public final class Embrace
extends java.lang.Object

Entry point for the SDK. This class is part of the Embrace Public API.

Contains a singleton instance of itself, and is used for initializing the SDK.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Embrace.AppFramework

Constructor Summary

Constructors

Constructor and Description
Embrace()

Method Summary

Modifier and Type	Method and Description
void	addConnectionQualityListener(ConnectionQualityListener listener) Registers a ConnectionQualityListener, notifying the listener each time that there is a change in the connection quality.
boolean	addSessionProperty(java.lang.String key, java.lang.String value, boolean permanent)
void	clearAllUserPersonas() Clears all custom user personas from the user.
void	clearUserAsPayer() Clears this user as a paying user.
void	clearUserEmail() Clears the currently set user's email address.
void	clearUserIdentifier() Clears the currently set user ID.
void	clearUsername() Clears the username of the currently logged in user, for example if the user has logged out.
void	clearUserPersona(java.lang.String persona) Clears the custom user persona, if it is set.
void	disableDebugLogging() This method disables debug logging.
void	enableDebugLogging() This method enables debug logging.
void	endAppStartup() Signals that the app has completed startup.
void	endAppStartup(java.util.Map<java.lang.String,java.lang.Object> properties) Signals that the app has completed startup.
void	endEvent(java.lang.String name) Signals the end of an event with the specified name.
void	endEvent(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> properties) Signals the end of an event with the specified name.
void	endEvent(java.lang.String name, java.lang.String identifier) Signals the end of an event with the specified name.
void	endEvent(java.lang.String name, java.lang.String identifier, java.util.Map<java.lang.String,java.lang.Object> properties) Signals the end of an event with the specified name.
boolean	endFragment(java.lang.String name) Log the end of a fragment.
void	endSession() Ends the current session and starts a new one.
void	endSession(boolean clearUserInfo) Ends the current session and starts a new one.
java.lang.String	getDeviceId() Get the user identifier assigned to the device by Embrace
static Embrace	getInstance() Gets the singleton instance of the Embrace SDK.
LocalConfig	getLocalConfig()
java.util.Map<java.lang.String,java.lang.String>	getSessionProperties()
java.lang.String	getTraceIdHeader() Retrieve the HTTP request header to extract trace ID from.
boolean	isStarted() Whether or not the SDK has been started.
void	logBreadcrumb(java.lang.String message) Logs a breadcrumb.
void	logError(java.lang.String message) Remotely logs a message at ERROR level.
void	logError(java.lang.String message, java.util.Map<java.lang.String,java.lang.Object> properties) Remotely logs a message at ERROR level.
void	logError(java.lang.String message, java.util.Map<java.lang.String,java.lang.Object> properties, boolean allowScreenshot) Remotely logs a message at ERROR level.
void	logError(java.lang.String message, java.util.Map<java.lang.String,java.lang.Object> properties, boolean allowScreenshot, java.lang.String javascriptStackTrace) Remotely logs a message at ERROR level.
void	logError(java.lang.String message, java.util.Map<java.lang.String,java.lang.Object> properties, boolean allowScreenshot, java.lang.String javascriptStackTrace, boolean isException) Remotely logs a message at ERROR level.
void	logError(java.lang.Throwable e) Remotely logs a message at ERROR level.
void	logError(java.lang.Throwable e, java.util.Map<java.lang.String,java.lang.Object> properties) Remotely logs a message at ERROR level.
void	logError(java.lang.Throwable e, java.util.Map<java.lang.String,java.lang.Object> properties, boolean allowScreenshot) Remotely logs a message at ERROR level.
void	logError(java.lang.Throwable e, java.lang.String message, java.util.Map<java.lang.String,java.lang.Object> properties, boolean allowScreenshot) Remotely logs a message at ERROR level.
void	logInfo(java.lang.String message) Remotely logs a message at INFO level.
void	logInfo(java.lang.String message, java.util.Map<java.lang.String,java.lang.Object> properties) Remotely logs a message at INFO level.
void	logNetworkCall(java.lang.String url, HttpMethod httpMethod, int statusCode, long startTime, long endTime, long bytesSent, long bytesReceived) Logs the fact that a network call occurred.
void	logNetworkCall(java.lang.String url, HttpMethod httpMethod, int statusCode, long startTime, long endTime, long bytesSent, long bytesReceived, java.lang.String traceId) Logs the fact that a network call occurred.
void	logNetworkClientError(java.lang.String url, HttpMethod httpMethod, long startTime, long endTime, java.lang.String errorType, java.lang.String errorMessage) Logs the fact that an exception was thrown when attempting to make a network call.
void	logNetworkClientError(java.lang.String url, HttpMethod httpMethod, long startTime, long endTime, java.lang.String errorType, java.lang.String errorMessage, java.lang.String traceId) Logs the fact that an exception was thrown when attempting to make a network call.
void	logNetworkRequest(EmbraceNetworkRequest request) Manually log a network request.
void	logNetworkRequest(EmbraceNetworkRequestV2 request) Manually log a network request.
void	logNetworkRequest(java.lang.String url, int httpMethod, long startTime, long endTime, int bytesSent, int bytesReceived, int statusCode, java.lang.String error) Manually log a network request.
void	logUnhandledJsException(java.lang.String name, java.lang.String message, java.lang.String type, java.lang.String stacktrace) Logs a javascript unhandled exception.
void	logWarning(java.lang.String message) Remotely logs a message at WARN level.
void	logWarning(java.lang.String message, java.util.Map<java.lang.String,java.lang.Object> properties) Remotely logs a message at WARN level.
void	logWarning(java.lang.String message, java.util.Map<java.lang.String,java.lang.Object> properties, boolean allowScreenshot) Remotely logs a message at WARN level.
void	logWarning(java.lang.String message, java.util.Map<java.lang.String,java.lang.Object> properties, boolean allowScreenshot, java.lang.String javascriptStackTrace) Remotely logs a message at WARN level.
void	removeConnectionQualityListener(ConnectionQualityListener listener) Removes a registered ConnectionQualityListener, suspending connection quality notifications.
boolean	removeSessionProperty(java.lang.String key)
boolean	setAppId(java.lang.String appId) Sets a custom app ID that overrides the one specified at build time.
void	setJavaScriptBundleURL(java.lang.String url) Sets the path of the javascript bundle.
void	setJavaScriptPatchNumber(java.lang.String number) Sets javascript patch number.
void	setLogLevel(EmbraceLogger.Severity severity) Deprecated. as the log level is never used. Use EmbraceLogger.
void	setReactNativeVersionNumber(java.lang.String version) Sets the react native version number.
void	setUnityMetaData(java.lang.String unityVersion, java.lang.String buildGUID) Sets the Unity version and Unity build id.
void	setUserAsPayer() Sets this user as a paying user.
void	setUserEmail(java.lang.String email) Sets the current user's email address.
void	setUserIdentifier(java.lang.String userId) Sets the user ID.
void	setUsername(java.lang.String username) Sets the username of the currently logged in user.
void	setUserPersona(java.lang.String persona) Sets a custom user persona.
void	start(android.content.Context context) Starts instrumentation of the Android application using the Embrace SDK.
void	start(android.content.Context context, boolean enableIntegrationTesting) Starts instrumentation of the Android application using the Embrace SDK.
void	start(android.content.Context context, boolean enableIntegrationTesting, Embrace.AppFramework appFramework) Starts instrumentation of the Android application using the Embrace SDK.
void	startEvent(java.lang.String name) Starts an event or 'moment'.
void	startEvent(java.lang.String name, java.lang.String identifier) Starts an event or 'moment'.
void	startEvent(java.lang.String name, java.lang.String identifier, boolean allowScreenshot) Starts an event or 'moment'.
void	startEvent(java.lang.String name, java.lang.String identifier, boolean allowScreenshot, java.util.Map<java.lang.String,java.lang.Object> properties) Starts an event or 'moment'.
void	startEvent(java.lang.String name, java.lang.String identifier, java.util.Map<java.lang.String,java.lang.Object> properties) Starts an event or 'moment'.
boolean	startFragment(java.lang.String name) Log the start of a fragment.
void	throwException() Causes a crash with an exception.

Methods inherited from class java.lang.Object

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

Constructor Detail

Embrace

public Embrace()

Method Detail

getInstance

public static Embrace getInstance()

Gets the singleton instance of the Embrace SDK.

Returns:

the instance of the Embrace SDK

start

public void start(android.content.Context context)

Starts instrumentation of the Android application using the Embrace SDK. This should be called during creation of the application, as early as possible.

See Embrace Docs for integration instructions. For compatibility with other networking SDKs such as Akamai, the Embrace SDK must be initialized after any other SDK.

Parameters:

context - an instance of the application context

start

public void start(android.content.Context context,
                  boolean enableIntegrationTesting)

Starts instrumentation of the Android application using the Embrace SDK. This should be called during creation of the application, as early as possible.

See Embrace Docs for integration instructions. For compatibility with other networking SDKs such as Akamai, the Embrace SDK must be initialized after any other SDK.

Parameters:

context - an instance of context

enableIntegrationTesting - if true, debug sessions (those which are not part of a release APK) will go to the live integration testing tab of the dashboard. If false, they will appear in 'recent sessions'.

start

public void start(android.content.Context context,
                  boolean enableIntegrationTesting,
                  Embrace.AppFramework appFramework)

Starts instrumentation of the Android application using the Embrace SDK. This should be called during creation of the application, as early as possible.

See Embrace Docs for integration instructions. For compatibility with other networking SDKs such as Akamai, the Embrace SDK must be initialized after any other SDK.

Parameters:

context - an instance of context

enableIntegrationTesting - if true, debug sessions (those which are not part of a release APK) will go to the live integration testing tab of the dashboard. If false, they will appear in 'recent sessions'.

isStarted

public boolean isStarted()

Whether or not the SDK has been started.

Returns:

true if the SDK is started, false otherwise

setAppId

public boolean setAppId(java.lang.String appId)

Sets a custom app ID that overrides the one specified at build time. Must be called before the SDK is started.

Parameters:

appId - custom app ID

Returns:

true if the app ID could be set, false otherwise.

setLogLevel

@Deprecated
public void setLogLevel(EmbraceLogger.Severity severity)

Deprecated. as the log level is never used. Use EmbraceLogger.

This method sets a logging level, but this logging level is never used.

Parameters:

severity - the severity

enableDebugLogging

public void enableDebugLogging()

This method enables debug logging.

disableDebugLogging

public void disableDebugLogging()

This method disables debug logging.

setUserIdentifier

public void setUserIdentifier(java.lang.String userId)

Sets the user ID. This would typically be some form of unique identifier such as a UUID or database key for the user.

Parameters:

userId - the unique identifier for the user

clearUserIdentifier

public void clearUserIdentifier()

Clears the currently set user ID. For example, if the user logs out.

setUserEmail

public void setUserEmail(java.lang.String email)

Sets the current user's email address.

Parameters:

email - the email address of the current user

clearUserEmail

public void clearUserEmail()

Clears the currently set user's email address.

setUserAsPayer

public void setUserAsPayer()

Sets this user as a paying user. This adds a persona to the user's identity.

clearUserAsPayer

public void clearUserAsPayer()

Clears this user as a paying user. This would typically be called if a user is no longer paying for the service and has reverted back to a basic user.

setUserPersona

public void setUserPersona(java.lang.String persona)

Sets a custom user persona. A persona is a trait associated with a given user.

Parameters:

persona - the persona to set

clearUserPersona

public void clearUserPersona(java.lang.String persona)

Clears the custom user persona, if it is set.

Parameters:

persona - the persona to clear

clearAllUserPersonas

public void clearAllUserPersonas()

Clears all custom user personas from the user.

addSessionProperty

public boolean addSessionProperty(java.lang.String key,
                                  java.lang.String value,
                                  boolean permanent)

removeSessionProperty

public boolean removeSessionProperty(java.lang.String key)

getSessionProperties

public java.util.Map<java.lang.String,java.lang.String> getSessionProperties()

setUsername

public void setUsername(java.lang.String username)

Sets the username of the currently logged in user.

Parameters:

username - the username to set

clearUsername

public void clearUsername()

Clears the username of the currently logged in user, for example if the user has logged out.

startEvent

public void startEvent(java.lang.String name)

Starts an event or 'moment'. Events are used for encapsulating particular activities within the app, such as a user adding an item to their shopping cart.

The length of time an event takes to execute is recorded, and a screenshot can be taken if an event is 'late'.

Parameters:

name - a name identifying the event

startEvent

public void startEvent(java.lang.String name,
                       java.lang.String identifier)

Starts an event or 'moment'. Events are used for encapsulating particular activities within the app, such as a user adding an item to their shopping cart.

The length of time an event takes to execute is recorded, and a screenshot can be taken if an event is 'late'.

Parameters:

name - a name identifying the event

identifier - an identifier distinguishing between multiple events with the same name

startEvent

public void startEvent(java.lang.String name,
                       java.lang.String identifier,
                       boolean allowScreenshot)

Starts an event or 'moment'. Events are used for encapsulating particular activities within the app, such as a user adding an item to their shopping cart.

The length of time an event takes to execute is recorded, and a screenshot can be taken if an event is 'late'.

Parameters:

name - a name identifying the event

identifier - an identifier distinguishing between multiple events with the same name

allowScreenshot - true if a screenshot should be taken for a late event, false otherwise

startEvent

public void startEvent(java.lang.String name,
                       java.lang.String identifier,
                       java.util.Map<java.lang.String,java.lang.Object> properties)

Starts an event or 'moment'. Events are used for encapsulating particular activities within the app, such as a user adding an item to their shopping cart.

The length of time an event takes to execute is recorded, and a screenshot can be taken if an event is 'late'.

Parameters:

name - a name identifying the event

identifier - an identifier distinguishing between multiple events with the same name

properties - custom key-value pairs to provide with the event

startEvent

public void startEvent(java.lang.String name,
                       java.lang.String identifier,
                       boolean allowScreenshot,
                       java.util.Map<java.lang.String,java.lang.Object> properties)

Starts an event or 'moment'. Events are used for encapsulating particular activities within the app, such as a user adding an item to their shopping cart.

The length of time an event takes to execute is recorded, and a screenshot can be taken if an event is 'late'.

Parameters:

name - a name identifying the event

identifier - an identifier distinguishing between multiple events with the same name

allowScreenshot - true if a screenshot should be taken for a late event, false otherwise

properties - custom key-value pairs to provide with the event

endEvent

public void endEvent(java.lang.String name)

Signals the end of an event with the specified name.

The duration of the event is computed, and a screenshot taken (if enabled) if the event was late.

Parameters:

name - the name of the event to end

endEvent

public void endEvent(java.lang.String name,
                     java.lang.String identifier)

Signals the end of an event with the specified name.

The duration of the event is computed, and a screenshot taken (if enabled) if the event was late.

Parameters:

name - the name of the event to end

identifier - the identifier of the event to end, distinguishing between events with the same name

endEvent

public void endEvent(java.lang.String name,
                     java.util.Map<java.lang.String,java.lang.Object> properties)

Signals the end of an event with the specified name.

The duration of the event is computed, and a screenshot taken (if enabled) if the event was late.

Parameters:

name - the name of the event to end

properties - custom key-value pairs to provide with the event

endEvent

public void endEvent(java.lang.String name,
                     java.lang.String identifier,
                     java.util.Map<java.lang.String,java.lang.Object> properties)

Signals the end of an event with the specified name.

The duration of the event is computed, and a screenshot taken (if enabled) if the event was late.

Parameters:

name - the name of the event to end

identifier - the identifier of the event to end, distinguishing between events with the same name

properties - custom key-value pairs to provide with the event

endAppStartup

public void endAppStartup()

Signals that the app has completed startup.

endAppStartup

public void endAppStartup(java.util.Map<java.lang.String,java.lang.Object> properties)

Signals that the app has completed startup.

Parameters:

properties - properties to include as part of the startup moment

getTraceIdHeader

public java.lang.String getTraceIdHeader()

Retrieve the HTTP request header to extract trace ID from.

Returns:

the Trace ID header.

logNetworkRequest

public void logNetworkRequest(java.lang.String url,
                              int httpMethod,
                              long startTime,
                              long endTime,
                              int bytesSent,
                              int bytesReceived,
                              int statusCode,
                              java.lang.String error)

Manually log a network request. In most cases the Embrace SDK.

Parameters:

url - the URL of the network call

httpMethod - the int value of the HTTP method of the network call

startTime - the time that the network call started

endTime - the time that the network call was completed

bytesSent - the number of bytes sent as part of the network call

bytesReceived - the number of bytes returned by the server in response to the network call

statusCode - the status code returned by the server

error - the error returned by the exception

logNetworkRequest

public void logNetworkRequest(EmbraceNetworkRequestV2 request)

Manually log a network request. In most cases the Embrace SDK.

Parameters:

request - An EmbraceNetworkRequestV2 with at least the following set: url, method, start time, end time, and either status code or error

logNetworkRequest

public void logNetworkRequest(EmbraceNetworkRequest request)

Manually log a network request. In most cases the Embrace SDK.

Parameters:

request - An EmbraceNetworkRequest with at least the following set: url, method, start time, end time, and either status code or error

logNetworkCall

public void logNetworkCall(java.lang.String url,
                           HttpMethod httpMethod,
                           int statusCode,
                           long startTime,
                           long endTime,
                           long bytesSent,
                           long bytesReceived)

Logs the fact that a network call occurred. These are recorded and sent to Embrace as part of a particular session.

Parameters:

url - the URL of the network call

httpMethod - the HTTP method of the network call

statusCode - the status code returned by the server

startTime - the time that the network call started

endTime - the time that the network call was completed

bytesSent - the number of bytes sent as part of the network call

bytesReceived - the number of bytes returned by the server in response to the network call

logNetworkCall

public void logNetworkCall(java.lang.String url,
                           HttpMethod httpMethod,
                           int statusCode,
                           long startTime,
                           long endTime,
                           long bytesSent,
                           long bytesReceived,
                           java.lang.String traceId)

Logs the fact that a network call occurred. These are recorded and sent to Embrace as part of a particular session.

Parameters:

url - the URL of the network call

httpMethod - the HTTP method of the network call

statusCode - the status code returned by the server

startTime - the time that the network call started

endTime - the time that the network call was completed

bytesSent - the number of bytes sent as part of the network call

bytesReceived - the number of bytes returned by the server in response to the network call

traceId - the optional trace id that can be used to trace a particular request

logNetworkClientError

public void logNetworkClientError(java.lang.String url,
                                  HttpMethod httpMethod,
                                  long startTime,
                                  long endTime,
                                  java.lang.String errorType,
                                  java.lang.String errorMessage)

Logs the fact that an exception was thrown when attempting to make a network call.

These are client-side exceptions and not server-side exceptions, such as a DNS error or failure to connect to the remote server.

Parameters:

url - the URL of the network call

httpMethod - the HTTP method of the network call

startTime - the time that the network call started

endTime - the time that the network call was completed

errorType - the type of the exception

errorMessage - the message returned by the exception

logNetworkClientError

public void logNetworkClientError(java.lang.String url,
                                  HttpMethod httpMethod,
                                  long startTime,
                                  long endTime,
                                  java.lang.String errorType,
                                  java.lang.String errorMessage,
                                  java.lang.String traceId)

Logs the fact that an exception was thrown when attempting to make a network call.

These are client-side exceptions and not server-side exceptions, such as a DNS error or failure to connect to the remote server.

Parameters:

url - the URL of the network call

httpMethod - the HTTP method of the network call

startTime - the time that the network call started

endTime - the time that the network call was completed

errorType - the type of the exception

errorMessage - the message returned by the exception

traceId - the optional trace id that can be used to trace a particular request

logInfo

public void logInfo(java.lang.String message)

Remotely logs a message at INFO level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.

Parameters:

message - the message to remotely log

logInfo

public void logInfo(java.lang.String message,
                    java.util.Map<java.lang.String,java.lang.Object> properties)

Remotely logs a message at INFO level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.

Parameters:

message - the message to remotely log

properties - custom key-value pairs to include with the log message

logWarning

public void logWarning(java.lang.String message)

Remotely logs a message at WARN level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.

Parameters:

message - the message to remotely log

logWarning

public void logWarning(java.lang.String message,
                       java.util.Map<java.lang.String,java.lang.Object> properties)

Remotely logs a message at WARN level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.

Parameters:

message - the message to remotely log

properties - custom key-value pairs to include with the log message

logWarning

public void logWarning(java.lang.String message,
                       java.util.Map<java.lang.String,java.lang.Object> properties,
                       boolean allowScreenshot)

Remotely logs a message at WARN level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.

Parameters:

message - the message to remotely log

properties - custom key-value pairs to include with the log message

allowScreenshot - true if a screenshot should be taken for this message, false otherwise

logWarning

public void logWarning(java.lang.String message,
                       java.util.Map<java.lang.String,java.lang.Object> properties,
                       boolean allowScreenshot,
                       java.lang.String javascriptStackTrace)

Remotely logs a message at WARN level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.

Parameters:

message - the message to remotely log

properties - custom key-value pairs to include with the log message

allowScreenshot - true if a screenshot should be taken for this message, false otherwise

javascriptStackTrace - javascript stack trace coming from the the RN side

logError

public void logError(java.lang.String message)

Remotely logs a message at ERROR level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.

If enabled for the current app, a screenshot will automatically be taken when the error is logged, and displayed on the dashboard with the error message.

Parameters:

message - the message to remotely log

logError

public void logError(java.lang.String message,
                     java.util.Map<java.lang.String,java.lang.Object> properties)

Remotely logs a message at ERROR level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.

If enabled for the current app, a screenshot will automatically be taken when the error is logged, and displayed on the dashboard with the error message.

Parameters:

message - the message to remotely log

properties - custom key-value pairs to include with the log message

logError

public void logError(java.lang.String message,
                     java.util.Map<java.lang.String,java.lang.Object> properties,
                     boolean allowScreenshot)

Remotely logs a message at ERROR level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.

If enabled for the current app, a screenshot will automatically be taken when the error is logged, and displayed on the dashboard with the error message.

Parameters:

message - the message to remotely log

properties - custom key-value pairs to include with the log message

allowScreenshot - true if a screenshot should be taken for this message, false otherwise

logError

public void logError(java.lang.String message,
                     java.util.Map<java.lang.String,java.lang.Object> properties,
                     boolean allowScreenshot,
                     java.lang.String javascriptStackTrace)

Remotely logs a message at ERROR level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.

If enabled for the current app, a screenshot will automatically be taken when the error is logged, and displayed on the dashboard with the error message.

Parameters:

message - the message to remotely log

properties - custom key-value pairs to include with the log message

allowScreenshot - true if a screenshot should be taken for this message, false otherwise

javascriptStackTrace - javascript stack trace coming from the the RN side

logError

public void logError(java.lang.String message,
                     java.util.Map<java.lang.String,java.lang.Object> properties,
                     boolean allowScreenshot,
                     java.lang.String javascriptStackTrace,
                     boolean isException)

Remotely logs a message at ERROR level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.

If enabled for the current app, a screenshot will automatically be taken when the error is logged, and displayed on the dashboard with the error message.

Parameters:

message - the message to remotely log

properties - custom key-value pairs to include with the log message

allowScreenshot - true if a screenshot should be taken for this message, false otherwise

javascriptStackTrace - javascript stack trace coming from the the RN side

isException - mark the log as an exception

logError

public void logError(java.lang.Throwable e)

Remotely logs a message at ERROR level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.

If enabled for the current app, a screenshot will automatically be taken when the error is logged, and displayed on the dashboard with the error message.

The stacktrace from the throwable will be used instead of the stack trace from where this method is called.

Parameters:

e - the throwable to remotely log

logError

public void logError(java.lang.Throwable e,
                     java.util.Map<java.lang.String,java.lang.Object> properties)

Remotely logs a message at ERROR level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.

If enabled for the current app, a screenshot will automatically be taken when the error is logged, and displayed on the dashboard with the error message.

The stacktrace from the throwable will be used instead of the stack trace from where this method is called.

Parameters:

e - the throwable to remotely log

properties - custom key-value pairs to include with the log message

logError

public void logError(java.lang.Throwable e,
                     java.util.Map<java.lang.String,java.lang.Object> properties,
                     boolean allowScreenshot)

Remotely logs a message at ERROR level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.

If enabled for the current app, a screenshot will automatically be taken when the error is logged, and displayed on the dashboard with the error message.

The stacktrace from the throwable will be used instead of the stack trace from where this method is called.

Parameters:

e - the throwable to remotely log

properties - custom key-value pairs to include with the log message

allowScreenshot - true if a screenshot should be taken for this message, false otherwise

logError

public void logError(java.lang.Throwable e,
                     java.lang.String message,
                     java.util.Map<java.lang.String,java.lang.Object> properties,
                     boolean allowScreenshot)

Remotely logs a message at ERROR level. These log messages will appear as part of the session timeline, and can be used to describe what was happening at a particular time within the app.

If enabled for the current app, a screenshot will automatically be taken when the error is logged, and displayed on the dashboard with the error message.

The stacktrace from the throwable will be used instead of the stack trace from where this method is called.

Parameters:

e - the throwable to remotely log

message - message to log (overrides getLocalizedMessage() from e)

properties - custom key-value pairs to include with the log message

allowScreenshot - true if a screenshot should be taken for this message, false otherwise

logBreadcrumb

public void logBreadcrumb(java.lang.String message)

Logs a breadcrumb.

Breadcrumbs track a user's journey through the application and will be shown on the timeline.

Parameters:

message - the name of the breadcrumb to log

logUnhandledJsException

public void logUnhandledJsException(java.lang.String name,
                                    java.lang.String message,
                                    java.lang.String type,
                                    java.lang.String stacktrace)

Logs a javascript unhandled exception.

Parameters:

name - name of the exception.

message - exception message.

type - error type.

stacktrace - exception stacktrace.

setReactNativeVersionNumber

public void setReactNativeVersionNumber(java.lang.String version)

Sets the react native version number.

Parameters:

version - react native version number.

setJavaScriptPatchNumber

public void setJavaScriptPatchNumber(java.lang.String number)

Sets javascript patch number.

Parameters:

number - javascript patch number.

setJavaScriptBundleURL

public void setJavaScriptBundleURL(java.lang.String url)

Sets the path of the javascript bundle.

Parameters:

url - path of the javascript bundle.

setUnityMetaData

public void setUnityMetaData(java.lang.String unityVersion,
                             java.lang.String buildGUID)

Sets the Unity version and Unity build id.

Parameters:

unityVersion - of the Unity SDK

buildGUID - if the Unity build

addConnectionQualityListener

public void addConnectionQualityListener(ConnectionQualityListener listener)

Registers a ConnectionQualityListener, notifying the listener each time that there is a change in the connection quality.

Parameters:

listener - the listener to register

removeConnectionQualityListener

public void removeConnectionQualityListener(ConnectionQualityListener listener)

Removes a registered ConnectionQualityListener, suspending connection quality notifications.

Parameters:

listener - the listener to remove

endSession

public void endSession()

Ends the current session and starts a new one.

endSession

public void endSession(boolean clearUserInfo)

Ends the current session and starts a new one.

Cleans all the user info on the device.

getDeviceId

public java.lang.String getDeviceId()

Get the user identifier assigned to the device by Embrace

Returns:

the device identifier created by Embrace

throwException

public void throwException()

Causes a crash with an exception. Use this for test purposes only

startFragment

public boolean startFragment(java.lang.String name)

Log the start of a fragment.

A matching call to endFragment must be made.

Parameters:

name - the name of the fragment to log

endFragment

public boolean endFragment(java.lang.String name)

Log the end of a fragment.

A matching call to startFragment must be made before this is called.

Parameters:

name - the name of the fragment to log

getLocalConfig

public LocalConfig getLocalConfig()