embrace-android-sdk/io.embrace.android.embracesdk/Embrace

Embrace

public final class Embrace implements EmbraceAndroidApi
Content copied to clipboard

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.

Types

Link copied to clipboard
public enum AppFramework
Content copied to clipboard
The AppFramework that is in use.

Functions

Link copied to clipboard
@Deprecated()
public void addConnectionQualityListener(@NonNull() ConnectionQualityListener listener)
Content copied to clipboard
Registers a ConnectionQualityListener, notifying the listener each time that there is a change in the connection quality.
Link copied to clipboard
public boolean addSessionProperty(    @NonNull() String key,     @NonNull() String value,     boolean permanent)
Content copied to clipboard
Adds a property to the current session.
Link copied to clipboard
public void clearAllUserPersonas()
Content copied to clipboard
Clears all custom user personas from the user.
Link copied to clipboard
public void clearUserAsPayer()
Content copied to clipboard
Clears this user as a paying user.
Link copied to clipboard
public void clearUserEmail()
Content copied to clipboard
Clears the currently set user's email address.
Link copied to clipboard
public void clearUserIdentifier()
Content copied to clipboard
Clears the currently set user ID.
Link copied to clipboard
public void clearUsername()
Content copied to clipboard
Clears the username of the currently logged in user, for example if the user has logged out.
Link copied to clipboard
public void clearUserPersona(@NonNull() String persona)
Content copied to clipboard
Clears the custom user persona, if it is set.
Link copied to clipboard
@Deprecated()
public void disableDebugLogging()
Content copied to clipboard
This method disables debug logging.
Link copied to clipboard
@Deprecated()
public void enableDebugLogging()
Content copied to clipboard
This method enables debug logging.
Link copied to clipboard
public static void enableEarlyAnrCapture(@NonNull() Context context)
Content copied to clipboard
Starts capturing ANRs before the rest of the Embrace SDK has initialized.
Link copied to clipboard
public static void enableStartupTracing(@NonNull() Context context)
Content copied to clipboard
Capture stacktraces during startup to better understand what is happening during startup.
Link copied to clipboard
public void endAppStartup()
Content copied to clipboard
public void endAppStartup(@NonNull() Map<String, Object> properties)
Content copied to clipboard
Signals that the app has completed startup.
Link copied to clipboard
public void endEvent(@NonNull() String name)
Content copied to clipboard
public void endEvent(@NonNull() String name, @Nullable() String identifier)
Content copied to clipboard
public void endEvent(@NonNull() String name, @Nullable() Map<String, Object> properties)
Content copied to clipboard
public void endEvent(    @NonNull() String name,     @Nullable() String identifier,     @Nullable() Map<String, Object> properties)
Content copied to clipboard
Signals the end of an event with the specified name.
Link copied to clipboard
public boolean endFragment(@NonNull() String name)
Content copied to clipboard
Log the end of a fragment.
Link copied to clipboard
public synchronized void endSession()
Content copied to clipboard
public synchronized void endSession(boolean clearUserInfo)
Content copied to clipboard
Ends the current session and starts a new one.
Link copied to clipboard
@Nullable()
public ConfigService getConfigService()
Content copied to clipboard
Link copied to clipboard
@NonNull()
public String getDeviceId()
Content copied to clipboard
Get the user identifier assigned to the device by Embrace
Link copied to clipboard
@Nullable()
public FlutterInternalInterface getFlutterInternalInterface()
Content copied to clipboard
Gets the FlutterInternalInterface that should be used as the sole source of communication with the Android SDK for Flutter.
Link copied to clipboard
@NonNull()
public static Embrace getInstance()
Content copied to clipboard
Gets the singleton instance of the Embrace SDK.
Link copied to clipboard
@Nullable()
public LocalConfig getLocalConfig()
Content copied to clipboard
Link copied to clipboard
@Nullable()
public ReactNativeInternalInterface getReactNativeInternalInterface()
Content copied to clipboard
Gets the ReactNativeInternalInterface that should be used as the sole source of communication with the Android SDK for React Native.
Link copied to clipboard
@Nullable()
public Map<String, String> getSessionProperties()
Content copied to clipboard
Retrieves a map of the current session properties.
Link copied to clipboard
@NonNull()
public String getTraceIdHeader()
Content copied to clipboard
Retrieve the HTTP request header to extract trace ID from.
Link copied to clipboard
@Nullable()
public UnityInternalInterface getUnityInternalInterface()
Content copied to clipboard
Gets the UnityInternalInterface that should be used as the sole source of communication with the Android SDK for Unity.
Link copied to clipboard
public void initUnityConnection(@NotNull() AndroidToUnityCallback callback)
Content copied to clipboard
Sets up connection from Android to Unity.
Link copied to clipboard
public boolean isStarted()
Content copied to clipboard
Whether or not the SDK has been started.
Link copied to clipboard
public void logBreadcrumb(@NonNull() String message)
Content copied to clipboard
Logs a breadcrumb.
Link copied to clipboard
@Deprecated()
public void logDartError(    @Nullable() String stack,     @Nullable() String message,     @Nullable() String context,     @Nullable() String library)
Content copied to clipboard
Logs a Dart error to the Embrace SDK - this is not intended for public use.
Link copied to clipboard
@Deprecated()
public void logDartErrorWithType(    @Nullable() String stack,     @Nullable() String message,     @Nullable() String context,     @Nullable() String library,     @Nullable() String errorType)
Content copied to clipboard
Logs a Dart error to the Embrace SDK - this is not intended for public use.
Link copied to clipboard
public void logError(@NonNull() String message)
Content copied to clipboard
public void logError(@NonNull() Throwable e)
Content copied to clipboard
public void logError(@NonNull() String message, @Nullable() Map<String, Object> properties)
Content copied to clipboard
public void logError(@NonNull() Throwable e, @Nullable() Map<String, Object> properties)
Content copied to clipboard
public void logError(    @NonNull() String message,     @Nullable() Map<String, Object> properties,     boolean allowScreenshot)
Content copied to clipboard
public void logError(    @NonNull() Throwable e,     @Nullable() Map<String, Object> properties,     boolean allowScreenshot)
Content copied to clipboard
public void logError(    @NonNull() String message,     @Nullable() Map<String, Object> properties,     boolean allowScreenshot,     @Nullable() String javascriptStackTrace)
Content copied to clipboard
public void logError(    @NonNull() Throwable e,     @NonNull() String message,     @Nullable() Map<String, Object> properties,     boolean allowScreenshot)
Content copied to clipboard
public void logError(    @NonNull() String message,     @Nullable() Map<String, Object> properties,     boolean allowScreenshot,     @Nullable() String javascriptStackTrace,     boolean isException)
Content copied to clipboard
Remotely logs a message at ERROR level.
Link copied to clipboard
public void logHandledException(@NonNull() Throwable throwable, @NonNull() LogType type)
Content copied to clipboard
public void logHandledException(    @NonNull() Throwable throwable,     @NonNull() LogType type,     @NonNull() Array<StackTraceElement> customStackTrace)
Content copied to clipboard
public void logHandledException(    @NonNull() Throwable throwable,     @NonNull() LogType type,     @NonNull() Map<String, Object> properties)
Content copied to clipboard
public void logHandledException(    @NonNull() Throwable throwable,     @NonNull() LogType type,     @Nullable() Map<String, Object> properties,     @Nullable() Array<StackTraceElement> customStackTrace,     boolean takeScreenshot)
Content copied to clipboard
Logs a handled exception to the Embrace.io API for aggregation and viewing on the dashboard.
Link copied to clipboard
public void logInfo(@NonNull() String message)
Content copied to clipboard
public void logInfo(@NonNull() String message, @Nullable() Map<String, Object> properties)
Content copied to clipboard
Remotely logs a message at INFO level.
Link copied to clipboard
public void logInternalError(@Nullable() String message, @Nullable() String details)
Content copied to clipboard
Logs an internal error to the Embrace SDK - this is not intended for public use.
Link copied to clipboard
public void logNetworkCall(    @NonNull() String url,     @NonNull() HttpMethod httpMethod,     int statusCode,     long startTime,     long endTime,     long bytesSent,     long bytesReceived)
Content copied to clipboard
public void logNetworkCall(    @NonNull() String url,     @NonNull() HttpMethod httpMethod,     int statusCode,     long startTime,     long endTime,     long bytesSent,     long bytesReceived,     @Nullable() String traceId)
Content copied to clipboard
public void logNetworkCall(    @NonNull() String url,     @NonNull() HttpMethod httpMethod,     int statusCode,     long startTime,     long endTime,     long bytesSent,     long bytesReceived,     @Nullable() String traceId,     @Nullable() NetworkCaptureData networkCaptureData)
Content copied to clipboard
Logs the fact that a network call occurred.
Link copied to clipboard
public void logNetworkClientError(    @NonNull() String url,     @NonNull() HttpMethod httpMethod,     long startTime,     long endTime,     @NonNull() String errorType,     @NonNull() String errorMessage)
Content copied to clipboard
public void logNetworkClientError(    @NonNull() String url,     @NonNull() HttpMethod httpMethod,     long startTime,     long endTime,     @NonNull() String errorType,     @NonNull() String errorMessage,     @Nullable() String traceId)
Content copied to clipboard
public void logNetworkClientError(    @NonNull() String url,     @NonNull() HttpMethod httpMethod,     long startTime,     long endTime,     @NonNull() String errorType,     @NonNull() String errorMessage,     @Nullable() String traceId,     @Nullable() NetworkCaptureData networkCaptureData)
Content copied to clipboard
Logs the fact that an exception was thrown when attempting to make a network call.
Link copied to clipboard
public void logNetworkRequest(@NonNull() EmbraceNetworkRequest request)
Content copied to clipboard
public void logNetworkRequest(@NonNull() EmbraceNetworkRequestV2 request)
Content copied to clipboard
public void logNetworkRequest(    @NonNull() String url,     int httpMethod,     long startTime,     long endTime,     int bytesSent,     int bytesReceived,     int statusCode,     @Nullable() String error)
Content copied to clipboard
Manually logs a network request.
Link copied to clipboard
@Deprecated()
public void logPushNotification(    @Nullable() String title,     @Nullable() String body,     @Nullable() String topic,     @Nullable() String id,     @Nullable() Integer notificationPriority,     @NotNull() Integer messageDeliveredPriority,     @NotNull() PushNotificationBreadcrumb.NotificationType notificationType)
Content copied to clipboard
public void logPushNotification(    @Nullable() String title,     @Nullable() String body,     @Nullable() String topic,     @Nullable() String id,     @Nullable() Integer notificationPriority,     @NotNull() Integer messageDeliveredPriority,     @NotNull() Boolean isNotification,     @NotNull() Boolean hasData)
Content copied to clipboard
Saves captured push notification information into session payload
Link copied to clipboard
public void logRnAction(    @NonNull() String name,     long startTime,     long endTime,     @NonNull() Map<String, Object> properties,     int bytesSent,     @NonNull() String output)
Content copied to clipboard
Logs a React Native Redux Action.
Link copied to clipboard
public void logRnView(@NonNull() String screen)
Content copied to clipboard
Logs the fact that a particular view was entered.
Link copied to clipboard
@Deprecated()
public void logUnhandledJsException(    @NonNull() String name,     @NonNull() String message,     @Nullable() String type,     @Nullable() String stacktrace)
Content copied to clipboard
Logs a javascript unhandled exception.
Link copied to clipboard
@Deprecated()
public void logUnhandledUnityException(@NonNull() String message, @Nullable() String stacktrace)
Content copied to clipboard
Logs a Unity unhandled exception.
Link copied to clipboard
public void logWarning(@NonNull() String message)
Content copied to clipboard
public void logWarning(@NonNull() String message, @Nullable() Map<String, Object> properties)
Content copied to clipboard
public void logWarning(    @NonNull() String message,     @Nullable() Map<String, Object> properties,     boolean allowScreenshot)
Content copied to clipboard
public void logWarning(    @NonNull() String message,     @Nullable() Map<String, Object> properties,     boolean allowScreenshot,     @Nullable() String javascriptStackTrace)
Content copied to clipboard
Remotely logs a message at WARN level.
Link copied to clipboard
@Deprecated()
public void removeConnectionQualityListener(@NonNull() ConnectionQualityListener listener)
Content copied to clipboard
Removes a registered ConnectionQualityListener, suspending connection quality notifications.
Link copied to clipboard
public boolean removeSessionProperty(@NonNull() String key)
Content copied to clipboard
Removes a property from the current session.
Link copied to clipboard
public void sampleCurrentThreadDuringAnrs()
Content copied to clipboard
Link copied to clipboard
public boolean setAppId(@NonNull() String appId)
Content copied to clipboard
Sets a custom app ID that overrides the one specified at build time.
Link copied to clipboard
@Deprecated()
public void setDartVersion(@Nullable() String version)
Content copied to clipboard
Sets the Dart version - this is not intended for public use.
Link copied to clipboard
@Deprecated()
public void setEmbraceFlutterSdkVersion(@Nullable() String version)
Content copied to clipboard
Sets the Embrace Flutter SDK version - this is not intended for public use.
Link copied to clipboard
@Deprecated()
public void setJavaScriptBundleURL(@NonNull() String url)
Content copied to clipboard
Sets the path of the javascript bundle.
Link copied to clipboard
@Deprecated()
public void setJavaScriptPatchNumber(@NonNull() String number)
Content copied to clipboard
Sets javascript patch number.
Link copied to clipboard
@Deprecated()
public void setLogLevel(@NonNull() EmbraceLogger.Severity severity)
Content copied to clipboard
This method sets a logging level, but this logging level is never used.
Link copied to clipboard
public void setProcessStartedByNotification()
Content copied to clipboard
Link copied to clipboard
public void setReactNativeSdkVersion(@NonNull() String version)
Content copied to clipboard
Sets the Embrace RN SDK version.
Link copied to clipboard
@Deprecated()
public void setReactNativeVersionNumber(@NonNull() String version)
Content copied to clipboard
Sets the react native version number.
Link copied to clipboard
@Deprecated()
public void setUnityMetaData(@NonNull() String unityVersion, @NonNull() String buildGuid)
Content copied to clipboard
Sets the Unity version and Unity build id.
@Deprecated()
public void setUnityMetaData(    @NonNull() String unityVersion,     @NonNull() String buildGuid,     @Nullable() String unitySdkVersion)
Content copied to clipboard
Sets the Unity version, Unity build id and Unity SDK version.
Link copied to clipboard
public void setUserAsPayer()
Content copied to clipboard
Sets this user as a paying user.
Link copied to clipboard
public void setUserEmail(@Nullable() String email)
Content copied to clipboard
Sets the current user's email address.
Link copied to clipboard
public void setUserIdentifier(@Nullable() String userId)
Content copied to clipboard
Sets the user ID.
Link copied to clipboard
public void setUsername(@Nullable() String username)
Content copied to clipboard
Sets the username of the currently logged in user.
Link copied to clipboard
public void setUserPersona(@NonNull() String persona)
Content copied to clipboard
Sets a custom user persona.
Link copied to clipboard
public boolean shouldCaptureNetworkBody(@NonNull() String url, @NonNull() String method)
Content copied to clipboard
Determine if a network call should be captured based on the network capture rules
Link copied to clipboard
public void start(@NonNull() Context context)
Content copied to clipboard
public void start(@NonNull() Context context, boolean enableIntegrationTesting)
Content copied to clipboard
public void start(    @NonNull() Context context,     boolean enableIntegrationTesting,     @NonNull() Embrace.AppFramework appFramework)
Content copied to clipboard
Starts instrumentation of the Android application using the Embrace SDK.
Link copied to clipboard
public void startEvent(@NonNull() String name)
Content copied to clipboard
public void startEvent(@NonNull() String name, @Nullable() String identifier)
Content copied to clipboard
public void startEvent(    @NonNull() String name,     @Nullable() String identifier,     boolean allowScreenshot)
Content copied to clipboard
public void startEvent(    @NonNull() String name,     @Nullable() String identifier,     @Nullable() Map<String, Object> properties)
Content copied to clipboard
public void startEvent(    @NonNull() String name,     @Nullable() String identifier,     boolean allowScreenshot,     @Nullable() Map<String, Object> properties)
Content copied to clipboard
Starts an event or 'moment'.
Link copied to clipboard
public boolean startFragment(@NonNull() String name)
Content copied to clipboard
Log the start of a fragment.
Link copied to clipboard
public void throwException()
Content copied to clipboard
Causes a crash with an exception.