Index (Branch-SDK 1.6.1 API)

A B C D E F G I K L N O P R S T U V

A

ALWAYS_DEEPLINK - Static variable in class io.branch.referral.Branch: String value indicating whether the link should always initiate a deep link action.
applyReferralCode(String, Branch.BranchReferralInitListener) - Method in class io.branch.referral.Branch: Applies a supplied referral code to the current user session upon initialisation.

B

Branch - Class in io.branch.referral: The core object required when using Branch SDK.
Branch.BranchLinkCreateListener - Interface in io.branch.referral: An Interface class that is implemented by all classes that make use of Branch.BranchLinkCreateListener, defining a single method that takes a URL String format, and an error message of BranchError format that will be returned on failure of the request response.
Branch.BranchListResponseListener - Interface in io.branch.referral: An Interface class that is implemented by all classes that make use of Branch.BranchListResponseListener, defining a single method that takes a list of JSONArray format, and an error message of BranchError format that will be returned on failure of the request response.
Branch.BranchReferralInitListener - Interface in io.branch.referral: An Interface class that is implemented by all classes that make use of Branch.BranchReferralInitListener, defining a single method that takes a list of params in JSONObject format, and an error message of BranchError format that will be returned on failure of the request response.
Branch.BranchReferralStateChangedListener - Interface in io.branch.referral: An Interface class that is implemented by all classes that make use of Branch.BranchReferralStateChangedListener, defining a single method that takes a value of Boolean format, and an error message of BranchError format that will be returned on failure of the request response.
Branch.BranchWindowCallback - Class in io.branch.referral
Branch.BranchWindowCallback(Window.Callback) - Constructor for class io.branch.referral.Branch.BranchWindowCallback
Branch.CreditHistoryOrder - Enum in io.branch.referral: enum containing the sort options for return of credit history.
BRANCH_API_LVL_ERR_MSG - Static variable in exception io.branch.referral.BranchException
BranchApp - Class in io.branch.referral: Default Android Application class for Branch SDK.
BranchApp() - Constructor for class io.branch.referral.BranchApp
BranchError - Class in io.branch.referral: Returns a general error if the server back-end is down.
BranchError(String, int) - Constructor for class io.branch.referral.BranchError
BranchException - Exception in io.branch.referral: Class for representing any Branch SDK exceptions.
BranchRemoteInterface - Class in io.branch.referral
BranchRemoteInterface() - Constructor for class io.branch.referral.BranchRemoteInterface: Required, but empty constructor method.
BranchRemoteInterface(Context) - Constructor for class io.branch.referral.BranchRemoteInterface: The main constructor of the BranchRemoteInterface class.

C

clearDebug() - Method in class io.branch.referral.PrefHelper: Disable debugging, by setting the Boolean debug flags PrefHelper.BNC_Debug and PrefHelper.BNC_Debug_Connecting to false.
clearIsReferrable() - Method in class io.branch.referral.PrefHelper: Sets the PrefHelper.KEY_IS_REFERRABLE value in preferences to 0, or false if parsed as a Boolean.
clearSystemReadStatus() - Method in class io.branch.referral.PrefHelper: Resets the time that the system was last read.
clearUserValues() - Method in class io.branch.referral.PrefHelper: Resets the user-related values that have been stored in preferences.
closeSession() - Method in class io.branch.referral.Branch: Closes the current session, dependent on the state of the PrefHelper.getSmartSession() Boolean value.
connectToDebug() - Method in class io.branch.referral.BranchRemoteInterface: Connect to server debug endpoint.
createCustomUrlSync(JSONObject) - Method in class io.branch.referral.BranchRemoteInterface: Create custom URL, and return the server response for use elsewhere within the app.

D

