Branch

https://help.branch.io/developer-hub/docs/
Admin
Branch is an all-in-one platform that helps mobile businesses grow by providing solutions for deep...
Tokens:628,296
Snippets:4,647
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example branch.init() callback response

Source: https://help.branch.io/developer-hub/docs/web-full-reference

Example response from the branch.init() callback. The data object includes parsed link data, referring identity, app installation status, user identity, and the referring link when available.

```JavaScript
callback(
	"Error message",
	{
		data_parsed: { }, // If the user was referred from a link, and the link has associated data, the data is passed in here
		referring_identity: '12345', // If the user was referred from a link, and the link was created by a user with an identity, that identity is here
		has_app: true, // Whether the user has the app installed already
		identity: 'BranchUser', // Unique string that identifies the user
		~referring_link: 'https://bnc.lt/c/jgg75-Gjd3' // The referring link click, if available
	}
);
```

--------------------------------

### addInstallMetadata - Java

Source: https://help.branch.io/developer-hub/docs/android-full-reference

Java equivalent of the Kotlin example for tagging an install with a custom attribute. Call this method before the `onStart()` method of the first activity, right after Branch object initialization.

```Java
// Call this method before the `onStart()` method of the first activity

protected static final String branchKey = "branch_key_here";

public class CustomApplicationClass extends Application {
	@Override
	public void onCreate() {
		super.onCreate();

		// Branch object initialization
		Branch.getAutoInstance(this.getApplicationContext, branchKey);
    
		// Suggestion: call `addInstallMetadata()` right after object initialization
		Branch.getInstance().addInstallMetadata("install_attribute_name", "install_attribute_value");
	}
}
```

--------------------------------

### branch.first() example

Source: https://help.branch.io/developer-hub/docs/web-full-reference

Calls the Branch first method to retrieve the session information and referring data from when the app was first installed. The callback receives an error and data object; if the session is already initialized, the callback returns immediately.

```JavaScript
branch.first(function(err, data) {
	response.html(err || JSON.stringify(data));
});
```

--------------------------------

### expectDelayedSessionInitialization()

Source: https://help.branch.io/developer-hub/docs/android-advanced-features

Delays Branch session initialization to allow async setup before session starts.

```APIDOC
## expectDelayedSessionInitialization()

### Description
Disables automatic session initialization so that you can delay the Branch session initialization until after an asynchronous call completes. Must be called before establishing the Branch singleton in your Application class's `onCreate()`.

### Method
expectDelayedSessionInitialization

### Parameters
None.

### Request Example
```kotlin
Branch.expectDelayedSessionInitialization()
```

### Response
No return value.
```

--------------------------------

### Branch init() basic example with logging

Source: https://help.branch.io/developer-hub/docs/web-basic-integration

Initializes Branch with the init() method using a Branch Key. Replace 'key_live_YOUR_KEY_GOES_HERE' with your live Branch Key. The callback logs any error or data.

```JavaScript
// Replace key_live_YOUR_KEY_GOES_HERE with your Branch Key (live version)
branch.init('key_live_YOUR_KEY_GOES_HERE', function(err, data) {
	console.log(err, data);
});
```

--------------------------------

### getFirstReferringParams Example Usage

Source: https://help.branch.io/developer-hub/docs/react-native-full-reference

Example showing how to use branch.subscribe listener and branch.getFirstReferringParams() to retrieve the first referring link parameters. The listener handles deep link opens, and the method returns a promise that resolves once with the original install parameters.

```JavaScript
import branch from 'react-native-branch'

        // Listener
        branch.subscribe({
        onOpenStart: ({
        uri,
        cachedInitialEvent
        }) => {
        console.log(
        'subscribe onOpenStart, will open ' +
        uri +
        ' cachedInitialEvent is ' +
        cachedInitialEvent,
        );
        },
        onOpenComplete: ({
        error,
        params,
        uri
        }) => {
        if (error) {
        console.error(
        'subscribe onOpenComplete, Error from opening uri: ' +
        uri +
        ' error: ' +
        error,
        );
        return;
        }
        else if (params) {
        if (!params['+clicked_branch_link']) {
        if (params['+non_branch_link']) {
        console.log('non_branch_link: ' + uri);
        // Route based on non-Branch links
        return;
        }
        } else {
        // Handle params
        let deepLinkPath = params.$deeplink_path as string;
        let canonicalUrl = params.$canonical_url as string;
        // Route based on Branch link data
        return
        }
        }
        },
        });

        let installParams = await branch.getFirstReferringParams() // Params from original install
```

