AtatusSdk class
A singleton for the Atatus SDK.
Once initialized, individual features can be access through the logs
and rum member variables. If a feature is disabled (either
because they were not configured or the SDK has not been initialized) the
member variables will default to null
- Available extensions
Properties
- configuration → AtatusConfiguration?
-
no setter
-
firstPartyHosts
→ List<
FirstPartyHost> -
An unmodifiable list of first party hosts for tracing.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- isAgentEnabled → bool
-
no setter
- logs → AtatusLogging
-
no setter
- platform → AtatusSdkPlatform
-
Internal extension access to the configured platform
no setter
- rum → AtatusRum?
-
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sdkVerbosity ↔ CoreLoggerLevel
-
Set the verbosity of the Atatus SDK. Set to CoreLoggerLevel.warn by
default. All internal logging is enabled only when kDebugMode is
set.
getter/setter pair
Methods
-
addAccountExtraInfo(
Map< String, Object?> extraInfo) → void - Add custom attributes to the current account information.
-
addUserExtraInfo(
Map< String, Object?> extraInfo) → void - Add custom attributes to the current user information
-
attachToBackgroundIsolate(
) → Future< void> - Attach an initialized Atatus Flutter SDK the currently active background isolate.
-
attachToExisting(
AtatusAttachConfiguration config) → Future< void> - Attach the Atatus Flutter SDK to an already initialized Atatus Native (iOS or Android) SDK. This is used for "app in app" embedding of Flutter.
-
clearAccountInfo(
) → void - Clear the current account information.
-
clearAllData(
) → void - Clears all data that has not already been sent to Atatus servers.
-
clearUserInfo(
) → void - Clear the current user information.
-
flushAndDeinitialize(
) → Future< void> - This function is not part of the public interface for Atatus, and may not be available in all targets. Used for integration and E2E testing purposes only.
-
getPlugin<
T> () → T? - Get an instance of a AtatusPlugin that was registered with AtatusConfiguration.addPlugin
-
headerTypesForHost(
Uri uri) → Set< TracingHeaderType> -
initialize(
AtatusConfiguration configuration, TrackingConsent trackingConsent) → Future< void> -
Initialize the AtatusSdk with the provided
configuration. -
isFirstPartyHost(
Uri uri) → bool -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setAccountInfo(
{required String id, String? name, Map< String, Object?> extraInfo = const {}}) → void - Sets current account information.
-
setTrackingConsent(
TrackingConsent trackingConsent) → void -
setUserInfo(
{required String id, String? name, String? email, Map< String, Object?> extraInfo = const {}}) → void - Sets current user information. User information will be added to logs, traces and RUM events automatically.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateConfigurationInfo(
LateConfigurationProperty property, bool value) → void -
Available on AtatusSdk, provided by the AtatusInternal extension
Update a late configuration property
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- agentName → String
-
The name of this agent.
no setter
- agentSource → String
-
The source type of the agent.
no setter
- instance → AtatusSdk
-
no setter
- sdkVersion → String
-
The version of this SDK.
no setter
Static Methods
-
initializeForTesting(
) → void - Set Atatus to use No Op platform implementations.
-
runApp(
AtatusConfiguration configuration, TrackingConsent trackingConsent, AppRunner runner) → Future< void> - A helper function that will initialize Atatus and setup error reporting