Debug(String, String) - Static method in class io.branch.referral.PrefHelper: Creates a Debug message in the debugger.
DEBUG_TRIGGER_NUM_FINGERS - Static variable in class io.branch.referral.PrefHelper: The debug action is triggered by holding a multi-touch gesture.
DEBUG_TRIGGER_PRESS_TIME - Static variable in class io.branch.referral.PrefHelper: The debug action is triggered by holding a multi-touch gesture.
DEEPLINK_PATH - Static variable in class io.branch.referral.Branch: String value denoting the deep link path to override Branch's default one.
disableAppList() - Method in class io.branch.referral.Branch: Calls the PrefHelper.disableExternAppListing() on the local instance to prevent a list of installed apps from being returned to the Branch API.
disableExternAppListing() - Method in class io.branch.referral.PrefHelper: Sets the Boolean value that is checked prior to the listing of external apps to false.
disableSmartSession() - Method in class io.branch.referral.Branch: If there's further Branch API call happening within the two seconds, we then don't close the session; otherwise, we close the session after two seconds.
disableSmartSession() - Method in class io.branch.referral.PrefHelper: Branch.disableSmartSession()
disableTouchDebugging() - Method in class io.branch.referral.Branch: Calls the PrefHelper.disableTouchDebugging() ()} on the local instance to prevent touch debugging feature.
disableTouchDebugging() - Method in class io.branch.referral.PrefHelper: Sets the Boolean value that is checked prior to setting touch debugging feature.
disconnectFromDebug() - Method in class io.branch.referral.BranchRemoteInterface: Disconnect from the server debug interface.
dispatchGenericMotionEvent(MotionEvent) - Method in class io.branch.referral.Branch.BranchWindowCallback
dispatchKeyEvent(KeyEvent) - Method in class io.branch.referral.Branch.BranchWindowCallback
dispatchKeyShortcutEvent(KeyEvent) - Method in class io.branch.referral.Branch.BranchWindowCallback
dispatchPopulateAccessibilityEvent(AccessibilityEvent) - Method in class io.branch.referral.Branch.BranchWindowCallback
dispatchTouchEvent(MotionEvent) - Method in class io.branch.referral.Branch.BranchWindowCallback
dispatchTrackballEvent(MotionEvent) - Method in class io.branch.referral.Branch.BranchWindowCallback

E

ERR_BRANCH_DUPLICATE_REFERRAL_CODE - Static variable in class io.branch.referral.BranchError
ERR_BRANCH_DUPLICATE_URL - Static variable in class io.branch.referral.BranchError
ERR_BRANCH_INIT_FAILED - Static variable in class io.branch.referral.BranchError
ERR_BRANCH_REDEEM_REWARD - Static variable in class io.branch.referral.BranchError
ERR_INVALID_REFERRAL_CODE - Static variable in class io.branch.referral.BranchError
ERR_NO_INTERNET_PERMISSION - Static variable in class io.branch.referral.BranchError
ERR_NO_SESSION - Static variable in class io.branch.referral.BranchError

F

FEATURE_TAG_DEAL - Static variable in class io.branch.referral.Branch: Hard-coded String that denotes a link that is part of a commercial 'deal' or offer.
FEATURE_TAG_GIFT - Static variable in class io.branch.referral.Branch: Hard-coded String that denotes a link tagged as a gift action within a service or product.
FEATURE_TAG_INVITE - Static variable in class io.branch.referral.Branch: Hard-coded String that denotes a 'referral' tag; applies to links that are sent as referral actions by users of an app using an 'invite contacts' feature for instance.
FEATURE_TAG_REFERRAL - Static variable in class io.branch.referral.Branch: Hard-coded String that denotes a 'referral' tag; applies to links that are associated with a referral program, incentivized or not.
FEATURE_TAG_SHARE - Static variable in class io.branch.referral.Branch: Hard-coded String that denotes a BranchLinkData.tags; applies to links that are shared with others directly as a user action, via social media for instance.
finished(ServerResponse) - Method in class io.branch.referral.PrefHelper.DebugNetworkCallback: Called when the server response is returned following a request to the debug API.

G