--------------------------------

### addFacebookPartnerParameter example

Source: https://help.branch.io/developer-hub/docs/react-native-full-reference

Adds a Facebook Partner Parameter for Facebook Advanced Matching. The parameter is attached to INSTALL, OPEN, and other events until cleared or the app restarts.

```javascript
import branch from 'react-native-branch'

        branch.addFacebookPartnerParameter("key","value")
```

--------------------------------

### Example request log with preinstall campaign and partner (JSON)

Source: https://help.branch.io/developer-hub/docs/pre-install-analytics

Shows the expected request log format after setting preinstall campaign and partner. The values appear as preinstall_campaign and preinstall_partner.

```json
{
  …
  preinstall_campaign: “My Campaign Name”
  preinstall_partner: “Branch $3p Parameter Value”
  …
}
```

--------------------------------

### logout example

Source: https://help.branch.io/developer-hub/docs/react-native-full-reference

Logs out the current user and notifies Branch to create a new user for the device. Clears the first and latest params and starts a new session.

```javascript
import branch from 'react-native-branch'

        branch.logout()
```

--------------------------------

### Initialize Branch SDK via NPM

Source: https://help.branch.io/developer-hub/docs/connected-full-reference

Import the SDK and initialize it with your Branch Key and advertising IDs. Replace 'key_live_YOUR_KEY_GOES_HERE' with your actual key.

```javascript
import branch from 'branch-connected-sdk'

// Pass the device's advertising id through 'options' with the corresponding key (/developer-hub/docs/connected-basic-integration)
const options = {
    advertising_ids: {
        SAMSUNG_IFA: 'xxxxx',
    }
};
// init Branch 
branch.init('key_live_YOUR_KEY_GOES_HERE', options);
```

--------------------------------

### Set Braze install ID with setRequestMetadataKey

Source: https://help.branch.io/developer-hub/docs/ios-full-reference

Example using Braze as the third-party Data Integration Partner. Sets the $braze_install_id metadata key to the Braze device ID.

```swift
// Inside the `didFinishLaunchingWithOptions` method
Branch.getInstance.setRequestMetadataKey("$braze_install_id", braze.deviceId)
```

```objectivec
// Inside the `didFinishLaunchingWithOptions` method
[[Branch getInstance] setRequestMetadataKey:@"$braze_install_id" value: braze.deviceId];
```

--------------------------------

### Initialize Branch SDK and open session in wWinMain

Source: https://help.branch.io/developer-hub/docs/windows-cpp-basic-integration

Initializes the Branch SDK from wWinMain by creating a Branch instance with Branch::create and calling openSession with a URI from the command line. Strips quotes from lpCmdLine and checks for the URI scheme before opening the session; requires a MyCallback object and a branchKey.

```C++
#include <BranchIO/Branch.h>

        using namespace BranchIO;
        using namespace std;

        struct MyCallback : public virtual IRequestCallback;

        int APIENTRY wWinMain(_In_ HINSTANCE hInstance,
        _In_opt_ HINSTANCE hPrevInstance,
        _In_ LPWSTR lpCmdLine,
        _In_ int nCmdShow)
        {
        UNREFERENCED_PARAMETER(hPrevInstance);

        // ----- Initialize the Branch SDK
        AppInfo appInfo;
        appInfo.setAppVersion("1.0");

        auto* branch = Branch::create(branchKey, &appInfo);

        wstring cmdLineArg(lpCmdLine ? lpCmdLine : L"");
        wstring uriScheme(L"myurischeme");
        if (cmdLineArg[0] == '"') {
        // Strip off any leading and trailing quotes
        cmdLineArg = cmdLineArg.substr(1, cmdLineArg.length() - 2);
        }
        wstring::size_type prefixLength = min(uriScheme.length(), cmdLineArg.length());
        wstring prefix = cmdLineArg.substr(0, prefixLength);
        if (prefix == uriScheme)
        {
        // Open any URI passed at the command line
        uriToOpen = cmdLineArg;
        }

        auto* myCallback = new MyCallback;
        branch->openSession(uriToOpen, myCallback);

        // ----- Continue with normal Win32 startup
        MyRegisterClass(hInstance);
```

--------------------------------

### getBranchQRCode usage example

Source: https://help.branch.io/developer-hub/docs/react-native-full-reference

