The implementation currently in use. This should be one of the following depending on the platform in use and the functionality supported by this extension:

• Android
• iOS
• default
• unknown

Whether the current device supports the extensions functionality

The native version string of the native extension.

The version of this extension.

This should be of the format, MAJOR.MINOR.BUILD

Branch is a Singleton, it should be access through the Branch.instance reference.

TODO

Parameters

Disposes the extension and releases any allocated resources. Once this function has been called, the extension functionality will have to be re-initialised upon next use.

Reward balances change randomly on the backend when certain actions are taken (defined by your rules), so it'll make an asynchronous call to retrieve the balance. Be sure to listen GET_CREDITS event.

Parameters

This call will retrieve the entire history of credits and redemptions from the individual user. Be sure to listen GET_CREDITS_HISTORY_SUCCESS and GET_CREDITS_HISTORY_FAILED events.

Parameters

If you ever want to access the original session params (the parameters passed in for the first install event only), you can use this line. This is useful if you only want to reward users who newly installed the app from a referral link or something.

These session parameters will be available at any point later on with this command. If no params, the dictionary will be empty. This refreshes with every new session (app installs AND app opens).

Allows you to deep link into your own app from your app itself

Warning: Handling a new deep link in your app will clear the current session data and a new referred "open" will be attributed.

Parameters

Initialise the Branch SDK.

Note: You should use initSession( options:BranchOptions ) to get access to the updated Branch features.

Parameters

Initialise the Branch SDK and start a session.

You will get the deep linked params associated with the link that the user clicked before showing up via the BranchEvent.INIT_SUCCESS event.

Parameters

See also

         Branch.instance.initSession(
            new BranchOptions()
                .setUseTestKey()
                .setDelayInitToCheckForSearchAds()
         );
         

Logs an event to Branch for tracking and analytics

You should use a BranchEventBuilder to construct the parameter for this function.

Parameters

See also

         Branch.instance.logEvent(
            new BranchEventBuilder( BranchEventBuilder.STANDARD_EVENT_PURCHASE )
                .setCurrency( "USD" )
                .setRevenue( 1.23 )
                .build()
         );
         

         Branch.instance.logEvent(
            new BranchEventBuilder( "your_custom_event" )
                .addCustomDataProperty("your_custom_key", "your_custom_value")
                .build()
         );
         

If you provide a logout function in your app, be sure to clear the user when the logout completes. This will ensure that all the stored parameters get cleared and all events are properly attributed to the right identity. Warning this call will clear the referral credits and attribution on the device.

We will store how many of the rewards have been deployed so that you don't have to track it on your end. In order to save that you gave the credits to the user, you can call redeem. Redemptions will reduce the balance of outstanding credits permanently.

Parameters

Often, you might have your own user IDs, or want referral and event data to persist across platforms or uninstall/reinstall. It's helpful if you know your users access your service from different devices. This where we introduce the concept of an 'identity'.

Parameters

Register Custom Events

Parameters

This will attempt to validate the current application's Branch integration and will output results to the device log

This is for testing in development only! Make sure you remove or comment out this line of code in your release versions.