Flutter SDK Full Reference

initSession (Deprecated)

Example Usage

streamSubscription = FlutterBranchSdk.initSession().listen((data) {
  print('listenDynamicLinks - DeepLink Data: $data');
  controllerData.sink.add((data.toString()));
  if (data.containsKey('+clicked_branch_link') &&
      data['+clicked_branch_link'] == true) {
    print(
      '------------------------------------Link clicked----------------------------------------------');
    print('Custom string: ${data['custom_string']}');
    print('Custom number: ${data['custom_number']}');
    print('Custom bool: ${data['custom_bool']}');
    print('Custom list number: ${data['custom_list_number']}');
    print(
      '------------------------------------------------------------------------------------------------');
    showSnackBar(
      context: context,
      message: 'Link clicked: Custom string - ${data['custom_string']}',
      duration: 10);
  }
}, onError: (error) {
  PlatformException platformException = error as PlatformException;
  print(
    'InitSession error: ${platformException.code} - ${platformException.message}');
  controllerInitSession.add(
    'InitSession error: ${platformException.code} - ${platformException.message}');
});

validateSDKIntegration

Example Usage:

FlutterBranchSdk.validateSDKIntegration();

setRequestMetadata

Example Usage

FlutterBranchSdk.setRequestMetadata(requestMetadataKey, requestMetadataValue);

setIdentity

Example Usage

FlutterBranchSdk.setIdentity('user1234567890');

isUserIdentified

Example Usage

bool isUserIdentified = await FlutterBranchSdk.isUserIdentified();

logout

Example Usage

FlutterBranchSdk.logout();

handleDeepLink

Example Usage

FlutterBranchSdk.handleDeepLink('myapp://open?link_click_id=12345');

getLatestReferringParams

Example Usage

Map<dynamic, dynamic> params = await FlutterBranchSdk.getLatestReferringParams();

getFirstReferringParams

Example Usage

Map<dynamic, dynamic> params = await FlutterBranchSdk.getFirstReferringParams();

disableTracking

Example Usage

FlutterBranchSdk.disableTracking(true);

getShortUrl

Example Usage

BranchUniversalObject buo = BranchUniversalObject(
  canonicalIdentifier: 'flutter/branch',
  //canonicalUrl: '',
  title: 'Flutter Branch Plugin',
  imageUrl: 'https://flutter.dev/assets/flutter-lockup-4cb0ee072ab312e59784d9fbf4fb7ad42688a7fdaea1270ccf6bbf4f34b7e03f.svg',
  contentDescription: 'Flutter Branch Description',
  keywords: ['Plugin', 'Branch', 'Flutter'],
  publiclyIndex: true,
  locallyIndex: true,
  contentMetadata: BranchContentMetaData()..addCustomMetadata('custom_string', 'abc')
  ..addCustomMetadata('custom_number', 12345)
  ..addCustomMetadata('custom_bool', true)
  ..addCustomMetadata('custom_list_number', [1,2,3,4,5 ])
  ..addCustomMetadata('custom_list_string', ['a', 'b', 'c']),
);

BranchLinkProperties lp = BranchLinkProperties(
  //alias: 'flutterplugin', //define link url,
  channel: 'facebook',
  feature: 'sharing',
  stage: 'new share',
  tags: ['one', 'two', 'three']
);
lp.addControlParam('url', 'http://www.google.com');
lp.addControlParam('url2', 'http://flutter.dev');

BranchResponse response =
  await FlutterBranchSdk.getShortUrl(buo: buo, linkProperties: lp);
if (response.success) {
  print('Link generated: ${response.result}');
} else {
  print('Error : ${response.errorCode} - ${response.errorMessage}');
}

showShareSheet

Example Usage

BranchResponse response = await FlutterBranchSdk.showShareSheet(
  buo: buo,
  linkProperties: lp,
  messageText: 'My Share text',
  androidMessageTitle: 'My Message Title',
  androidSharingTitle: 'My Share with');