JavaScript example showing how to create a Branch QR code with custom settings, branch universal object options, link properties, and control parameters. Uses async/await with try/catch to handle the promise result.

```JavaScript
import branch from 'react-native-branch'

        var qrCodeSettings = {
        width: 500,
        codeColor: "#3b2016",
        backgroundColor: "#a8e689",
        centerLogo: "https://cdn.branch.io/branch-assets/159857dsads5682753-og_image.png",
        margin: 1,
        imageFormat: "PNG"
        };

        var buoOptions = {
        title: "A Test Title",
        contentDescription: "A test content desc",
        contentMetadata: {
        price: "200",
        productName: "QR Code Scanner",
        customMetadata: { "someKey": "someValue", "anotherKey": "anotherValue" }
        }
        };

        var lp = {
        feature: "qrCode",
        tags: ["test", "working"],
        channel: "facebook",
        campaign: "posters"
        };

        var controlParams = {
        $desktop_url: "https://www.desktop.com",
        $fallback_url: "https://www.fallback.com"
        };

        try {
        var result = await branch.getBranchQRCode(qrCodeSettings, buoOptions, lp, controlParams);
        }
        catch (err) {
        console.log('QR Code Err: ', err);
        }
```

--------------------------------

### Initialize Branch SDK with advertising ID

Source: https://help.branch.io/developer-hub/docs/connected-basic-integration

Import the SDK and initialize it with your Branch key and an advertising ID. Replace 'key_live_YOUR_KEY_GOES_HERE' with your Branch Dashboard key. The advertising ID is passed via the 'advertising_ids' option with the key 'SAMSUNG_IFA'.

```javascript
import branch from 'branch-connected-sdk'

// Pass the device's advertising id through 'options' with the corresponding key (https://help.branch.io/developer-hub/docs/connected-basic-integration#advertising-id-index)
const options = {
    advertising_ids: {
        SAMSUNG_IFA: 'xxxxx',
    }
};
// init Branch 
branch.init('key_live_YOUR_KEY_GOES_HERE', options);
```

--------------------------------

### getReferredBranchUniversalObject Example

Source: https://help.branch.io/developer-hub/docs/android-full-reference

Retrieves the BranchUniversalObject associated with the latest deep link. Call after initializing a Branch session. Returns null if the session was not started by a Branch Deep Link click.

```kotlin
val buo = BranchUniversalObject().setCanonicalIdentifier("content/12345")
  
buo.getReferredBranchUniversalObject()
```

```java
BranchUniversalObject buo = new BranchUniversalObject().setCanonicalIdentifier("content/12345");
buo.getReferredBranchUniversalObject();
```

--------------------------------

### Conversion value verification JSON payloads

Source: https://help.branch.io/developer-hub/docs/advanced-skadnetwork-sdk-configuration

Example JSON payloads for verifying conversion values. The first shows the invoke_register_app field for INSTALLs, and the second shows the update_conversion_value field for other conversions.

```json
{
                    "session_id" : "850166709486919576",
                    "data" : "{\"+clicked_branch_link\":false,\"+is_first_session\":false}",
                    "device_fingerprint_id" : "847563926187298061",
                    "identity_id" : "850166709481620778",
                    "invoke_register_app" : true,
                    "link" : "https:\/\/3mnv.app.link?%24identity_id=850166709481620778"
                    }
```

```json
{
                    "branch_view_enabled" : false,
                    "update_conversion_value" : 42
                    }
```

--------------------------------

### Convert Instant App to Full App with showInstallPrompt()

Source: https://help.branch.io/developer-hub/docs/android-instant-apps

Check if the app is an Instant App using Branch.isInstantApp(). If so, show an install button that creates a BranchUniversalObject and calls Branch.showInstallPrompt() to pass deep link data to the full app. Otherwise, hide the button.

```java
if (Branch.isInstantApp(this)) {
  myFullAppInstallButton.setVisibility(View.VISIBLE);
  myFullAppInstallButton.setOnClickListener(new OnClickListener() {
    @Override
    public void onClick(View v) {
       BranchUniversalObject branchUniversalObject = new BranchUniversalObject()
            .setCanonicalIdentifier("item/12345")
            .setTitle("My Content Title")
            .setContentDescription("My Content Description")
            .setContentImageUrl("https://example.com/mycontent-12345.png")
            .addContentMetadata("property1", "blue")
            .addContentMetadata("property2", "red");

      Branch.showInstallPrompt(myActivity, activity_ret_code, branchUniversalObject);
    }
  });
} else {
  myFullAppInstallButton.setVisibility(View.GONE);
}
```

