flutter_branch_sdk

🔧 Native SDK Updates

• Updated included Branch iOS SDK (ios-branch-sdk-spm / BranchSDK CocoaPods spec) to 3.14.2 - iOS Version History

🔧 Native SDK Updates

• Updated included Branch iOS SDK (ios-branch-sdk-spm / BranchSDK CocoaPods spec) to 3.14.2 - iOS Version History

🐛 Bug Fixes

• Fix issue #502 - iOS scene lifecycle handlers returning true unconditionally, breaking URL handling for other plugins.

🐛 Bug Fixes

• Fix issue #502 - iOS scene lifecycle handlers returning true unconditionally, breaking URL handling for other plugins.

🐛 Bug Fixes

• Fix issue #498 - Ensure that deep-link/session initialization functions correctly when applications use the UIScene lifecycle.

🐛 Bug Fixes

• Fix issue #498 - Ensure that deep-link/session initialization functions correctly when applications use the UIScene lifecycle.

🔧 Native SDK Updates

• Updated included Branch Android SDK to 5.21.0 - Android Version History

🎉 Features

• New Method: setInstallReferrerTimeout - Provides a setting to cancel the external Install Referrer string fetch. This is useful to optimize performance on Android by limiting the time the SDK waits for the Install Referrer. Only applicable on Android - iOS ignores this setting.
• Added support for installReferrerTimeout configuration key in branch-config.json. This allows you to set the Install Referrer timeout during app initialization without code changes.
  • Configuration example: "installReferrerTimeout": 5000 (in milliseconds)
  • See README.md for full documentation

📖 Documentation

• Updated README.md with comprehensive documentation for setInstallReferrerTimeout method
• Added new section: "Set Install Referrer Timeout" with usage examples
• Updated example configurations in branch-config.json section

🔧 Native SDK Updates

• Updated included Branch Android SDK to 5.21.0 - Android Version History

🎉 Features

• New Method: setInstallReferrerTimeout - Provides a setting to cancel the external Install Referrer string fetch. This is useful to optimize performance on Android by limiting the time the SDK waits for the Install Referrer. Only applicable on Android - iOS ignores this setting.
• Added support for installReferrerTimeout configuration key in branch-config.json. This allows you to set the Install Referrer timeout during app initialization without code changes.
  • Configuration example: "installReferrerTimeout": 5000 (in milliseconds)
  • See README.md for full documentation

📖 Documentation

• Updated README.md with comprehensive documentation for setInstallReferrerTimeout method
• Added new section: "Set Install Referrer Timeout" with usage examples
• Updated example configurations in branch-config.json section

🎉 Features

• Added optional deferred SDK initialization for iOS, allowing apps to initialize the native Branch SDK later (e.g., after obtaining user consent).

🐛 Bug Fixes

• Corrected grammar in README.md and updated installation instructions.
• Fixed JS interop method name for setting request metadata.

🎉 Features

• Added optional deferred SDK initialization for iOS, allowing apps to initialize the native Branch SDK later (e.g., after obtaining user consent).

🐛 Bug Fixes

• Corrected grammar in README.md and updated installation instructions.
• Fixed JS interop method name for setting request metadata.

🐛 Bug Fixes

• Fix issue #492 : enableLogging in branch-config.json breaks JSON key selection on iOS

🐛 Bug Fixes

• Fix issue #492 : enableLogging in branch-config.json breaks JSON key selection on iOS

🔧 Native SDK Updates

• Updated included iOS SDK to 3.14.0 - iOS Version History

🎉 Features

• Improved log output from platformLogs with more detailed information.

🐛 Bug Fixes

• iOS: Fixed double execution of configureBranchSDK() on iOS 13+ with Scene Delegate support. The method was being called from both application(_:didFinishLaunchingWithOptions:) and scene(_:willConnectTo:options:), causing duplicate logging callback registration and other redundant SDK initialization. Added idempotency guard with isSdkConfigured flag to prevent re-execution.

🔧 Native SDK Updates

• Updated included iOS SDK to 3.14.0 - iOS Version History

🎉 Features

• Improved log output from platformLogs with more detailed information.

🐛 Bug Fixes

• iOS: Fixed double execution of configureBranchSDK() on iOS 13+ with Scene Delegate support. The method was being called from both application(_:didFinishLaunchingWithOptions:) and scene(_:willConnectTo:options:), causing duplicate logging callback registration and other redundant SDK initialization. Added idempotency guard with isSdkConfigured flag to prevent re-execution.