getActionTotalCount(String) - Method in class io.branch.referral.PrefHelper: Gets the count of total number of times that the specified action has been carried out during the current session, as defined in preferences.
getActionUniqueCount(String) - Method in class io.branch.referral.PrefHelper: Gets the count of the unique number of times that the specified action has been carried out during the current session, as defined in preferences.
getAPIBaseUrl() - Method in class io.branch.referral.PrefHelper: Returns the base URL to use for all calls to the Branch API as a String.
getAPILevelException() - Static method in exception io.branch.referral.BranchException
getAppKey() - Method in class io.branch.referral.PrefHelper: Gets the Branch App Key in preferences programmatically.
getAppVersion() - Method in class io.branch.referral.PrefHelper: Returns the current value of PrefHelper.KEY_APP_VERSION as stored in preferences.
getAutoInstance(Context) - Static method in class io.branch.referral.Branch: Singleton method to return the pre-initialised, or newly initialise and return, a singleton object of the type Branch.
getAutoTestInstance(Context) - Static method in class io.branch.referral.Branch: If you configured the your Strings file according to the guide, you'll be able to use the test version of your app by just calling this static method before calling initSession.
getBool(String) - Method in class io.branch.referral.PrefHelper: A basic method that returns a Boolean value from a specified preferences Key.
getBranchKey() - Method in class io.branch.referral.PrefHelper
getConnectionStatus() - Method in class io.branch.referral.PrefHelper.DebugNetworkCallback
getContentUrl(String, JSONObject, Branch.BranchLinkCreateListener) - Method in class io.branch.referral.Branch: Configures and requests a content URL (defined as feature = sharing) to be generated by the Branch servers.
getContentUrl(Collection<String>, String, JSONObject, Branch.BranchLinkCreateListener) - Method in class io.branch.referral.Branch: Configures and requests a content URL (defined as feature = sharing) to be generated by the Branch servers.
getContentUrlSync(String, JSONObject) - Method in class io.branch.referral.Branch: Configures and requests a content URL (defined as feature = sharing) to be generated by the Branch servers, via a synchronous call
getContentUrlSync(Collection<String>, String, JSONObject) - Method in class io.branch.referral.Branch: Configures and requests a content URL (defined as feature = sharing) to be generated by the Branch servers, via a synchronous call
getCreditCount() - Method in class io.branch.referral.PrefHelper: Get the current cached credit count for the default bucket, as currently stored in preferences for the current app.
getCreditCount(String) - Method in class io.branch.referral.PrefHelper: Get the current cached credit count for the default bucket, as currently stored in preferences for the current app.
getCreditHistory(Branch.BranchListResponseListener) - Method in class io.branch.referral.Branch: Gets the credit history of the specified bucket and triggers a callback to handle the response.
getCreditHistory(String, Branch.BranchListResponseListener) - Method in class io.branch.referral.Branch: Gets the credit history of the specified bucket and triggers a callback to handle the response.
getCreditHistory(String, int, Branch.CreditHistoryOrder, Branch.BranchListResponseListener) - Method in class io.branch.referral.Branch: Gets the credit history of the specified bucket and triggers a callback to handle the response.
getCreditHistory(String, String, int, Branch.CreditHistoryOrder, Branch.BranchListResponseListener) - Method in class io.branch.referral.Branch: Gets the credit history of the specified bucket and triggers a callback to handle the response.
getCredits() - Method in class io.branch.referral.Branch: Retrieve the number of credits available for the "default" bucket.
getCreditsForBucket(String) - Method in class io.branch.referral.Branch: Returns an Integer of the number of credits available for use within the supplied bucket name.
getDeviceFingerPrintID() - Method in class io.branch.referral.PrefHelper: Gets the Build.FINGERPRINT value of the current OS build, on the current device, as a String from preferences.
getExternAppListing() - Method in class io.branch.referral.PrefHelper: Sets the Boolean value that is checked prior to the listing of external apps.
getExternDebug() - Method in class io.branch.referral.PrefHelper: Gets the value of the debug status Boolean value.
getFirstReferringParams() - Method in class io.branch.referral.Branch: Returns the parameters associated with the link that referred the user.
getFloat(String) - Method in class io.branch.referral.PrefHelper: A basic method that returns a Float value from a specified preferences Key.
getIdentity() - Method in class io.branch.referral.PrefHelper: Gets the PrefHelper.KEY_IDENTITY String value that has been set via the Branch API.
getIdentityID() - Method in class io.branch.referral.PrefHelper: Gets the KEY_IDENTITY_ID String value that has been set via the Branch API.
getInstallParams() - Method in class io.branch.referral.PrefHelper: Gets the session parameters as originally set at time of app installation, in preferences.
getInstance() - Static method in class io.branch.referral.Branch: Singleton method to return the pre-initialised object of the type Branch.
getInstance(Context, String) - Static method in class io.branch.referral.Branch: Singleton method to return the pre-initialised, or newly initialise and return, a singleton object of the type Branch.
getInstance(Context) - Static method in class io.branch.referral.Branch: Singleton method to return the pre-initialised, or newly initialise and return, a singleton object of the type Branch.
getInstance(Context) - Static method in class io.branch.referral.PrefHelper: Singleton method to return the pre-initialised, or newly initialise and return, a singleton object of the type PrefHelper.
getInstantiationException() - Static method in exception io.branch.referral.BranchException
getInteger(String) - Method in class io.branch.referral.PrefHelper: A basic method that returns an integer value from a specified preferences Key.
getInteger(String, int) - Method in class io.branch.referral.PrefHelper: A basic method that returns an Integer value from a specified preferences Key, with a default value supplied in case the value is null.
getIsReferrable() - Method in class io.branch.referral.PrefHelper: Gets the Integer value of the preference setting PrefHelper.KEY_IS_REFERRABLE, which indicates whether or not the current session should be considered referrable.
getLatestReferringParams() - Method in class io.branch.referral.Branch: Returns the parameters associated with the link that referred the session.
getLinkClickID() - Method in class io.branch.referral.PrefHelper: Gets the PrefHelper.KEY_LINK_CLICK_ID String value that has been set via the Branch API.
getLinkClickIdentifier() - Method in class io.branch.referral.PrefHelper: Gets the KEY_LINK_CLICK_IDENTIFER String value that has been set via the Branch API.
getLong(String) - Method in class io.branch.referral.PrefHelper: A basic method that returns a Long value from a specified preferences Key.
getMessage() - Method in class io.branch.referral.BranchError: Returns the message explaining the error.
getMessage() - Method in exception io.branch.referral.BranchException
getReferralCode(Branch.BranchReferralInitListener) - Method in class io.branch.referral.Branch: Configures and requests a referral code to be generated by the Branch servers.
getReferralCode(int, Branch.BranchReferralInitListener) - Method in class io.branch.referral.Branch: Configures and requests a referral code to be generated by the Branch servers.
getReferralCode(String, int, Branch.BranchReferralInitListener) - Method in class io.branch.referral.Branch: Configures and requests a referral code to be generated by the Branch servers.
getReferralCode(int, Date, Branch.BranchReferralInitListener) - Method in class io.branch.referral.Branch: Configures and requests a referral code to be generated by the Branch servers.
getReferralCode(String, int, Date, Branch.BranchReferralInitListener) - Method in class io.branch.referral.Branch: Configures and requests a referral code to be generated by the Branch servers.
getReferralCode(String, int, int, int, Branch.BranchReferralInitListener) - Method in class io.branch.referral.Branch: Configures and requests a referral code to be generated by the Branch servers.
getReferralCode(String, int, Date, String, int, int, Branch.BranchReferralInitListener) - Method in class io.branch.referral.Branch: Configures and requests a referral code to be generated by the Branch servers.
getReferralUrl(String, JSONObject, Branch.BranchLinkCreateListener) - Method in class io.branch.referral.Branch: Configures and requests a referral URL (feature = referral) to be generated by the Branch servers.
getReferralUrl(Collection<String>, String, JSONObject, Branch.BranchLinkCreateListener) - Method in class io.branch.referral.Branch: Configures and requests a referral URL (feature = referral) to be generated by the Branch servers.
getReferralUrlSync(String, JSONObject) - Method in class io.branch.referral.Branch: Configures and requests a referral URL to be generated by the Branch servers, via a synchronous call; with a duration specified within which an app session should be matched to the link.
getReferralUrlSync(Collection<String>, String, JSONObject) - Method in class io.branch.referral.Branch: Configures and requests a referral URL to be generated by the Branch servers, via a synchronous call; with a duration specified within which an app session should be matched to the link.
getRetryCount() - Method in class io.branch.referral.PrefHelper: Gets the current count of the number of times that a Branch API call has been re-attempted.
getRetryInterval() - Method in class io.branch.referral.PrefHelper: Gets the amount of time in milliseconds to wait before re-attempting a timed-out request to the Branch API.
getSessionID() - Method in class io.branch.referral.PrefHelper: Gets the ID of the KEY_SESSION_ID String value from preferences.
getSessionParams() - Method in class io.branch.referral.PrefHelper: Gets the session parameters as currently set in preferences.
getShortUrl(Branch.BranchLinkCreateListener) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers.
getShortUrl(JSONObject, Branch.BranchLinkCreateListener) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers.
getShortUrl(String, String, String, JSONObject, Branch.BranchLinkCreateListener) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers.
getShortUrl(String, String, String, String, JSONObject, Branch.BranchLinkCreateListener) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers.
getShortUrl(int, String, String, String, JSONObject, Branch.BranchLinkCreateListener) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers.
getShortUrl(String, String, String, JSONObject, int, Branch.BranchLinkCreateListener) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers.
getShortUrl(Collection<String>, String, String, String, JSONObject, Branch.BranchLinkCreateListener) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers.
getShortUrl(String, Collection<String>, String, String, String, JSONObject, Branch.BranchLinkCreateListener) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers.
getShortUrl(int, Collection<String>, String, String, String, JSONObject, Branch.BranchLinkCreateListener) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers.
getShortUrl(Collection<String>, String, String, String, JSONObject, int, Branch.BranchLinkCreateListener) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers.
getShortUrlSync() - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers, via a synchronous call; with a duration specified within which an app session should be matched to the link.
getShortUrlSync(JSONObject) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers, via a synchronous call; with a duration specified within which an app session should be matched to the link.
getShortUrlSync(String, String, String, JSONObject) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers, via a synchronous call; with a duration specified within which an app session should be matched to the link.
getShortUrlSync(String, String, String, String, JSONObject) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers, via a synchronous call; with a duration specified within which an app session should be matched to the link.
getShortUrlSync(int, String, String, String, JSONObject) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers, via a synchronous call; with a duration specified within which an app session should be matched to the link.
getShortUrlSync(String, String, String, JSONObject, int) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers, via a synchronous call; with a duration specified within which an app session should be matched to the link.
getShortUrlSync(Collection<String>, String, String, String, JSONObject) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers, via a synchronous call; with a duration specified within which an app session should be matched to the link.
getShortUrlSync(String, Collection<String>, String, String, String, JSONObject) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers, via a synchronous call; with a duration specified within which an app session should be matched to the link.
getShortUrlSync(int, Collection<String>, String, String, String, JSONObject) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers, via a synchronous call; with a duration specified within which an app session should be matched to the link.
getShortUrlSync(Collection<String>, String, String, String, JSONObject, int) - Method in class io.branch.referral.Branch: Configures and requests a short URL to be generated by the Branch servers, via a synchronous call; with a duration specified within which an app session should be matched to the link.
getSmartSession() - Method in class io.branch.referral.PrefHelper: Gets the state of the Boolean value indicating whether or not the Smart Session feature is enabled or not.
getString(String) - Method in class io.branch.referral.PrefHelper: A basic method that returns a String value from a specified preferences Key.
getSystemObserver() - Method in class io.branch.referral.BranchRemoteInterface
getTestInstance(Context) - Static method in class io.branch.referral.Branch: If you configured the your Strings file according to the guide, you'll be able to use the test version of your app by just calling this static method before calling initSession.
getTimeout() - Method in class io.branch.referral.PrefHelper: Returns the currently set timeout value for calls to the Branch API.
getTotalCountsForAction(String) - Method in class io.branch.referral.Branch: Gets the total number of times that the specified action has been carried out.
getTouchDebugging() - Method in class io.branch.referral.PrefHelper: Sets the Boolean value that is checked prior to setting touch debugging feature .
getUniqueCountsForAction(String) - Method in class io.branch.referral.Branch: Gets the number of unique times that the specified action has been carried out.
getUserURL() - Method in class io.branch.referral.PrefHelper: Sets the user URL from preferences.