--------------------------------

### initSessionWithLaunchOptions

Source: https://help.branch.io/developer-hub/docs/ios-full-reference

Initialize a Branch session with your app's specific launch options, and handle the completion with a callback object.

```APIDOC
## initSessionWithLaunchOptions

### Description
Initialize a Branch session with your app's specific launch options, and handle the completion with a `callbackWithParams` or `callbackWithBranchUniversalObject` object.

### Method
- (void)initSessionWithLaunchOptions:(nullable NSDictionary *)options andRegisterDeepLinkHandler:(nullable callbackWithParams)callback;
- (void)initSessionWithLaunchOptions:(nullable NSDictionary *)options andRegisterDeepLinkHandlerUsingBranchUniversalObject:(nullable callbackWithBranchUniversalObject)callback;

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **options** (NSDictionary) - Required - The launch options provided by your AppDelegate file's `didFinishLaunchingWithOptions:` method.
- **callback** (callbackWithParams or callbackWithBranchUniversalObject) - Required - A callback that is called when the session is opened. This will be called multiple times during the app's life, including any time the app goes through a background/foreground cycle.

### Request Example
```swift
// Within the AppDelegate
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
  let branch: Branch = Branch.getInstance()
  branch?.initSession(launchOptions: launchOptions, deepLinkHandler: { params, error in
    if error == nil {
        // Params are the deep linked params associated with the link that the user clicked
        print("params: %@", params.description)
    }
   })
  return true
}

func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    // Pass URL to the "handle deep link" call
    let branchHandled = Branch.getInstance().application(
        application,
        open: url,
        options: options
    )
    if (!branchHandled) {
        // If not handled by Branch, do other deep link routing for the Facebook SDK, Pinterest SDK, etc
    }

    return true
}

func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
    let handledByBranch = Branch.getInstance().continue(userActivity)

    return handledByBranch
}
```

```objectivec
// Within the AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    Branch *branch = [Branch getInstance];
    [branch initSessionWithLaunchOptions:launchOptions andRegisterDeepLinkHandler:^(NSDictionary *params, NSError *error) {
        // Route user based on params
    }];
    return YES;
}

- (BOOL)application:(UIApplication *)application
            openURL:(NSURL *)url
            options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
    BOOL branchHandled =
        [[Branch getInstance]
            application:application
                openURL:url
                options:options];
    if (!branchHandled) {
        // Do other deep link routing for the Facebook SDK, Pinterest SDK, etc.
    }
    return YES;
}

- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> *restorableObjects))restorationHandler {
    BOOL handledByBranch = [[Branch getInstance] continueUserActivity:userActivity];

    return handledByBranch;
}
```

### Response
No explicit response documented.
```

--------------------------------

### checkPasteboardOnInstall example in Objective-C

Source: https://help.branch.io/developer-hub/docs/ios-full-reference

Implements deferred deep linking via Branch NativeLink™. Must be called before initSession. Checks the pasteboard for a Branch link on install. Requires enabling NativeLink™ and minimum SDK v1.39.4.

```objectivec
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
	// The `checkPasteboardOnInstall` call must be made before `initSesssion`
	[[Branch getInstance] checkPasteboardOnInstall];

	// Listener for Branch Deep Link data
	[[Branch getInstance] initSessionWithLaunchOptions:launchOptions andRegisterDeepLinkHandler:^(NSDictionary * _Nonnull params, NSError * _Nullable error) {
		// Do stuff here with Deep Link data (nav to page, display content, etc)
		NSLog(@"%@", params);
	}];
  
	return YES;
}
```

--------------------------------

### Branch init() with additional options

Source: https://help.branch.io/developer-hub/docs/web-basic-integration

Shows how to pass options to the init() method. The example sets no_journeys to true to prevent Branch Journeys from appearing. Replace the Branch Key with your own.

```JavaScript
var options = { no_journeys: true };

// Replace key_live_YOUR_KEY_GOES_HERE with your Branch Key (live version)
branch.init('key_live_YOUR_KEY_GOES_HERE', options, function(err, data) {
  console.log(err, data);
});
```

--------------------------------

### Get Browser Fingerprint ID

Source: https://help.branch.io/developer-hub/docs/connected-troubleshooting

Use this function to retrieve the user's Browser Fingerprint ID, which may be needed for user deletion requests. The callback receives an error and data object; the example logs the data to the console.

