Flutter

Requirements

Native SDK versions bundled by the current plugin release:

• Android — com.localytics.androidx:library:7.1.0 from the Localytics public Maven repo.
• iOS — Localytics-swiftpm 7.1.1 via Swift Package Manager.

Install the plugin

Add the dependency to your app pubspec.yaml:

dependencies:
  localytics_flutter_sdk: ^1.0.3

Then fetch packages:

flutter pub get

Import in Dart:

import 'package:localytics_flutter_sdk/localytics_flutter_sdk.dart';

iOS setup

Enable Swift Package Manager

The plugin ships iOS support via SPM only (no CocoaPods podspec). Enable SPM once per machine:

flutter config --enable-swift-package-manager

Verify with flutter config (enable-swift-package-manager: true). The first iOS build fetches Localytics-swiftpm from GitHub; later builds use the cache.

App key

Unlike Android (localytics.xml), iOS expects the app key when you build the Localytics instance in AppDelegate. Use either:

• Info.plist + xcconfig — LocalyticsAppKey set to $(LOCALYTICS_APP_KEY) in a gitignored ios/Flutter/LocalyticsEnv.xcconfig, included from Debug/Release xcconfig files.
• Inline — .settingAppKey("your-ios-app-key") in the builder.

Push, Places, background modes, and permission delegates follow the iOS integration guide.

Android setup

Maven repository

The plugin adds the Localytics Maven repo, but your app-level Gradle configuration must also expose it (Gradle resolves from the consuming app):

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url 'https://maven.localytics.com/public' }
    }
}

localytics.xml

Add android/app/src/main/res/values/localytics.xml with your app key (ll_app_key). See the Android integration guide for the full template.

Google Play Services Ads Identifier

The plugin pulls play-services-ads-identifier transitively for ADID resolution. Stores without Google Play Services may exclude that module in the app build.gradle; the SDK proceeds without ADID.

Android

FlutterFragmentActivity

In-app messages require FragmentActivity. Use FlutterFragmentActivity instead of FlutterActivity:

import io.flutter.embedding.android.FlutterFragmentActivity

class MainActivity : FlutterFragmentActivity()

Application class

Register a custom Application in AndroidManifest.xml and call Localytics.Builder()…autoIntegrate(this) from onCreate(). The app key comes from localytics.xml.

iOS

Call Localytics.builder()…autoIntegrate() in application(_:didFinishLaunchingWithOptions:) before returning from super.

Scene-based AppDelegate (implements FlutterImplicitEngineDelegate):

import Flutter
import Localytics
import UIKit

@main
@objc class AppDelegate: FlutterAppDelegate, FlutterImplicitEngineDelegate {
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    let appKey = (Bundle.main.object(forInfoDictionaryKey: "LocalyticsAppKey") as? String)
      ?? "YOUR_IOS_APP_KEY"
    var builder = Localytics.builder()
      .settingAppKey(appKey)
      .settingLaunchOptions(launchOptions)
    #if DEBUG
    builder = builder.settingLoggingEnabled(true)
    #endif
    builder.build().autoIntegrate()
    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
  }

  func didInitializeImplicitFlutterEngine(_ engineBridge: FlutterImplicitEngineBridge) {
    GeneratedPluginRegistrant.register(with: engineBridge.pluginRegistry)
  }
}

Legacy scaffold (no SceneDelegate): register via super only; same builder in didFinishLaunchingWithOptions.