⚠️ BREAKING CHANGES

• Minimum Flutter version: 3.38.0 (was 3.19.0)
• Minimum Dart SDK: 3.10.0 (was 3.3.0)
• **Minimum iOS version : 13

🎉 Features

iOS UISceneDelegate Support (iOS 13+) Fluuter UISceneDelegate adoption

• Added full support for iOS 13+ UISceneDelegate lifecycle
• Maintains full backward compatibility with UIApplicationDelegate for apps not using scenes

⚠️ BREAKING CHANGES

• Minimum Flutter version: 3.38.0 (was 3.19.0)
• Minimum Dart SDK: 3.10.0 (was 3.3.0)
• Minimum iOS version : 13

🎉 Features

iOS UISceneDelegate Support (iOS 13+) Flutter UISceneDelegate adoption

• Added full support for iOS 13+ UISceneDelegate lifecycle
• Maintains full backward compatibility with UIApplicationDelegate for apps not using scenes

🐛 Bug Fixes

• Updated project configuration and dependencies for compatibility with iOS 12 and Flutter 3.32.7.
• Updated the iOS deployment target to 12.0.
• Removed unnecessary scene delegate methods from FlutterBranchSdkPlugin.

🎉 Features

• New Method: setInstallReferrerTimeout - Provides a setting to cancel the external Install Referrer string fetch. This is useful to optimize performance on Android by limiting the time the SDK waits for the Install Referrer. Only applicable on Android - iOS ignores this setting.
• Added support for installReferrerTimeout configuration key in branch-config.json. This allows you to set the Install Referrer timeout during app initialization without code changes.
  • Configuration example: "installReferrerTimeout": 5000 (in milliseconds)
  • See README.md for full documentation
• Added optional deferred SDK initialization for iOS, allowing apps to initialize the native Branch SDK later (e.g., after obtaining user consent).
• Improved log output from platformLogs with more detailed information.

🐛 Bug Fixes

• Corrected grammar in README.md and updated installation instructions.
• Fixed JS interop method name for setting request metadata.
• Fix issue #492 : enableLogging in branch-config.json breaks JSON key selection on iOS

🔧 Native SDK Updates

• Updated included iOS SDK to 3.14.0 - iOS Version History
• Updated included Branch Android SDK to 5.21.0 - Android Version History

📖 Documentation

• Updated README.md with comprehensive documentation for setInstallReferrerTimeout method
• Added new section: "Set Install Referrer Timeout" with usage examples
• Updated example configurations in branch-config.json section

🎉 Features

New Platform Logging Stream

• Added FlutterBranchSdk.platformLogs stream to receive Branch SDK log messages in real-time
• Enable logging via branch-config.json (enableLogging and logLevel keys) or programmatically through FlutterBranchSdk.init()
• Supports log levels: VERBOSE, DEBUG, INFO, WARNING, ERROR, and NONE
• Example usage:

  FlutterBranchSdk.platformLogs.listen((logMessage) {
    debugPrint('Branch Log: $logMessage');
  });
  

🎉 Features

Introduced platform-specific API URL configuration. This allows developers to define different API endpoints for Android and iOS in branch-config.json.

• Added key apiUrlAndroid in branch-config.json to configure the API URL for the Android platform.
• Added key apiUrlIOS in branch-config.json to configure the API URL for the iOS platform.

🗑️ Removals

• ⚠️ The generic apiUrl key has been removed from branch-config.json. Please update your configuration to use the new platform-specific keys (apiUrlAndroid and apiUrlIOS).

🎉 Features & Fixes

• Android: Resolved build warnings (unchecked or unsafe operations, deprecated api) for a cleaner build process.
• Android: Updated plugin configuration to ensure compatibility with Android Gradle Plugin (AGP) 8.6.x (16KB Page Size).
• Android: ⚠️ Updated the showShareSheet function, which now requires a minimum of API level 22 (Android 5.1) to work correctly.
• iOS: Improved plugin stability by adding consistency checks to safely handle all incoming data from Flutter and prevent crashes.
• iOS: Modernized native code to ensure compatibility with recent APIs.
• Fixed Flutter linter warnings to improve code quality and maintainability.

🗑️ Removals

• The deprecated method FlutterBranchSdk.disableTracking() has been removed.

🎉 Fixes

• Updated README.MD with correct configuration for branch-config.json.

🎉 Features