I

initSession(Branch.BranchReferralInitListener) - Method in class io.branch.referral.Branch: Initialises a session with the Branch API, assigning a Branch.BranchReferralInitListener to perform an action upon successful initialisation.
initSession(Branch.BranchReferralInitListener, Activity) - Method in class io.branch.referral.Branch: Initialises a session with the Branch API, passing the Activity and assigning a Branch.BranchReferralInitListener to perform an action upon successful initialisation.
initSession(Branch.BranchReferralInitListener, Uri) - Method in class io.branch.referral.Branch: Initialises a session with the Branch API.
initSession(Branch.BranchReferralInitListener, Uri, Activity) - Method in class io.branch.referral.Branch: Initialises a session with the Branch API.
initSession() - Method in class io.branch.referral.Branch: Initialises a session with the Branch API, without a callback or Activity.
initSession(Activity) - Method in class io.branch.referral.Branch: Initialises a session with the Branch API, without a callback or Activity.
initSession(boolean) - Method in class io.branch.referral.Branch: Initialises a session with the Branch API, specifying whether the initialisation can count as a referrable action.
initSession(boolean, Activity) - Method in class io.branch.referral.Branch: Initialises a session with the Branch API, specifying whether the initialisation can count as a referrable action, and supplying the calling Activity for context.
initSession(Branch.BranchReferralInitListener, boolean, Uri) - Method in class io.branch.referral.Branch: Initialises a session with the Branch API.
initSession(Branch.BranchReferralInitListener, boolean, Uri, Activity) - Method in class io.branch.referral.Branch: Initialises a session with the Branch API.
initSession(Branch.BranchReferralInitListener, boolean) - Method in class io.branch.referral.Branch: Initialises a session with the Branch API.
initSession(Branch.BranchReferralInitListener, boolean, Activity) - Method in class io.branch.referral.Branch: Initialises a session with the Branch API.
initSessionWithData(Uri) - Method in class io.branch.referral.Branch: Initialises a session with the Branch API, with associated data from the supplied Uri.
initSessionWithData(Uri, Activity) - Method in class io.branch.referral.Branch: Initialises a session with the Branch API, with associated data from the supplied Uri.
io.branch.referral - package io.branch.referral
isDebug() - Method in class io.branch.referral.PrefHelper: Gets the Boolean value of PrefHelper.BNC_Debug, which indicates whether or not debugging is enabled.
isUserIdentified() - Method in class io.branch.referral.Branch: Indicates whether or not this user has a custom identity specified for them.

