Flutter Quickstart

Supported on: iOS SDK 1.0.61+ · Android SDK 1.0.33+ · Flutter SDK 1.0.3+

This guide walks you through configuring the AppDNA SDK, identifying users, and tracking your first event in a Flutter application.

1. Configure the SDK

Initialize AppDNA as early as possible in your app lifecycle, typically in your main() function before runApp():

import 'package:firebase_core/firebase_core.dart';
import 'package:appdna_sdk/appdna_sdk.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await Firebase.initializeApp();

  await AppDNA.configure(
    apiKey: "adn_live_xxx",
    env: AppDNAEnvironment.production,
    options: AppDNAOptions(logLevel: AppDNALogLevel.debug),
  );

  runApp(const MyApp());
}

If you don’t have your own Firebase: Keep Firebase.initializeApp() as shown above.If you already use Firebase in your Flutter app: Remove the Firebase.initializeApp() call and just call AppDNA.configure(...). The SDK automatically initializes its own named Firebase instance from GoogleService-Info-AppDNA.plist (iOS) and google-services-appdna.json (Android). Your existing Firebase setup is not affected.

Call AppDNA.configure(...) exactly once before using any other SDK methods. Calling it multiple times will result in undefined behavior.

Configuration Options

The AppDNAOptions class lets you customize SDK behavior:

Parameter	Type	Default	Description
`flushInterval`	`int?`	`30`	Seconds between automatic event flushes. When not set, the server’s value from the bootstrap request applies once the bootstrap succeeds, if it is positive
`batchSize`	`int?`	not set	A cap on the batch size the network sets (100 on Wi-Fi or wired; on cellular, 20 when the system marks the connection expensive (iOS: every cellular connection) or metered (Android: most plans), otherwise 50): the queue is flushed when it reaches the smaller of the two, and each upload sends at most that many. When not set, the value the server returns with the SDK’s bootstrap request is the cap if it is positive (100 today, so nothing is capped). A value below 1 is ignored (the SDK logs a warning), as if not set. Passing the default (100) is the same as not setting it. If your app already passed `batchSize` to an earlier SDK version — where it had no effect — it is now a hard cap: each upload sends at most that many events. Remove it, or raise it, unless that is what you want.
`configTTL`	`int?`	`3600`	Seconds before cached config is considered stale. When not set, the server’s value from the bootstrap request applies once the bootstrap succeeds, if it is positive
`logLevel`	`AppDNALogLevel?`	`AppDNALogLevel.warning`	Verbosity of SDK console logs
`billingProvider`	`AppDNABillingProvider?`	`AppDNABillingProvider.storeKit2`	Billing integration to use
`notificationIcon`	`int?`	`null`	Android only: notification small-icon drawable resource id
`requireConsent`	`bool?`	`false`	When `true`, analytics stay off until `setConsent(true)`
`vetoTimeout`	`int?`	`5`	Seconds a host hook on the Flutter bridge may take before the SDK applies the hook default; sign-in actions in `onBeforeStepAdvance` always wait at least 120 s, a `refresh` gets 8 s (a larger `vetoTimeout` does not extend it), and an `onBeforeStepRender` reply is used only within 3 s
`framework`	`String?`	`null`	Deprecated/ignored — the native bridge injects the framework tag itself

Environment

The AppDNAEnvironment enum controls which backend environment the SDK targets:

Value	Description
`AppDNAEnvironment.production`	Production API and configuration
`AppDNAEnvironment.staging`	Staging API for testing

Log Level

The AppDNALogLevel enum controls console log verbosity:

Value	Description
`AppDNALogLevel.none`	No logging
`AppDNALogLevel.error`	Errors only
`AppDNALogLevel.warning`	Errors and warnings
`AppDNALogLevel.info`	Errors, warnings, and info
`AppDNALogLevel.debug`	All messages including debug

Use AppDNALogLevel.debug during development to see all SDK activity. Switch to AppDNALogLevel.warning or AppDNALogLevel.none for production builds.

Billing Provider

The AppDNABillingProvider class specifies which billing system to use. The value-less providers are static consts; adapty is a factory that carries your Adapty public SDK key:

Value	Description
`AppDNABillingProvider.storeKit2`	AppDNA’s own billing: StoreKit 2 on iOS, Google Play Billing on Android (default)
`AppDNABillingProvider.revenueCat`	RevenueCat is your purchase SDK — AppDNA never finishes or acknowledges transactions
`AppDNABillingProvider.adapty('<public-sdk-key>')`	Adapty is your purchase SDK — factory carrying your Adapty public SDK key
`AppDNABillingProvider.none`	Disable the billing module

The setting applies on both iOS and Android (on Android storeKit2 means Google Play Billing). Omitted = storeKit2. Choose revenueCat when RevenueCat is your purchase SDK: AppDNA then never finishes or acknowledges a transaction, an SDK paywall tap calls onPaywallPurchaseFailed with errorType: 'providerNotAvailable' (start the RevenueCat purchase from that callback), and purchases reach AppDNA through the RevenueCat webhook. See Billing → Who owns the store transaction.

2. Wait for Ready State

Use onReady to know when the SDK is ready — the bootstrap has succeeded or failed:

await AppDNA.onReady(() {
  print("SDK ready");
});

onReady() accepts a callback that runs once the SDK is ready (at once, if it already is). onReady does not wait for the remote configuration. When it fires, the SDK serves the cached and bundled config, and the remote fetch may still be running (after a failed bootstrap it starts when a retry succeeds). Use remoteConfig.onChanged to pick up the fetched values.

3. Identify Users

Once a user signs in, call identify to associate events with their user ID:

await AppDNA.identify(
  "user-123",
  traits: {
    "plan": "premium",
    "signup_date": "2025-01-15",
  },
);

Traits are merged with any previously set traits. You do not need to pass all traits on every call — only the ones that have changed.

4. Track Events

Track user actions with track:

await AppDNA.track(
  "workout_completed",
  properties: {
    "duration": 45,
    "type": "strength",
  },
);

Events are batched and flushed automatically: every flushInterval seconds, when the app goes to the background or returns to the foreground, and when the queue reaches a batch size set by the network (100 events on Wi-Fi or a wired connection, metered or not; 20 on a cellular connection the system marks as expensive (iOS) or metered (Android), which is every cellular connection on iOS and most cellular plans on Android; 50 on any other cellular connection). The batchSize option caps it: with a cap, the queue is flushed at the smaller of the two, and no upload sends more.

5. Flush Events Manually

Force an immediate flush of all queued events:

await AppDNA.flush();

This is useful before the app enters the background or when you need to ensure events are sent immediately. Control whether the SDK collects and sends analytics data:

await AppDNA.setConsent(analytics: true);

When analytics is set to false, events are silently dropped and not queued. No data is sent to AppDNA servers until consent is granted.

7. Change Log Level at Runtime

Adjust the log level without reconfiguring the SDK:

AppDNA.setLogLevel("debug");

Valid levels: "none", "error", "warning", "info", "debug".

8. Remote Config and Feature Flags

Retrieve server-side configuration values:

final welcomeMessage = await AppDNA.getRemoteConfig("welcome_message");

Check whether a feature flag is enabled:

final darkModeEnabled = await AppDNA.isFeatureEnabled("dark_mode");

9. Experiments

Get the variant assigned to a user for an experiment:

final variant = await AppDNA.getExperimentVariant("paywall_test");

Check if the user is in a specific variant:

final isInVariantB = await AppDNA.isInVariant("paywall_test", "b");

Inspect all experiment exposures collected during the current session:

final exposures = await AppDNA.experiments.getExposures();
for (final exposure in exposures) {
  print("${exposure['experimentId']} → ${exposure['variant']}");
}

10. Session Data

Store cross-module session data that can be used in template interpolation across onboarding flows, paywalls, and in-app messages:

// Store session data
await AppDNA.setSessionData('selected_plan', 'premium');
await AppDNA.setSessionData('referral_code', 'FRIEND2026');

// Retrieve session data
final plan = await AppDNA.getSessionData('selected_plan'); // "premium"

// Clear the values set with setSessionData (reset() clears onboarding answers too)
await AppDNA.clearSessionData();

Session data values are accessible in Console-configured content using template syntax: {{session.selected_plan}}. See the Rich Media guide for the full template namespace ({{user.*}}, {{session.*}}, {{device.*}}, {{remote_config.*}}).

11. Entitlements

Check whether the user has any active subscription (StoreKit, Play Billing, RevenueCat, or web entitlement):

final isSubscribed = await AppDNA.billing.hasActiveSubscription();

Subscribe to live entitlement updates so your UI reflects renewals, cancellations, and restored purchases without polling:

AppDNA.billing.onEntitlementsChanged.listen((entitlements) {
  final active = entitlements.where((e) => e.status == "active").toList();
  print("Active entitlements: ${active.length}");
});

See the Billing guide for the full purchase and restore flow.

12. Web Entitlement

Retrieve the current web entitlement (subscriptions granted outside the app store, e.g. via Stripe):

final ent = await AppDNA.webEntitlement;

Listen for web entitlement changes in real time:

AppDNA.onWebEntitlementChanged.listen((ent) {
  print("Web entitlement changed: $ent");
});

13. Deferred Deep Links

Check for a deferred deep link that brought the user to your app on first launch:

final link = await AppDNA.checkDeferredDeepLink();
if (link != null) {
  // Navigate to the linked content
}

14. Get SDK Version

Print the underlying native SDK version (useful for support tickets):

final version = await AppDNA.getSdkVersion();
print("Native SDK version: $version");

15. Reset on Logout

When a user signs out, call reset to clear the user identity and flush any remaining events:

await AppDNA.reset();

This clears the identified user, generates a new anonymous ID, and flushes queued events.

16. Shutdown

When the app is terminating, shut down the SDK to ensure all events are flushed and resources are released:

await AppDNA.shutdown();

On Android this releases native resources. On iOS this is a no-op because the SDK shuts down automatically when the process exits.

You now have the SDK configured with user identification, event tracking, remote config, experiments, entitlements, and deep links working. Continue to the module-specific guides for Push Notifications, Billing, Onboarding, and Paywalls.

​1. Configure the SDK

​Configuration Options

​Environment

​Log Level

​Billing Provider

​2. Wait for Ready State

​3. Identify Users

​4. Track Events

​5. Flush Events Manually

​6. Set User Consent

​7. Change Log Level at Runtime

​8. Remote Config and Feature Flags

​9. Experiments

​10. Session Data

​11. Entitlements

​12. Web Entitlement

​13. Deferred Deep Links

​14. Get SDK Version

​15. Reset on Logout

​16. Shutdown

1. Configure the SDK

Configuration Options

Environment

Log Level

Billing Provider

2. Wait for Ready State

3. Identify Users

4. Track Events

5. Flush Events Manually

6. Set User Consent

7. Change Log Level at Runtime

8. Remote Config and Feature Flags

9. Experiments

10. Session Data

11. Entitlements

12. Web Entitlement

13. Deferred Deep Links

14. Get SDK Version

15. Reset on Logout

16. Shutdown