```JavaScript
branch.getBrowserFingerprintId(function(err, data) { console.log(data); });
```

--------------------------------

### getFirstReferringParamsSync Example (Java/Kotlin)

Source: https://help.branch.io/developer-hub/docs/android-full-reference

Retrieves install-time referring parameters synchronously and creates a BranchUniversalObject if the link was clicked. Must be called from a non-UI thread. Returns a JSONObject with install-time parameters.

```kotlin
fun getFirstReferringBUO(): String {
	val branch = Branch.getInstance()
	val firstParams = branch?.getFirstReferringParamsSync()

	val buo = if (firstParams?.has("+clicked_branch_link") == true && firstParams.getBoolean("+clicked_branch_link")) {
		BranchUniversalObject.createInstance(firstParams)
	} else {
		// Handle error
	}

	return buo.toString()
}
```

```java
public static String getFirstReferringBranchUniversalObject() {
	BranchUniversalObject branchUniversalObject = null;
	Branch branchInstance = Branch.getInstance();
  
	if (branchInstance != null && branchInstance.getFirstReferringParamsSync() != null) {
		JSONObject firstParam = branchInstance.getFirstReferringParamsSync();
		try {
			if (firstParam.has("+clicked_branch_link") && firstParam.getBoolean("+clicked_branch_link")) {
				branchUniversalObject = BranchUniversalObject.createInstance(firstParam);
			}
		} catch (Exception ignore) {
		}
	}
  
	return _jsonObjectFromBranchUniversalObject(branchUniversalObject).toString();
}
```

--------------------------------

### Log Branch Events with BranchEvent and BranchEventType

Source: https://help.branch.io/developer-hub/docs/unity

Use BranchEvent to monitor unique user interactions beyond app installations and openings. This example shows a standard event (COMPLETE_REGISTRATION) and a custom event ("MY_CUSTOM_EVENT") with various parameters and custom data. Both events are sent via Branch.sendEvent.

```C#
BranchEvent e01 = new BranchEvent (BranchEventType.COMPLETE_REGISTRATION);

        e01.SetAffiliation("my_affilation");
        e01.SetCoupon("my_coupon");
        e01.SetCurrency(BranchCurrencyType.USD);
        e01.SetTax(10.0f);
        e01.SetRevenue(100.0f);
        e01.SetShipping(1000.0f);
        e01.SetDescription("my_description");
        e01.SetSearchQuery("my_search_query");
        e01.AddCustomData("custom_data_key01", "custom_data_value01");
        e01.AddContentItem(universalObject);

        Branch.sendEvent (e01);


        BranchEvent e02 = new BranchEvent ("MY_CUSTOM_EVENT");

        e02.SetAffiliation("my_affilation");
        e02.SetCoupon("my_coupon");
        e02.SetCurrency(BranchCurrencyType.USD);
        e02.SetTax(10.0f);
        e02.SetRevenue(100.0f);
        e02.SetShipping(1000.0f);
        e02.SetDescription("my_description");
        e02.SetSearchQuery("my_search_query");
        e02.AddCustomData("custom_data_key01", "custom_data_value01");
        e02.AddContentItem(universalObject);

        Branch.sendEvent (e02);
```

--------------------------------

### Initialize Branch SDK via script tag

Source: https://help.branch.io/developer-hub/docs/connected-full-reference

Add this script within the <head> tags. Replace 'key_live_YOUR_KEY_GOES_HERE' with your Branch Key from the dashboard. The script loads the Branch SDK and initializes it with advertising IDs.

```xml
<!doctype html>
<html>
<head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title></title>
    <script>
        // load Branch
        (function (b, r, a, n, c, h, _, s, d, k) {
            if (!b[n] || !b[n]._q) {
                for (; s < _.length;) c(h, _[s++]);
                d = r.createElement(a);
                d.async = 1;
                d.src = "https://cdn.branch.io/branch-connected.min.js";
                k = r.getElementsByTagName(a)[0];
                k.parentNode.insertBefore(d, k);
                b[n] = h
            }
        })(window, document, "script", "branch", function (b, r) {
                b[r] = function () {
                    b._q.push([r, arguments])
                }
            }, {
                _q: [],
                _v: 1
            },
            "data first init link logout setIdentity track logEvent disableTracking qrCode"
            .split(" "), 0);
        // Pass the device's advertising id through 'options' with the corresponding key (/developer-hub/docs/connected-basic-integration)
        const options = {
            advertising_ids: {
                SAMSUNG_IFA: 'xxxxx',
            }
        };
        // init Branch 
        branch.init('key_live_YOUR_KEY_GOES_HERE', options);
    </script>
</head>
<body></body>
</html>
```