K

keepDebugConnection() - Method in class io.branch.referral.PrefHelper: Sends an empty logging message to keep the debugger connection alive.

L

LINK_TYPE_ONE_TIME_USE - Static variable in class io.branch.referral.Branch: An Integer value indicating the link type.
LINK_TYPE_UNLIMITED_USE - Static variable in class io.branch.referral.Branch: An Integer value indicating the link type.
loadActionCounts() - Method in class io.branch.referral.Branch: Fire-and-forget retrieval of action count for the current session.
loadActionCounts(Branch.BranchReferralStateChangedListener) - Method in class io.branch.referral.Branch: Gets the total action count, with a callback to perform a predefined action following successful report of state change.
loadRewards() - Method in class io.branch.referral.Branch: Fire-and-forget retrieval of rewards for the current session.
loadRewards(Branch.BranchReferralStateChangedListener) - Method in class io.branch.referral.Branch: Retrieves rewards for the current session, with a callback to perform a predefined action following successful report of state change.
log(String, String) - Method in class io.branch.referral.PrefHelper: Creates a Log message in the debugger.
logout() - Method in class io.branch.referral.Branch: This method should be called if you know that a different person is about to use the app.

N

NO_STRING_VALUE - Static variable in class io.branch.referral.PrefHelper: A String value used where no string value is available.

