EmbraceApi class abstract

Declares the functions that consist of Embrace's public API. You should not use EmbraceApi directly or implement it in your own custom classes, as new functions may be added in future. Use the Embrace class instead.

Implementers

Constructors

EmbraceApi.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.
clearAllUserPersonas() → void
Clears all custom user personas from the user.
clearUserAsPayer() → void
Clears this user as a paying user.
clearUserEmail() → void
Clear the currently set user email.
clearUserIdentifier() → void
Clears the currently set user identifier.
clearUserName() → void
Clear the currently set user name.
clearUserPersona(String persona) → void
Clears the custom user persona, if it is set.
endMoment(String name, {String? identifier, Map<String, String>? properties}) → void
Signals the end of a moment with the specified name and identifier.
endSession({bool clearUserInfo = true}) → void
Manually forces the end of the current session and starts a new session.
endStartupMoment({Map<String, String>? properties}) → void
Signals that the app has completed startup.
endView(String name) → void
Log the end of a view.
getDeviceId() → Future<String?>
Get the Embrace user identifier assigned to the device.
getSessionProperties() → Future<Map<String, String>>
Returns all properties for the current session.
logBreadcrumb(String message) → void
Logs a breadcrumb.
logError(String message, {Map<String, String>? properties, bool allowScreenshot = false}) → void
Remotely logs a message at ERROR level
logInfo(String message, {Map<String, String>? properties}) → void
Remotely logs a message at INFO level
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.
logWarning(String message, {Map<String, String>? properties, bool allowScreenshot = false}) → void
Remotely logs a message at WARNING level
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
setUserAsPayer() → void
Sets this user as a paying user.
setUserEmail(String email) → void
Sets the current user's email.
setUserIdentifier(String id) → void
Sets the user identifier
setUserName(String name) → void
Sets the current user's name.
setUserPersona(String persona) → void
Sets a custom user persona.
startMoment(String name, {String? identifier, bool allowScreenshot = false, Map<String, String>? properties}) → void
Starts a moment.
startView(String name) → void
Log the start of a view.
toString() → String
A string representation of this object.
inherited

Operators

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