flutter_branch_io_plugin 0.0.2+2

flutter-branch-io #

Flutter plugin implemented Branch IO's SDK to Flutter.

Supports both Android and iOS.

Implemented function:

  • Initialization and get Deep Link data to a subscribe-able stream on dart.
  • Create BUO and MetaData model
  • Generate new deeplink and get the link
  • List BUO on google search
  • Track content & evnt
  • Track user by id

HOW TO USE iOS #

  • For iOS, you need to tweak your original Flutter's AppDelegate. Just follow this repository for further instruction (https://github.com/blackmenthor/flutter-branch-io-ios-sample)
  • After your AppDelegate has been tweaked, you could use some of the functions below
  • Last, you need to call this code inside your application's initState
          if (Platform.isAndroid) FlutterBranchIoPlugin.setupBranchIO();
          FlutterBranchIoPlugin.listenToDeepLinkStream().listen((string) {
            print("DEEPLINK $string");
            // PROCESS DEEPLINK HERE
          });
          if (Platform.isAndroid) {
            FlutterAndroidLifecycle.listenToOnStartStream().listen((string) {
              print("ONSTART");
              FlutterBranchIoPlugin.setupBranchIO();
            });
          }
    

HOW TO USE ANDROID #

  • Import flutter_branch_io_plugin to your pubspec.yaml

  • Change these setups in your AndroidManifest.xml

    • Open your MainActivity and import com.anggach.flutterandroidlifecycle.FlutterAndroidLifecycleActivity

    • Change the MainActivity class to extend FlutterAndroidLifecycleActivity

    • Add this inside your AndroidManifest.xml (inside activity tag, after the Main and Launcher intent-filter)

            <!-- Branch URI scheme -->
            <intent-filter>
                <data android:scheme="YOURSCHEME" android:host="open"/>
                <action android:name="android.intent.action.VIEW" />
                <category android:name="android.intent.category.DEFAULT" />
                <category android:name="android.intent.category.BROWSABLE" />
            </intent-filter>
      
            <!-- Branch App Links -->
            <intent-filter android:autoVerify="true">
                <action android:name="android.intent.action.VIEW" />
                <category android:name="android.intent.category.DEFAULT" />
                <category android:name="android.intent.category.BROWSABLE" />
                <data android:scheme="https" android:host="YOURHOST.test-app.link" />
            </intent-filter>
      

    Where YOURSCHEME is the Deep Link Scheme you setup at Branch.io dashboard, and YOURHOST is the Deep Link Host you setup at the dashboard

    • And add this inside application, (right after )

            <!-- Branch init -->
            <meta-data android:name="io.branch.sdk.BranchKey" android:value="YOURLIVEKEY" />
            <meta-data android:name="io.branch.sdk.BranchKey.test" android:value="YOURTESTKEY" />
            <meta-data android:name="io.branch.sdk.TestMode" android:value="true" /> <!-- Set to true to use Branch_Test_Key -->
      
            <!-- Branch install referrer tracking -->
            <receiver android:name="io.branch.referral.InstallListener" android:exported="true">
                <intent-filter>
                    <action android:name="com.android.vending.INSTALL_REFERRER" />
                </intent-filter>
            </receiver>
      

      Where YOURLIVEKEY is your Branch.io live key, and YOURTESTKEY is your Branch.io test key.

    • Last, you need to call this code inside your application's initState

          if (Platform.isAndroid) FlutterBranchIoPlugin.setupBranchIO();
          FlutterBranchIoPlugin.listenToDeepLinkStream().listen((string) {
            print("DEEPLINK $string");
            // PROCESS DEEPLINK HERE
          });
          if (Platform.isAndroid) {
            FlutterAndroidLifecycle.listenToOnStartStream().listen((string) {
              print("ONSTART");
              FlutterBranchIoPlugin.setupBranchIO();
            });
          }
    

Functions #

  • To generate new deep link from flutter, you can use this (Support both Android & iOS) First, you need to subscribe to the generated link stream, which will produce the generated link after you created a link from a branch universal object

    FlutterBranchIoPlugin.listenToGeneratedLinkStream().listen((link) {
          print("GET LINK IN FLUTTER");
          print(link);
          setState(() {
            this.generatedLink = link;
          });
        });