O

OG_APP_ID - Static variable in class io.branch.referral.Branch: Unique identifier for the app in use.
OG_DESC - Static variable in class io.branch.referral.Branch: The description of the object to appear in social media feeds that use Facebook's Open Graph specification.
OG_IMAGE_URL - Static variable in class io.branch.referral.Branch: An image URL which should represent your object to appear in social media feeds that use Facebook's Open Graph specification.
OG_TITLE - Static variable in class io.branch.referral.Branch: Open Graph: The title of your object as it should appear within the graph, e.g., "The Rock".
OG_URL - Static variable in class io.branch.referral.Branch: The canonical URL of your object that will be used as its permanent ID in the graph.
OG_VIDEO - Static variable in class io.branch.referral.Branch: A URL to a video file that complements this object.
onActionModeFinished(ActionMode) - Method in class io.branch.referral.Branch.BranchWindowCallback
onActionModeStarted(ActionMode) - Method in class io.branch.referral.Branch.BranchWindowCallback
onAttachedToWindow() - Method in class io.branch.referral.Branch.BranchWindowCallback
onContentChanged() - Method in class io.branch.referral.Branch.BranchWindowCallback
onCreate() - Method in class io.branch.referral.BranchApp
onCreatePanelMenu(int, Menu) - Method in class io.branch.referral.Branch.BranchWindowCallback
onCreatePanelView(int) - Method in class io.branch.referral.Branch.BranchWindowCallback
onDetachedFromWindow() - Method in class io.branch.referral.Branch.BranchWindowCallback
onInitFinished(JSONObject, BranchError) - Method in interface io.branch.referral.Branch.BranchReferralInitListener
onLinkCreate(String, BranchError) - Method in interface io.branch.referral.Branch.BranchLinkCreateListener
onMenuItemSelected(int, MenuItem) - Method in class io.branch.referral.Branch.BranchWindowCallback
onMenuOpened(int, Menu) - Method in class io.branch.referral.Branch.BranchWindowCallback
onPanelClosed(int, Menu) - Method in class io.branch.referral.Branch.BranchWindowCallback
onPreparePanel(int, View, Menu) - Method in class io.branch.referral.Branch.BranchWindowCallback
onReceivingResponse(JSONArray, BranchError) - Method in interface io.branch.referral.Branch.BranchListResponseListener
onSearchRequested() - Method in class io.branch.referral.Branch.BranchWindowCallback
onStateChanged(boolean, BranchError) - Method in interface io.branch.referral.Branch.BranchReferralStateChangedListener
onWindowAttributesChanged(WindowManager.LayoutParams) - Method in class io.branch.referral.Branch.BranchWindowCallback
onWindowFocusChanged(boolean) - Method in class io.branch.referral.Branch.BranchWindowCallback
onWindowStartingActionMode(ActionMode.Callback) - Method in class io.branch.referral.Branch.BranchWindowCallback

P

PrefHelper - Class in io.branch.referral: A class that uses the helper pattern to provide regularly referenced static values and logging capabilities used in various other parts of the SDK, and that are related to globally set preference values.
PrefHelper() - Constructor for class io.branch.referral.PrefHelper: Empty, but required constructor for the PrefHelper SharedPreferences helper class.
PrefHelper.DebugNetworkCallback - Class in io.branch.referral: Debug connection callback that implements NetworkCallback to react to server calls to debug API end-points.
PrefHelper.DebugNetworkCallback() - Constructor for class io.branch.referral.PrefHelper.DebugNetworkCallback

R