• Configuration through branch-config.json file.
  • Some settings can be configured by adding an assets/branch-config.json file to your project.
  • This eliminates the need for manual modifications to native files (AndroidManifest.xml and Info.plist).
  • Toggle between your test and live keys within the branch-config.json file, streamlining the development and release process.
  • The branch-config.json file and its keys are optional. The plugin will gracefully handle its absence, allowing for programmatic setup or backward compatibility with the manual native setup. If the file is present but a key is missing, the plugin will use default values where applicable.
  • Read the README.md for full instructions for JSON-based configuration.

🐛 Bug Fixes

• Fix issue #461 : iOS Build Failure using CocoaPods

🔧 Native SDK Updates

• Updated included iOS SDK to 3.13.0 - iOS Version History
• Updated included Branch Android SDK to 5.20.0 - Android Version History

🎉 Features

• New Methods:
  • setAnonID - Sets a custom Meta Anon ID for the current user.
  • setSDKWaitTimeForThirdPartyAPIs - Set the SDK wait time for third party APIs (for fetching ODM info and Apple Attribution Token) to finish

🔧 Native SDK Updates

• Updated included Branch Android SDK to 5.19.0 - Android Version History

🐛 Bug Fixes

• Fix issue #442: [Web] getShortUrl() Future never completes on alias conflict (err arrives as JS Error, not String)

🎉 Features

• Reviewing the documentation for the FlutterBranchSdk.validateSDKIntegration() method
• Improved error handling in Flutter Web

🔧 Native SDK Updates

• Updated included iOS SDK to 3.12.0 - iOS Version History
• Updated included Branch Android SDK to 5.18.0 - Android Version History

🐛 Bug Fixes

• Fix issue #423: setRequestMetadata doesn't populate the key value pairs in the event request as expected

🔧 Native SDK Updates

• Updated included iOS SDK to 3.9.0 - iOS Version History

⚠️ BREAKING CHANGE

• Minimum required Dart SDK version 3.3.0 (Flutter 3.19.0 - 15/02/2024)

🐛 Bug Fixes

• Fix issue #410: "reply already sent and a possible ANR". Tks @Junglee-Faisal

🎉 Features

• Migrated Gradle to declarative plugins block

⚠️ BREAKING CHANGE

• Minimum required Dart SDK version 3.3.0 (Flutter 3.19.0 - 15/02/2024)

🎉 Features

• Revised documentation including section to change Flutter Deep link flag
• New option in INFO.PLIST (branch_disable_nativelink) that allows disable NativeLink™ Deferred Deep Linking

⚠️ BREAKING CHANGE

• Minimum required Dart SDK version 3.3.0 (Flutter 3.19.0 - 15/02/2024)

🎉 Features

• New Methods:
  • setConsumerProtectionAttributionLevel - Sets the consumer protection attribution level. Read Branch documentation for details:
    • Introducing Consumer Protection Preference Levels
    • Consumer Protection Preferences

Deprecated / Removed

• FlutterBranchSdk.disableTracking(). Use FlutterBranchSdk.setConsumerProtectionAttributionLevel().
• Removed initSession method.

Native SDK Updates

🔧 Native SDK Updates

• Updated included iOS SDK to 3.7.0 - iOS Version History
• Updated included Branch Android SDK to 5.15.0 - Android Version History

⚠️ BREAKING CHANGE

• Minimum required Dart SDK version 3.3.0 (Flutter 3.19.0 - 15/02/2024)

🎉 Features

• Issue #361: Migrate to dart:js_interop to support Webassamebly. Thanks @hnvn

🐛 Bug Fixes

• Fix issue #368: "-118, Warning. Session initialization already happened" triggered in the listSession callback

🔧 Native SDK Updates

• Updated included iOS SDK to 3.6.0 - iOS Version History
• Updated included Branch Android SDK to 5.12.2 - Android Version History

⚠️ BREAKING CHANGE

This is a major release which contains breaking API changes.

⚠️ SDK Initialization Changed

• useTestKey parameter is no longer supported at FlutterBranchSdk.init().

Check the instructions in README.MD on how to activate the key_test_.

🐛 Bug Fixes

• Fix issue #347: ios plugin v8.0.3 crashes when no url is returned
• Fix issue #338: Changing the return value in didFinishLaunchingWithOptions crashes the application from SDK version above 8.0.0

⚠️ BREAKING CHANGE

This is a major release which contains breaking API changes.

⚠️ SDK Initialization Changed

