Exhaustive documentation can be found on our documentation portal. you may also find our support portal and user forums helpful.

The Titanium SDK shares the same code base as the iOS and Android SDKs, and enables you to call all the same functions from your Titanium app.

To use the module, go to the android/iphone folder's respective dist folders. Inside, you should be able to find the compressed module. Extract the contents to your titanium modules folder

1. Branch Session

• .initSession()
• .getAutoSession()
• .getLatestReferringParams()
• .getFirstReferringParams()
• .setIdentity(identity)
• .logout()
• .userCompletedAction()

2. Branch Universal Object

• .createBranchUniversalObject(options)
• .registerView()
• .generateShortUrl(options, controlParameters)
• .showShareSheet(options, controlParameters)

3. Referral System Rewarding

• .loadRewards()
• .redeemRewards(value)
• .creditHistory()

Setting the SDK debug flag will generate a new device ID each time the app is installed instead of possibly using the same device id. This is useful when testing.

This needs to be set before the Branch.init call!!!

Initializes the branch instance.

branch.initSession();

To implement the callback, you must add a listener to the event bio:initSession. The event returns a dictionary object where you can read the link the user was referred by and other related data.

Branch returns explicit parameters every time. Here is a list, and a description of what each represents.

• ~ denotes analytics
• + denotes information added by Branch
• (for the curious, $ denotes reserved keywords used for controlling how the Branch service behaves)

Note: Branch.initSession() must be called prior to calling any other Branch functions.

Initializes the branch instance with automatic session management. Implements same callback as of initSession.

branch.getAutoSession();

Same as initSession.

Note: Branch.getAutoSession() must be called prior to calling any other Branch functions. Branch.getAutoSession() in iOS is equivalent to Branch.initSession() which already has automatic session management. Use getAutoSession() to avoid having separate calls for Android and iOS.

Retrieves the session (install or open) parameters.

var sessionParams = branch.getLatestReferringParams();

Retrieves the install session parameters.

var installParams = branch.getFirstReferringParams();

Sets the identity of a user and returns the data. To use this function, pass a unique string that identifies the user - this could be an email address, UUID, Facebook ID, etc.

Parameters

identity: string, required - a string uniquely identifying the user – often a user ID or email address.

branch.setIdentity(identity);

Logs out the current session, replaces session IDs and identity IDs.

branch.logout();

Registers custom events.

Parameters

customAction: string, required - a string for your custom action (e.g. "complete_purchase", "wrote_message", "finished_level_ten", etc).

branch.userCompletedAction(customAction);

Creates a new Branch Universal Object.

Parameters

options: dictionary, required - options in creating the object.

branchUniversalObjectProxy.createBranchUniversalObject({
  "canonicalIdentifier" : "sample-id",
  "title" : "Sample",
  "contentDescription" : "This is a sample",
  "contentImageUrl" : "http://sample-host.com/media/1235904.jpg",
  "contentIndexingMode" : "private",
  "contentMetadata" : {
      "key" : "value",
      "key2" : "value2"
  },
});

Registers the view.

branchUniversalObjectProxy.registerView();

Generates a URL for deep linking.

Parameters

options: dictionary, required - options needed to generate the URL.

controlParameters: dictionary, required - link properties needed to generate the URL.

branchUniversalObjectProxy.generateShortUrl({
  "feature" : "sample-feature",
  "alias" : "sample-alias",
  "channel" : "sample-channel",
  "stage" : "sample-stage",
  "duration" : 1,
}, {
  "$desktop_url" : "http://desktop-url.com",
});

To implement the callback, you must add a listener to the event bio:generateShortUrl. The event returns a string object containing the generated link.

Note: Avoid passing alias in iOS. Adding an alias key in the options parameter will return a Non-Universal link which will not work in iOS 9.2.

Shows the custom share sheet to share the link.

Parameters

options: dictionary, required - options for the share sheet.

controlParameters: dictionary, required - link properties needed to generate the URL.

branchUniversalObjectProxy.showShareSheet({
  "feature" : "sample-feature",
  "alias" : "sample-alias",
  "channel" : "sample-channel",
  "stage" : "sample-stage",
  "duration" : 1,
}, {
  "$desktop_url" : "http://desktop-url.com",
});

To implement the callback, you must add listeners to the following events:

bio:shareLinkDialogLaunched

• The event fires when the share sheet is presented.

bio:shareLinkDialogDismissed

• The event fires when the share sheet is dismissed.

bio:shareLinkResponse

• The event returns a dictionary of the response data.

bio:shareChannelSelected

• The event fires a channel is selected.

Note: Callbacks in iOS are ignored. There is no need to implement them as the events are handled by UIActivityViewController.

Note: Avoid passing alias in iOS. Adding an alias key in the options parameter will return a Non-Universal link which will not work in iOS 9.2.

Retrieves the Reward Balance.

branch.loadRewards();

To implement the callback, you must add a listener to the event bio:loadRewards. The event returns a dictionary object containing the balance.

Redeems a reward with the given amount/value.

Parameters

value: int, required - amount to be redeemed.

branch.redeemRewards(value);

Retrieves the credit history.

branch.creditHistory();

To implement the callback, you must add a listener to the event bio:creditHistory. The event returns a dictionary object containing the credit history.

Feel free to report any bugs you might encounter in the repo's issues. Any support inquiries outside of bugs please send to support@branch.io.