readBranchKey(boolean) - Method in class io.branch.referral.PrefHelper
REDEEM_CODE - Static variable in class io.branch.referral.Branch: The code to be passed as part of a deal or gift; retrieved from the Branch object as a tag upon initialisation.
redeemRewards(int) - Method in class io.branch.referral.Branch: Redeems the specified number of credits from the "default" bucket, if there are sufficient credits within it.
redeemRewards(int, Branch.BranchReferralStateChangedListener) - Method in class io.branch.referral.Branch: Redeems the specified number of credits from the "default" bucket, if there are sufficient credits within it.
redeemRewards(String, int) - Method in class io.branch.referral.Branch: Redeems the specified number of credits from the named bucket, if there are sufficient credits within it.
redeemRewards(String, int, Branch.BranchReferralStateChangedListener) - Method in class io.branch.referral.Branch: Redeems the specified number of credits from the named bucket, if there are sufficient credits within it.
REDIRECT_ANDROID_URL - Static variable in class io.branch.referral.Branch: The redirect URL provided when the link is handled by an Android device.
REDIRECT_BLACKBERRY_URL - Static variable in class io.branch.referral.Branch: The redirect URL provided when the link is handled by a Blackberry device.
REDIRECT_DESKTOP_URL - Static variable in class io.branch.referral.Branch: The redirect URL provided when the link is handled by a desktop client.
REDIRECT_FIRE_URL - Static variable in class io.branch.referral.Branch: The redirect URL provided when the link is handled by an Amazon Fire device.
REDIRECT_IOS_URL - Static variable in class io.branch.referral.Branch: The redirect URL provided when the link is handled by an iOS device.
REDIRECT_IPAD_URL - Static variable in class io.branch.referral.Branch: The redirect URL provided when the link is handled by a large form-factor iOS device such as an iPad.
REDIRECT_WINDOWS_PHONE_URL - Static variable in class io.branch.referral.Branch: The redirect URL provided when the link is handled by a Windows Phone device.
REFERRAL_BUCKET_DEFAULT - Static variable in class io.branch.referral.Branch: Default value of referral bucket; referral buckets contain credits that are used when users are referred to your apps.
REFERRAL_CODE - Static variable in class io.branch.referral.Branch: Key value for referral code as a parameter.
REFERRAL_CODE_AWARD_UNIQUE - Static variable in class io.branch.referral.Branch: An Integer value indicating the calculation type of the referral code.
REFERRAL_CODE_AWARD_UNLIMITED - Static variable in class io.branch.referral.Branch: An Integer value indicating the calculation type of the referral code.
REFERRAL_CODE_LOCATION_BOTH - Static variable in class io.branch.referral.Branch: An Integer value indicating the user to reward for applying a referral code.
REFERRAL_CODE_LOCATION_REFERREE - Static variable in class io.branch.referral.Branch: An Integer value indicating the user to reward for applying a referral code.
REFERRAL_CODE_LOCATION_REFERRING_USER - Static variable in class io.branch.referral.Branch: An Integer value indicating the user to reward for applying a referral code.
REFERRAL_CODE_TYPE - Static variable in class io.branch.referral.Branch: Hard-coded value for referral code type.
REFERRAL_CREATION_SOURCE_SDK - Static variable in class io.branch.referral.Branch: Branch SDK version for the current release of the Branch SDK.
REQ_TAG_DEBUG_CONNECT - Static variable in class io.branch.referral.PrefHelper: String value used by BranchRemoteInterface.connectToDebug().
REQ_TAG_DEBUG_DISCONNECT - Static variable in class io.branch.referral.PrefHelper: String value used by BranchRemoteInterface.disconnectFromDebug().
REQ_TAG_DEBUG_LOG - Static variable in class io.branch.referral.PrefHelper: String value used by BranchRemoteInterface.sendLog(String log).
REQ_TAG_DEBUG_SCREEN - Static variable in class io.branch.referral.PrefHelper: String value used by BranchRemoteInterface.
resetUserSession() - Method in class io.branch.referral.Branch: Manually sets the Boolean value, that indicates that the Branch API connection has been initialised, to false - forcing re-initialisation.

S