if (response.success) {
  print('showShareSheet Sucess');
} else {
  print('Error : ${response.errorCode} - ${response.errorMessage}');
}

getQRCode

Example Usage

BranchResponse responseQrCodeImage = await FlutterBranchSdk.getQRCodeAsImage(
  buo: buo!,
  linkProperties: lp,
  qrCode: BranchQrCode(primaryColor: Colors.black, 
                       //primaryColor: const Color(0xff443a49), //Hex colors
                       centerLogoUrl: imageURL,
                       backgroundColor: Colors.white,
                       imageFormat: BranchImageFormat.PNG));

  if (response.success) {
      print('QrCode Success');
      showQrCode(this.context, responseQrCodeImage.result);
      /*
       Image(image: responseQrCodeImage.result,
             height: 250,
             width: 250,),
      */
  } else {
     print('Error : ${response.errorCode} - ${response.errorMessage}');

trackContent

By default, the Branch SDK tracks clicks, opens, installs, reinstalls and impressions automatically (out-of-the-box).

General Event Tracking

Please refer to our Event Tracking Docs for more information and examples:

• Track Commerce Events

• Track Content Events

• Track Lifecycle Events

• Track Custom Events

Tracking In-App Web View Events

With the Branch Flutter SDK, it is possible to inject JavaScript into an in-app web view with event listeners to make calls to one of our mobile SDKs.

In this scenario, the website’s JavaScript posts a message when a button or element on the page is clicked. The app then uses a JavaScript channel to listen for that message. Inside of the callback, a switch statement is used to check the message and trigger a Branch Event.

To implement this approach:

1. Add JavaScript code to the website to add a listener to the button’s selector and call the postMessage() function:

   var _selector = document.querySelector('button[id=BUTTON_ID]');
   _selector.addEventListener('click', function(event) {
     var message = "LOGIN";
   
     if (messageHandler) {
       messageHandler.postMessage(message);
     }
   });

2. Add a JavaScript channel to the WebViewController to handle the onMessageRecieved callback and trigger the corresponding Branch Event:

   class _MyWebViewState extends State {="" late="" final="" webviewcontroller="" controller;="" @override="" void="" initstate()="" {="" super.initstate();="" controller="WebViewController()" ..loadrequest(="" uri.parse('https://your_website.com'),="" );="" controller.setjavascriptmode(javascriptmode.unrestricted);="" controller.addjavascriptchannel('messagehandler',="" onmessagereceived:="" (message)="" {="" switch="" (message.message)="" {="" case="" "login":="" branchevent="" event="BranchEvent.standardEvent(BranchStandardEvent.LOGIN);" flutterbranchsdk.trackcontentwithoutbuo(branchevent:="" event);="" break;="" case="" "purchase":="" branchevent="" event="BranchEvent.standardEvent(BranchStandardEvent.PURCHASE);" flutterbranchsdk.trackcontentwithoutbuo(branchevent:="" event);="" break;="" }="" });="" }="" }="">>

registerView

Example Usage

FlutterBranchSdk.registerView(buo: buo);

listOnSearch

Example Usage

bool success = await FlutterBranchSdk.listOnSearch(buo: buo);
print(success);

removeFromSearch

Example Usage

bool success = await FlutterBranchSdk.removeFromSearch(buo: buo);
print('Remove sucess: $success');

setIOSSKAdNetworkMaxTime

Example Usage

FlutterBranchSdk.setIOSSKAdNetworkMaxTime(24);

requestTrackingAuthorization

Example Usage

AppTrackingStatus status = await FlutterBranchSdk.requestTrackingAuthorization();
print(status);

getTrackingAuthorizationStatus

Example Usage

AppTrackingStatus status = await FlutterBranchSdk.getTrackingAuthorizationStatus();
print(status);

getAdvertisingIdentifier

Example Usage

String status = await FlutterBranchSdk.getAdvertisingIdentifier();
print(status);