Embrace class

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

Implemented types

• EmbraceFlutterApi

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addBreadcrumb(String message) → void

Adds a breadcrumb.

override

addSessionProperty(String key, String value, {bool permanent = false}) → void

Annotates the session with a property defined by a key and value.

override

addUserPersona(String persona) → void

Adds a custom user persona.

override

clearAllUserPersonas() → void

Clears all custom user personas from the user.

override

clearUserAsPayer() → void

Clears this user as a paying user.

override

clearUserEmail() → void

Clear the currently set user email.

override

clearUserIdentifier() → void

Clears the currently set user identifier.

override

clearUserName() → void

Clear the currently set user name.

override

clearUserPersona(String persona) → void

Clears the custom user persona, if it is set.

override

endSession({bool clearUserInfo = true}) → void

Manually forces the end of the current session and starts a new session.

override

endView(String name) → void

Log the end of a view.

override

generateW3cTraceparent(String? traceId, String? spanId) → Future<String?>

Generates a W3C traceparent header for network span forwarding, or null if this has not been enabled. For iOS, it's required to pass in the spanId and traceId of the network span that is being forwarded. For Android, these parameters are ignored.

override

getCurrentSessionId() → Future<String?>

Get the ID for the current session.

override

getDeviceId() → Future<String?>

Get the Embrace user identifier assigned to the device.

override

getLastRunEndState() → Future<LastRunEndState>

Get the exit status (crash or clean exit) of the last time the application was run.

override

logDartError(Object error, StackTrace stack) → void

Manually logs a Dart error or exception to Embrace. You should use this if you want to capture errors/exceptions and report them to Embrace. A good example would be to call this function from within a try-catch block.

override

logError(String message, {Map<String, String>? properties}) → void

Remotely logs a message at ERROR level

override

logHandledDartError(Object error, StackTrace stack) → void

Manually logs a handled Dart error or exception to Embrace. This is equivalent to logDartError but records the error as handled. Handled errors do not count towards calculation of error-free sessions.

override

logInfo(String message, {Map<String, String>? properties}) → void

Remotely logs a message at INFO level

override

logMessage(String message, Severity severity, {Map<String, String>? properties}) → void

Remotely logs a message at the given severity level

override

logPushNotification(String? title, String? body, {String? subtitle, int? badge, String? category, String? from, String? messageId, int? priority, bool hasNotification = false, bool hasData = false}) → void

Manually logs a push notification as a breadcrumb

override

logWarning(String message, {Map<String, String>? properties}) → void

Remotely logs a message at WARNING level

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

recordCompletedSpan<T>(String name, int startTimeMs, int endTimeMs, {ErrorCode? errorCode, EmbraceSpan? parent, Map<String, String>? attributes, List<EmbraceSpanEvent>? events}) → Future<bool>

Record a span with the given name, error code, parent, start time, and end time (epoch time in milliseconds). Passing in a parent that is null will result in a new trace with the new span as its root. A non-null ErrorCode can be passed in to denote the operation the span represents was ended unsuccessfully under the stated circumstances. You can also pass in a Map with String keys and values to be used as the attributes of the recorded span, or a List of EmbraceSpanEvent to be used as the events of the recorded span.

override

recordNetworkRequest(EmbraceNetworkRequest request) → void

Records a network request to Embrace.

override

removeSessionProperty(String key) → void

Remove an existing property from the session

override

setUserAsPayer() → void

Sets this user as a paying user.

override

setUserEmail(String email) → void

Sets the current user's email.

override

setUserIdentifier(String id) → void

Sets the user identifier

override

setUserName(String name) → void

Sets the current user's name.

override

start(FutureOr<void> action(), {bool enableIntegrationTesting = false}) → Future<void>

Starts instrumentation of Dart code by the Embrace SDK. This should be wrap the entire contents of your Dart main() function if you wish to capture Dart errors.

override

startSpan(String name, {EmbraceSpan? parent, int? startTimeMs}) → Future<EmbraceSpan?>

Create and start a new span. Returns a reference to the new span on success and null on failure.

override

startView(String name) → void

Log the start of a view.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

instance → Embrace

Entry point for the SDK. Use this to call send logs and other information to Embrace.

no setter