• useTestKey parameter is no longer supported at FlutterBranchSdk.init().

Check the instructions in README.MD on how to activate the key_test_.

🐛 Bug Fixes

• Fix issue #340: Logging not working in Android Studio Emulator

⚠️ BREAKING CHANGE

This is a major release which contains breaking API changes.

⚠️ SDK Initialization Changed

• useTestKey parameter is no longer supported at FlutterBranchSdk.init().

Check the instructions in README.MD on how to activate the key_test_.

🐛 Bug Fixes

• Fix Enable and Disable Tracking on FlutterBranchSdk.init() method

⚠️ BREAKING CHANGE

This is a major release which contains breaking API changes.

⚠️ SDK Initialization Changed

• useTestKey parameter is no longer supported at FlutterBranchSdk.init().

Check the instructions in README.MD on how to activate the key_test_.

🐛 Bug Fixes

• Fix issue #325: Android cannot get the opening link (onInitFinished called after clicking on deep link two times)

⚠️ BREAKING CHANGE

This is a major release which contains breaking API changes.

⚠️ SDK Initialization Changed

• useTestKey parameter is no longer supported at FlutterBranchSdk.init().

Check the instructions in README.MD on how to activate the key_test_.

🐛 Bug Fixes

• Fix issue #283: Android app not getting correct deeplink from Branch when app is opened
• Fix issue #308: Android non branch deep link sometimes not available
• Fix issue #309: Completion of await FlutterBranchSdk.init() doesn't mean native iOS plugin is ready?
• Fix issue #311: Flutter SDK init falls into loop when race condition happens during the initialization.
• Fix issue #314: Issue with Branch.io Integration on Apple 14 pro
• Fix issue #316: Not getting link after fresh install

🔧 Native SDK Updates

• Updated included iOS SDK to 3.4.3 - iOS Version History
• Updated included Branch Android SDK to 5.12.0 - Android Version History

🔧 Native SDK Updates

• Updated included Branch Android SDK to 5.11.0 - Android Version History
• Updated included Branch iOS SDK to 3.4.1 - iOS Version History

🎉 Features

• showShareSheet method will now display the native Android share sheet.
• Documentation review

🔧 Dependencies Update

• Updated dependency js. From version 0.6.7 to 7.0.0

🔧 Native SDK Updates

• Updated included Branch Android SDK to 5.10.1 - Android Version History

🎉 Features

• New Methods:
  • setDMAParamsForEEA - In response to the European Union's enactment of the Digital Markets Act (DMA), this new method help pass consent information from your user to Google. See documentation for details.

🐛 Issues

• Fix issue #297: Allow Call setRequestMetadata after FlutterBranchSdk.init() method

🔧 Native SDK Updates

• Updated included Branch Android SDK to 5.9.0 - Android Version History
• Updated included Branch iOS SDK to 3.3.0 - iOS Version History

Issues

• Fix issue #289 : reverts js dependency update. From version 0.7.0 to 0.6.7

Issues

• Fix issue #277 : PlatformException - NullPointerException

Features

• PR #286 : fix: export platform_interface
• Updated configuration steps in README.MD
• Sample app - code review

Issues

• Fix issue #261 / #266 / #268: Calling startActivity() from outside of an Activity
• Fix issue #264: Android (PlayStore) : Branch SDK Params empty on background state
• Fix issue #265: New release 7.0.0+ not getting a deeplink data on first launch, when app is on resume
• Fix issue #270: Indicate when error is thrown in init

Native SDK Updates

• Updated included Android SDK to 5.8.0 - Android Version History

• Fix issue #255: Attempt to invoke virtual method 'int android.content.Intent.getFlags()' on a null object reference when using FlutterFragmentActivity
• Fix issue #256: A problem occurred configuring project ':flutter_branch_sdk'. - Add compatibility with AGP 8 (Android Gradle Plugin)

⚠️ This is a major release which contains breaking API changes.

BREAKING CHANGE

• Minimum required Dart SDK version to 2.18 (Flutter 3.3.0)
• Xcode 15 is the min version
• iOS 12 is the min version

SDK Initialization Required

• Use FlutterBranchSdk.init() method to initialize the SDK.

Initialization must be called from main or at any time (for example after getting consent for GPDR).

  await FlutterBranchSdk.init(
      useTestKey: false, enableLogging: false, disableTracking: false);

Check additional instructions in the README

Deprecated / Removed

