EmbraceFlutterApi class abstract

Declares the functions that consist of Embrace's public API - specifically those that are only declared on Flutter. You should not use EmbraceFlutterApi directly or implement it in your own custom classes, as new functions may be added in future. Use the Embrace class instead.

Implemented types
Implementers

Constructors

EmbraceFlutterApi.new()

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addSessionProperty(String key, String value, {bool permanent = false}) → void
Annotates the session with a property defined by a key and value.
inherited
clearAllUserPersonas() → void
Clears all custom user personas from the user.
inherited
clearUserAsPayer() → void
Clears this user as a paying user.
inherited
clearUserEmail() → void
Clear the currently set user email.
inherited
clearUserIdentifier() → void
Clears the currently set user identifier.
inherited
clearUserName() → void
Clear the currently set user name.
inherited
clearUserPersona(String persona) → void
Clears the custom user persona, if it is set.
inherited
endMoment(String name, {String? identifier, Map<String, String>? properties}) → void
Signals the end of a moment with the specified name and identifier.
inherited
endSession({bool clearUserInfo = true}) → void
Manually forces the end of the current session and starts a new session.
inherited
endStartupMoment({Map<String, String>? properties}) → void
Signals that the app has completed startup.
inherited
endView(String name) → void
Log the end of a view.
inherited
getDeviceId() → Future<String?>
Get the Embrace user identifier assigned to the device.
inherited
getSessionProperties() → Future<Map<String, String>>
Returns all properties for the current session.
inherited
logBreadcrumb(String message) → void
Logs a breadcrumb.
inherited
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.
logError(String message, {Map<String, String>? properties, bool allowScreenshot = false}) → void
Remotely logs a message at ERROR level
inherited
logInfo(String message, {Map<String, String>? properties}) → void
Remotely logs a message at INFO level
inherited
logNetworkRequest({required String url, required HttpMethod method, required int startTime, required int endTime, required int bytesSent, required int bytesReceived, required int statusCode, String? error, String? traceId}) → void
Log a network request.
inherited
logWarning(String message, {Map<String, String>? properties, bool allowScreenshot = false}) → void
Remotely logs a message at WARNING level
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeSessionProperty(String key) → void
Remove an existing property from the session
inherited
setUserAsPayer() → void
Sets this user as a paying user.
inherited
setUserEmail(String email) → void
Sets the current user's email.
inherited
setUserIdentifier(String id) → void
Sets the user identifier
inherited
setUserName(String name) → void
Sets the current user's name.
inherited
setUserPersona(String persona) → void
Sets a custom user persona.
inherited
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.
startMoment(String name, {String? identifier, bool allowScreenshot = false, Map<String, String>? properties}) → void
Starts a moment.
inherited
startView(String name) → void
Log the start of a view.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited