Packageio.branch.nativeExtensions.branch
Classpublic class BranchOptions
InheritanceBranchOptions Inheritance Object

This class defines setup options for the Branch instance and session



Public Properties
 PropertyDefined By
  delayInitToCheckForSearchAds : Boolean = false
iOS only (no affect on Android) Allows Branch to track Apple Search Ads deep linking analytics.
BranchOptions
  enableDebugging : Boolean = false
BranchOptions
  useTestKey : Boolean = false
If true then the Branch SDK will use the test key.
BranchOptions
Public Methods
 MethodDefined By
  
BranchOptions
  
setDebugMode(enabled:Boolean = true):BranchOptions
BranchOptions
  
Sets whether your app will delay initialisation to check for search ads on iOS
BranchOptions
  
setUseTestKey(useTestKey:Boolean = true):BranchOptions
Sets whether your app will use the Branch test key.
BranchOptions
Property Detail
delayInitToCheckForSearchAdsproperty
public var delayInitToCheckForSearchAds:Boolean = false

iOS only (no affect on Android)

Allows Branch to track Apple Search Ads deep linking analytics.

Analytics from Apple's API have been slow which will make our analytics lower. Additionally, Apple's API does not send us all the data of an ad every time which will make ads tracked by us to show a generic campaign sometimes.

The default value is false.

enableDebuggingproperty 
public var enableDebugging:Boolean = false

useTestKeyproperty 
public var useTestKey:Boolean = false

If true then the Branch SDK will use the test key. You should not do this for production apps.

Note: When this is set to the default (false) settings in your manifest (Android) and info additions (iOS) will override this. When you set it to true it will override any setting in your manifest / info additions and force usage of the test key.

The default value is false.

Constructor Detail
BranchOptions()Constructor
public function BranchOptions()



Method Detail
setDebugMode()method
public function setDebugMode(enabled:Boolean = true):BranchOptions

Parameters

enabled:Boolean (default = true)

Returns
BranchOptions
setDelayInitToCheckForSearchAds()method 
public function setDelayInitToCheckForSearchAds(delay:Boolean = true):BranchOptions

Sets whether your app will delay initialisation to check for search ads on iOS

Parameters

delay:Boolean (default = true)

Returns
BranchOptions — The instance of BranchOptions for chaining

See also

setUseTestKey()method 
public function setUseTestKey(useTestKey:Boolean = true):BranchOptions

Sets whether your app will use the Branch test key.

Parameters

useTestKey:Boolean (default = true)

Returns
BranchOptions — The instance of BranchOptions for chaining

See also