• FlutterBranchSdk.initSession(). Use FlutterBranchSdk.listSession().
• Removed setIOSSKAdNetworkMaxTime method
• Removed Facebook App Install Ads on iOS

Features

• Issue #244 - Support for setting customer_event_alias for BranchEvent
• Updated compile & target SDK to Android API 33.
• Updated example app Android compileSdkVersion to 33.

Native SDK Updates

• Updated included iOS SDK to 3.0.0 - iOS Version History

Enhancement

• Issue #244 - Support for setting customer_event_alias for BranchEvent

• Updated Native Android SDKs:
  • Android Native SDK Update 5.7.+ - Android Version History
  • iOS Native SDK Update 2.2.1 - iOS Version History
• Removed:
  • Facebook App Install Ads on Android (parameter branch_enable_facebook_ads)

• Fix issue #237: Pass long URL when try creating Short URL in Offline

• Updated Native Android and iOS SDKs:
  • Android Native SDK Update 5.6.+ - Android Version History
  • iOS Native SDK Update 2.2.0 - iOS Version History
• Removed:
  • Firebase App Indexing in Android (listOnSearch and removeFromSearch return success but do not perform any action)
  • Old Apple Search Ads APIs (parameter branch_check_apple_ads)

• Updated Native Android and iOS SDKs:

  • Android Native SDK Update 5.4.+ - Android Version History
  • iOS Native SDK Update 2.1.0 - iOS Version History

• New Methods:

  • addSnapPartnerParameter - See documentation on partner parameters for details.

• Updated Native iOS SDK:
  • iOS Native SDK Update 2.0.0 - iOS Version History

• Fix issue #193: Flutter app won't get notified about the quick link event if the app is at foreground on Android devices

• New Methods:

  • addFacebookPartnerParameter - See documentation on partner parameters for details.
  • clearPartnerParameter - Clears all Partner Parameters
  • setPreinstallCampaign - Add the pre-install campaign analytics
  • setPreinstallPartner - Add the pre-install campaign analytics

• Updated Native iOS SDK:

  • iOS Native SDK Update 1.45.0 - iOS Version History

  Note: Requires Xcode 14+

• New Method handleDeepLink
• Fix issue #188: Failed to handle method call: java.lang.NullPointerException
• Fix issue #189: Fix crash when adding a boolean control param
• Fix issue #190: getTrackingAuthorizationStatus will open the iOS-dialog to requestTrackingAuthorization

• Fix issue #181: Calling the getLastAttributedTouchData() exit with exception on IOS 15.7

• Update BranchStandardEvent list.

• Updated Android Advertising ID (AAID) version in Android SDK.

BREAKING CHANGE

• Minimum required Dart SDK version to 2.17 (Flutter 3.0)
• Removed deprecated methods:
  • initWeb
  • loadRewards
  • redeemRewards
  • getCreditHistory

Enhancement

• New Methods:
  • getQRCodeAsData
  • getQRCodeAsImage
  • shareWithLPLinkMetadata
• General improvements in code
• Fix analyzer code style warnings
• Updated Native Android and iOS SDKs:
  • Android Native SDK Update 5.2.+ - Android Version History
  • iOS Native SDK Update 1.43.+ - iOS Version History

• Updated Native Android SDK:
  • Android Native SDK Update 5.1.5 - Android Version History
• Removed dependencies: flutter_lints (not in used)

• Fix issue #143: Infinite loop with POST requests when offline
• Fix issue #146: clicked_branch_link is to true when app is opened from deeplink and then putted in background and reopened
• Fix issue #113: Fatal Exception: java.lang.IllegalStateException Reply already submitted
• New Method getLastAttributedTouchData
• Updated Native Android and iOS SDKs:
  • Android Native SDK Update 5.1.4 - Android Version History
  • iOS Native SDK Update 1.42.0 - iOS Version History

###BREAKING CHANGE:

• FlutterBranchSdk.initWeb deprecated.

• Branch for Flutter Web initialized in index.html, see Web Integration section

• FlutterBranchSdk.trackContent method changed to accept List of Branch Universal Object :

  Before:

  FlutterBranchSdk.trackContent(
    buo: buo,
    branchEvent: event
  );
  

  After:

   FlutterBranchSdk.trackContent(
     buo: [buo],
     branchEvent: event
   );
  

• Updated Native Android and iOS SDKs:
  • Android Native SDK Update 5.1.0 - Android Version History
  • iOS Native SDK Update 1.41.0 - iOS Version History