Then, you can start generate new links based on any Branch Universal Object you pass, and you can also add some Link Properties inside (support Android & iOS)


    FlutterBranchIoPlugin.generateLink(
          FlutterBranchUniversalObject()
              .setCanonicalIdentifier("content/12345")
              .setTitle("My Content Title")
              .setContentDescription("My Content Description")
              .setContentImageUrl("https://lorempixel.com/400/400")
              .setContentIndexingMode(BUO_CONTENT_INDEX_MODE.PUBLIC)
              .setLocalIndexMode(BUO_CONTENT_INDEX_MODE.PUBLIC),
          lpChannel: "facebook",
          lpFeature: "sharing",
          lpCampaign: "content 123 launch",
          lpStage: "new user",
          lpControlParams: {
            "url": "http://www.google.com"
          }
        );
  • Track Content (Support Both Android & iOS) to track content, you can create a new branch universal object and some event identifier (String)
    FlutterBranchIoPlugin.trackContent( FlutterBranchUniversalObject()
            .setCanonicalIdentifier("content/12345")
            .setTitle("My Content Title")
            .setContentDescription("My Content Description")
            .setContentImageUrl("https://lorempixel.com/400/400")
            .setContentIndexingMode(BUO_CONTENT_INDEX_MODE.PUBLIC)
            .setLocalIndexMode(BUO_CONTENT_INDEX_MODE.PUBLIC), FlutterBranchStandardEvent.VIEW_ITEM);
  • Set User ID (support both Android & iOS) to set user id for current session, you can use
    FlutterBranchIoPlugin.setUserIdentity(USER_ID)
  • Clear User ID (support both Android & iOS) to clear user id for current session, you can use
    FlutterBranchIoPlugin.clearUserIdentity()
  • List Universal Object on Google Search (support Android only) to list an universal object on google search, you can use
    FlutterBranchIoPlugin.listOnGoogleSearch(
              FlutterBranchUniversalObject()
                  .setCanonicalIdentifier("content/12345")
                  .setTitle("My Content Title")
                  .setContentDescription("My Content Description")
                  .setContentImageUrl("https://lorempixel.com/400/400")
                  .setContentIndexingMode(BUO_CONTENT_INDEX_MODE.PUBLIC)
                  .setLocalIndexMode(BUO_CONTENT_INDEX_MODE.PUBLIC),
              lpChannel: "facebook",
              lpFeature: "sharing",
              lpCampaign: "content 123 launch",
              lpStage: "new user",
              lpControlParams: {
                "url": "http://www.google.com"
              }
            );

Version #

  • 0.0.1
    • Initial upload
  • 0.0.1+2
    • Add Swift dependencies and version
  • 0.0.1+3
    • Fix Branch data not received after user install
  • 0.0.1+4
    • Fix method not implemented errors on iOS
  • 0.0.1+5
    • Implement iOS swift side
  • 0.0.2
    • add iml to gitignore & adjust to Branch's new SDK functions including: remove arguments from isTestModeEnabled change enableLogging to enableDebugMode because deprecated
  • 0.0.2+1
    • Change README's obsolete instructions for Android
  • 0.0.2+2
    • Upgrade Kotlin version to 1.3.21

Contributor #

  • Angga Dwi Arifandi (angga.dwi@oval.id)
  • Abdul Ghapur (gofur@oval.id)

0.0.1 #

- Initial upload

0.0.1+2 #

- Add Swift dependencies and version

0.0.1+3 #

- Fix Branch data not received after user install

0.0.1+4 #

- Fix method not implemented errors on iOS

0.0.1+5 #

- Implement iOS swift side

0.0.2 #

- add iml to gitignore & adjust to Branch's new SDK functions including:
remove arguments from isTestModeEnabled
change enableLogging to enableDebugMode because deprecated

0.0.2+1 #

- Change README's obsolete instructions for Android

0.0.2+2 #

- Upgrade Kotlin version to 1.3.21

example/README.md

flutter_branch_io_plugin_example #

Demonstrates how to use the flutter_branch_io_plugin plugin.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  flutter_branch_io_plugin: ^0.0.2+2

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:flutter_branch_io_plugin/flutter_branch_io_plugin.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
74
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
73
Overall:
Weighted score of the above. [more]
81
Learn more about scoring.

We analyzed this package on Aug 21, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.4.0
  • pana: 0.12.19
  • Flutter: 1.7.8+hotfix.4

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health suggestions

Format lib/flutter_branch_io_plugin.dart.

Run flutter format to format lib/flutter_branch_io_plugin.dart.

Format lib/src/models/branch_standard_event.dart.

Run flutter format to format lib/src/models/branch_standard_event.dart.

Format lib/src/models/branch_universal_object.dart.

Run flutter format to format lib/src/models/branch_universal_object.dart.

Format lib/src/models/content_meta_data.dart.

Run flutter format to format lib/src/models/content_meta_data.dart.

Format lib/src/models/link_properties.dart.

Run flutter format to format lib/src/models/link_properties.dart.

Maintenance suggestions

The package description is too short. (-17 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
flutter 0.0.0
flutter_android_lifecycle ^0.0.1+4 0.0.1+4
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.6 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8