sendLog(String) - Method in class io.branch.referral.BranchRemoteInterface: Log messages to the server's debug interface.
setActionTotalCount(String, int) - Method in class io.branch.referral.PrefHelper: Sets the count of total number of times that the specified action has been carried out during the current session, as defined in preferences.
setActionUniqueCount(String, int) - Method in class io.branch.referral.PrefHelper: Sets the count of the unique number of times that the specified action has been carried out during the current session, as defined in preferences.
setAppKey(String) - Method in class io.branch.referral.PrefHelper: Sets the Branch App Key in preferences programmatically.
setAppVersion(String) - Method in class io.branch.referral.PrefHelper: Sets the value of PrefHelper.KEY_APP_VERSION in preferences.
setBool(String, Boolean) - Method in class io.branch.referral.PrefHelper: Sets the value of the String key value supplied in preferences.
setBranchKey(String) - Method in class io.branch.referral.PrefHelper
setCreditCount(int) - Method in class io.branch.referral.PrefHelper: Sets the credit count for the default bucket to the specified Integer, in preferences.
setCreditCount(String, int) - Method in class io.branch.referral.PrefHelper: Sets the credit count for the default bucket to the specified Integer, in preferences.
setDebug() - Method in class io.branch.referral.Branch: Sets the library to function in debug mode, enabling logging of all requests.
setDebug() - Method in class io.branch.referral.PrefHelper: Enable debugging, by setting the Boolean debug flags PrefHelper.BNC_Debug and PrefHelper.BNC_Debug_Connecting to true.
setDeviceFingerPrintID(String) - Method in class io.branch.referral.PrefHelper: Sets the Build.FINGERPRINT value of the current OS build, on the current device, as a String in preferences.
setExternDebug() - Method in class io.branch.referral.PrefHelper: Switches external debugging on.
setFloat(String, float) - Method in class io.branch.referral.PrefHelper: Sets the value of the String key value supplied in preferences.
setIdentity(String) - Method in class io.branch.referral.Branch: Identifies the current user to the Branch API by supplying a unique identifier as a String value.
setIdentity(String, Branch.BranchReferralInitListener) - Method in class io.branch.referral.Branch: Identifies the current user to the Branch API by supplying a unique identifier as a String value, with a callback specified to perform a defined action upon successful response to request.
setIdentity(String) - Method in class io.branch.referral.PrefHelper: Sets the KEY_IDENTITY String value that has been set via the Branch API.
setIdentityID(String) - Method in class io.branch.referral.PrefHelper: Sets the KEY_IDENTITY_ID String value that has been set via the Branch API.
setInstallParams(String) - Method in class io.branch.referral.PrefHelper: Sets the session parameters as originally set at time of app installation, in preferences.
setInteger(String, int) - Method in class io.branch.referral.PrefHelper: Sets the value of the String key value supplied in preferences.
setIsReferrable() - Method in class io.branch.referral.PrefHelper: Sets the PrefHelper.KEY_IS_REFERRABLE value in preferences to 1, or true if parsed as a Boolean.
setLinkClickID(String) - Method in class io.branch.referral.PrefHelper: Sets the PrefHelper.KEY_LINK_CLICK_ID String value that has been set via the Branch API.
setLinkClickIdentifier(String) - Method in class io.branch.referral.PrefHelper: Sets the KEY_LINK_CLICK_IDENTIFIER String value that has been set via the Branch API.
setLong(String, long) - Method in class io.branch.referral.PrefHelper: Sets the value of the String key value supplied in preferences.
setNetworkCallbackListener(NetworkCallback) - Method in class io.branch.referral.BranchRemoteInterface: Sets a callback listener to handle network events received during this app session.
setNetworkTimeout(int) - Method in class io.branch.referral.Branch: Sets the duration in milliseconds that the system should wait for a response before considering any Branch API call to have timed out.
setRetryCount(int) - Method in class io.branch.referral.Branch: Sets the number of times to re-attempt a timed-out request to the Branch API, before considering the request to have failed entirely.
setRetryCount(int) - Method in class io.branch.referral.PrefHelper: Sets the value specifying the number of times that a Branch API call has been re-attempted.
setRetryInterval(int) - Method in class io.branch.referral.Branch: Sets the amount of time in milliseconds to wait before re-attempting a timed-out request to the Branch API.
setRetryInterval(int) - Method in class io.branch.referral.PrefHelper: Sets the amount of time in milliseconds to wait before re-attempting a timed-out request to the Branch API.
setSessionID(String) - Method in class io.branch.referral.PrefHelper: Sets the ID of the KEY_SESSION_ID String value in preferences.
setSessionParams(String) - Method in class io.branch.referral.PrefHelper: Sets the session parameters as currently set in preferences.
setString(String, String) - Method in class io.branch.referral.PrefHelper: Sets the value of the String key value supplied in preferences.
setTimeout(int) - Method in class io.branch.referral.PrefHelper: Sets the duration in milliseconds to override the timeout value for calls to the Branch API.
setUserURL(String) - Method in class io.branch.referral.PrefHelper: Sets the user URL from preferences.

T

toString() - Method in class io.branch.referral.BranchError: Overridden toString method for this object; returns the error message rather than the object's address.

U

userCompletedAction(String, JSONObject) - Method in class io.branch.referral.Branch: A void call to indicate that the user has performed a specific action and for that to be reported to the Branch API, with additional app-defined meta data to go along with that action.
userCompletedAction(String) - Method in class io.branch.referral.Branch: A void call to indicate that the user has performed a specific action and for that to be reported to the Branch API.

V

validateReferralCode(String, Branch.BranchReferralInitListener) - Method in class io.branch.referral.Branch: Validates the supplied referral code on initialisation without applying it to the current session.
valueOf(String) - Static method in enum io.branch.referral.Branch.CreditHistoryOrder: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.branch.referral.Branch.CreditHistoryOrder: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G I K L N O P R S T U V