Flutter SDK 1.0.0

LimeLink's public Flutter plugin bridges the LimeLink Android and iOS SDKs for deferred deep links and platform link handling.

Requirements

Dart 3.12 or later
Flutter 3.44 or later
Android API 24 or later
iOS 12 or later

Flutter 3.44 and later uses Swift Package Manager by default on iOS. Existing CocoaPods applications remain supported.

Install

flutter pub add limelink_flutter

Import the public API:

import 'package:limelink_flutter/limelink_flutter.dart';

Initialize

Use the canonical lowercase Project UUID from LimeLink Project settings. Do not use an Organization API credential in a client application.

await LimeLink.initialize(
  const LimeLinkConfig(
    projectId: '550e8400-e29b-41d4-a716-446655440000',
    loggingEnabled: true,
  ),
);

Deferred deep links are always supported and have no initialization toggle.

Handle results

final subscription = LimeLink.events.listen((event) {
  switch (event) {
    case LimeLinkReceived(:final result):
      // Navigate using result.deeplinkUrl after allowlist validation.
    case LimeLinkDeferredNotFound():
      // Continue normal startup.
    case LimeLinkFailed(:final error):
      // Report the native error.
  }
});

Additional APIs:

final initialized = await LimeLink.isInitialized();
await LimeLink.handleIncomingLink(Uri.parse('myapp://path'));
final outcome = await LimeLink.handleDeferredDeepLink();
await subscription.cancel();

Manual deferred lookup can deliver through both its returned outcome and the event stream. Choose only one as the navigation owner. Validate every resolved destination against an app-owned scheme and host allowlist before navigation.

Platform setup

Configure Android App Links and custom schemes in the Android manifest. Configure iOS Associated Domains and custom URL schemes in the host application. LimeLink forwards cold and warm native lifecycle links automatically; do not feed Flutter router or initial-link events back into LimeLink when native lifecycle forwarding is enabled.