--------------------------------

### Set Identity with Branch SDK (MainScene.brs)

Source: https://help.branch.io/developer-hub/docs/sdk-roku-full-reference

BrightScript example for the setIdentity API. It observes a button click hinges on the SDK being initialized)Skip? Actually, description should be concise and mention initialization and callback. Here: BrightScript example for the setIdentity API. It observes a button click, and calls setIdentity with a developer identity and a callback function name. The SDK instance must be created before calling.

```brightscript
sub init()
    m.bSetIdentity.observeField("buttonSelected", "SetIdentity_Clicked")

    ' m.bInitSession.setFocus(true)'
    m.bSetIdentity.setFocus(true)

    ' BRANCH SDK INTEGRATION - Create Instance'
    m.branchSdkObj = CreateBranchSdkForSceneGraphApp()

    SetTrackingButtonText()
end sub

sub SetIdentity_Clicked()
    if (m.branchSdkObj = invalid) then
        ShowMessageDialog("Branch SDK is not initialized!")
        return
    end if

    print "Calling Branch SetIdentity API"
    ' BRANCH SDK INTEGRATION - Call API'
    m.branchSdkObj.setIdentity("User123", "OnSetIdentityCallbackFunc")
end sub
```

--------------------------------

### Install Branch config plugin with npx expo install

Source: https://help.branch.io/developer-hub/docs/react-native-expo-integration

Install the @config-plugins/react-native-branch plugin using the version listed for your Expo SDK in the same table.

```bash
npx expo install @config-plugins/react-native-branch@<version>
```

--------------------------------

### Install capacitor-branch-deep-links

Source: https://help.branch.io/developer-hub/docs/capacitor

Install the Branch Capacitor SDK using npm.

```Terminal
npm install capacitor-branch-deep-links
```

--------------------------------

### addInstallMetadata - Kotlin

Source: https://help.branch.io/developer-hub/docs/android-full-reference

Tags an install with a custom attribute. Call this method before the `onStart()` method of the first activity, right after Branch object initialization.

```Kotlin
// Call this method before the `onStart()` method of the first activity

class CustomApplicationClass : Application() {
	override fun onCreate() {
		super.onCreate()
		
		// Branch object initialization
		Branch.getAutoInstance(this.applicationContext)
    
		// Suggestion: call `addInstallMetadata()` right after object initialization
		Branch.getInstance().addInstallMetadata("install_attribute_name", "install_attribute_value")
	}
}
```

--------------------------------

### getAutoInstance(Context context)

Source: https://help.branch.io/developer-hub/docs/android-advanced-features

Initializes the Branch singleton and starts the session.

```APIDOC
## getAutoInstance(Context context)

### Description
Initializes the Branch singleton and starts the session. When used with `expectDelayedSessionInitialization()`, it must be called after the async work is complete to manually initialize the session.

### Method
getAutoInstance

### Parameters
- **context** (Context) - Required - The application context.

### Request Example
```kotlin
Branch.getAutoInstance(this.applicationContext)
```

### Response
Returns the Branch instance.
```

--------------------------------

### setIdentity usage example

Source: https://help.branch.io/developer-hub/docs/react-native-full-reference

JavaScript example showing how to set a user identity and then log out. The example imports the branch module, calls setIdentity with a user ID, and then calls logout.

```JavaScript
import branch from 'react-native-branch'

        branch.setIdentity('theUserId')
        branch.logout()
```

--------------------------------

### handleDeepLink Example Usage

Source: https://help.branch.io/developer-hub/docs/ios-full-reference

Example usage of the handleDeepLink method in Swift and Objective-C. The Swift example shows that calling handleDeepLink with a URL without a link_click_id returns false, while a URL with link_click_id returns true. The Objective-C example demonstrates the same call with a URL containing link_click_id, returning YES.

```swift
// The following call would return `false`
Branch.getInstance().handleDeepLink("myapp://")

// The following call would return `true`
Branch.getInstance().handleDeepLink("myapp://open?link_click_id=12345")
```

```objectivec
// The following call would return `YES`
NSURL *URL = [NSURL URLWithString:@"myapp://open?link_click_id=12345"];
[[Branch getInstance] handleDeepLink:URL];
```
Tokens:
Raw