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

A

addContentMetadata(HashMap<String, String>) - Method in class io.branch.indexing.BranchUniversalObject

Adds the the given set of key value pairs to the metadata associated with this content.

addContentMetadata(String, String) - Method in class io.branch.indexing.BranchUniversalObject

Adds the the given set of key value pair to the metadata associated with this content.

addControlParameter(String, String) - Method in class io.branch.referral.util.LinkProperties

Adds any control params that control the behaviour of the link.

addExtraInstrumentationData(HashMap<String, String>) - Method in class io.branch.referral.Branch

Update the extra instrumentation data provided to Branch

addExtraInstrumentationData(String, String) - Method in class io.branch.referral.Branch

Update the extra instrumentation data provided to Branch

addGetParam(String, String) - Method in class io.branch.referral.ServerRequest

Adds a param and its value to the get request

addKeyWord(String) - Method in class io.branch.indexing.BranchUniversalObject

Add a keyword associated with the content referred

addKeyWords(ArrayList<String>) - Method in class io.branch.indexing.BranchUniversalObject

Adds any keywords associated with the content referred

addParam(String, String) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Add the given key value to the deep link parameters

addPreferredSharingOption(SharingHelper.SHARE_WITH) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Adds application to the preferred list of applications which are shown on share dialog.

addPreferredSharingOption(SharingHelper.SHARE_WITH) - Method in class io.branch.referral.util.ShareSheetStyle

Adds application to the preferred list of applications which are shown on share dialog.

addPreferredSharingOptions(ArrayList<SharingHelper.SHARE_WITH>) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Adds application to the preferred list of applications which are shown on share dialog.

addProcessWaitLock(ServerRequest.PROCESS_WAIT_LOCK) - Method in class io.branch.referral.ServerRequest

Set the specified process wait lock for this request.

addTag(String) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Adds the given tag an iterable Collection of String tags associated with a deep link.

addTag(String) - Method in class io.branch.referral.util.LinkProperties

Adds a tag to the iterable collection of name associated with a deep link.

addTags(ArrayList<String>) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Adds the given tag an iterable Collection of String tags associated with a deep link.

addWhiteListedScheme(String) - Method in class io.branch.referral.Branch

Add the given URI Scheme to the external Uri white list.

ALWAYS_DEEPLINK - Static variable in class io.branch.referral.Branch

String value indicating whether the link should always initiate a deep link action.

AnimatedDialog - Class in io.branch.referral

Class for creating a Dialog which open and closes with an animation to the content view

AnimatedDialog(Context, boolean) - Constructor for class io.branch.referral.AnimatedDialog

AnimatedDialog(Context, int) - Constructor for class io.branch.referral.AnimatedDialog

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.BranchLinkShareListener - Interface in io.branch.referral

An Interface class that is implemented by all classes that make use of Branch.BranchLinkShareListener, defining methods to listen for link sharing status.

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.BranchUniversalReferralInitListener - Interface in io.branch.referral

An Interface class that is implemented by all classes that make use of Branch.BranchUniversalReferralInitListener, defining a single method that provides BranchUniversalObject, LinkProperties and an error message of BranchError format that will be returned on failure of the request response.

Branch.CreditHistoryOrder - Enum in io.branch.referral

enum containing the sort options for return of credit history.

Branch.IBranchViewControl - Interface in io.branch.referral

Interface for defining optional Branch view behaviour for Activities

Branch.IChannelProperties - Interface in io.branch.referral

An interface class for customizing sharing properties with selected channel.

Branch.LogoutStatusListener - Interface in io.branch.referral

Callback interface for listening logout status

Branch.ShareLinkBuilder - Class in io.branch.referral

Class for building a share link dialog.This creates a chooser for selecting application for sharing a link created with given parameters.

Branch.ShareLinkBuilder(Activity, JSONObject) - Constructor for class io.branch.referral.Branch.ShareLinkBuilder

Creates options for sharing a link with other Applications.

Branch.ShareLinkBuilder(Activity, BranchShortLinkBuilder) - Constructor for class io.branch.referral.Branch.ShareLinkBuilder

*

BRANCH_VIEW_ERR_ALREADY_SHOWING - Static variable in class io.branch.referral.BranchViewHandler

BRANCH_VIEW_ERR_INVALID_VIEW - Static variable in class io.branch.referral.BranchViewHandler

BRANCH_VIEW_ERR_REACHED_LIMIT - Static variable in class io.branch.referral.BranchViewHandler

BRANCH_VIEW_ERR_TEMP_UNAVAILABLE - Static variable in class io.branch.referral.BranchViewHandler

BranchApp - Class in io.branch.referral

Default Android Application class for Branch SDK.

BranchApp() - Constructor for class io.branch.referral.BranchApp

BranchAsyncTask<Params,Progress,Result> - Class in io.branch.referral

Convenient class for handling ASync task with pool executor depending on the SDK platform

BranchAsyncTask() - Constructor for class io.branch.referral.BranchAsyncTask

BranchContentUrlBuilder - Class in io.branch.referral

Created by sojanpr on 8/3/15.

BranchContentUrlBuilder(Context, String) - Constructor for class io.branch.referral.BranchContentUrlBuilder

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

BranchReferralUrlBuilder - Class in io.branch.referral

Class for creating builder for getting a referral url with Branch.

BranchReferralUrlBuilder(Context, String) - Constructor for class io.branch.referral.BranchReferralUrlBuilder

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.

BranchShortLinkBuilder - Class in io.branch.referral

Class for creating builder for getting a short url with Branch.

BranchShortLinkBuilder(Context) - Constructor for class io.branch.referral.BranchShortLinkBuilder

BranchUniversalObject - Class in io.branch.indexing

Class represents a single piece of content within your app, as well as any associated metadata.

BranchUniversalObject() - Constructor for class io.branch.indexing.BranchUniversalObject

Create a BranchUniversalObject with the given content.

BranchUniversalObject.BUO_USER_ACTIONS - Enum in io.branch.indexing

User action associated with BUO.

BranchUniversalObject.CONTENT_INDEX_MODE - Enum in io.branch.indexing

Defines the Content indexing modes PUBLIC | PRIVATE

BranchUniversalObject.RegisterViewStatusListener - Interface in io.branch.indexing

Callback interface for listening register content view status

BranchViewHandler - Class in io.branch.referral

Class for managing Branch Views on application.

BranchViewHandler.IBranchViewEvents - Interface in io.branch.referral

Interface for calling back methods on Branch view lifecycle events

C

cancel() - Method in class io.branch.referral.AnimatedDialog

Cancels the dialog with an animation to the content View.

cancelShareLinkDialog(boolean) - Method in class io.branch.referral.Branch

Cancel current share link operation and Application selector dialog.

clearBranchAnalyticsData() - Method in class io.branch.referral.PrefHelper

clearCallbacks() - Method in class io.branch.referral.ServerRequest

Clears the callbacks associated to this request.

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

Deprecated.

This method is deprecated from SDK v1.14.6. Session Start and close are automatically handled by Branch. In case you need to handle sessions manually inorder to support minimum sdk version less than 14 please consider using SDK version 1.14.5

constructError_ - Variable in class io.branch.referral.ServerRequest

CONTENT_DISCOVER_KEY - Static variable in class io.branch.indexing.ContentDiscoveryManifest

ContentDiscoverer - Class in io.branch.indexing

*Once content discovery is enabled* through Branch, this class is responsible for discovering content entities within an app.

ContentDiscoveryManifest - Class in io.branch.indexing

Created by sojanpr on 6/14/16.

convertToJson() - Method in class io.branch.indexing.BranchUniversalObject

Convert the BUO to corresponding Json representation

createCustomUrlSync(JSONObject) - Method in class io.branch.referral.BranchRemoteInterface

Create custom URL, and return the server response for use elsewhere within the app.

createInstance(JSONObject) - Static method in class io.branch.indexing.BranchUniversalObject

Creates a new BranchUniversalObject with the data provided by JSONObject.

CREATOR - Static variable in class io.branch.indexing.BranchUniversalObject

CREATOR - Static variable in class io.branch.referral.util.LinkProperties

CURRENCY_TYPE - Enum in io.branch.referral.util

Created by sojanpr on 8/31/16.

D

Debug(String, String) - Static method in class io.branch.referral.PrefHelper

Creates a Debug message in the debugger.

DEEPLINK_PATH - Static variable in class io.branch.referral.Branch

String value denoting the deep link path to override Branch's default one.

Defines - Class in io.branch.referral

Defines all Json keys associated with branch request parameters.

Defines() - Constructor for class io.branch.referral.Defines

Defines.Jsonkey - Enum in io.branch.referral

Defines.LinkParam - Enum in io.branch.referral

Defines link parameter keys

Defines.RequestPath - Enum in io.branch.referral

Defines all server path for the requests

describeContents() - Method in class io.branch.indexing.BranchUniversalObject

describeContents() - Method in class io.branch.referral.util.LinkProperties

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.

disableDeviceIDFetch(Boolean) - Static method in class io.branch.referral.Branch

Method to control reading Android ID from device.

disableExternAppListing() - Method in class io.branch.referral.PrefHelper

Sets the Boolean value that is checked prior to the listing of external apps to false.

discoverContent(Activity, String) - Method in class io.branch.indexing.ContentDiscoverer

doesAppHasInternetPermission(Context) - Method in class io.branch.referral.ServerRequest

E

enableFacebookAppLinkCheck() - Method in class io.branch.referral.Branch

Enable Facebook app link check operation during Branch initialisation.

ERR_API_LVL_14_NEEDED - Static variable in class io.branch.referral.BranchError

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_INVALID_REQUEST - Static variable in class io.branch.referral.BranchError

ERR_BRANCH_KEY_INVALID - Static variable in class io.branch.referral.BranchError

ERR_BRANCH_NO_CONNECTIVITY_STATUS - Static variable in class io.branch.referral.BranchError

ERR_BRANCH_NO_SHARE_OPTION - Static variable in class io.branch.referral.BranchError

ERR_BRANCH_NOT_INSTANTIATED - Static variable in class io.branch.referral.BranchError

ERR_BRANCH_REDEEM_REWARD - Static variable in class io.branch.referral.BranchError

ERR_BRANCH_REQ_TIMED_OUT - Static variable in class io.branch.referral.BranchError

ERR_BRANCH_RESOURCE_CONFLICT - Static variable in class io.branch.referral.BranchError

ERR_BRANCH_UNABLE_TO_REACH_SERVERS - 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

executeTask(Params...) - Method in class io.branch.referral.BranchAsyncTask

Execute Params in back ground depending on the platform version.

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.

fromJSON(JSONObject, Context) - Static method in class io.branch.referral.ServerRequest

Converts a JSONObject object containing keys stored as key-value pairs into a ServerRequest.

G

generateContentUrl(Branch.BranchLinkCreateListener) - Method in class io.branch.referral.BranchContentUrlBuilder

Configures and requests a content URL to be generated by the Branch servers, via a asynchronous call; The Branch.BranchLinkCreateListener is called back with the url when the url is generated.

generateReferralUrl(Branch.BranchLinkCreateListener) - Method in class io.branch.referral.BranchReferralUrlBuilder

Configures and requests a referral URL to be generated by the Branch servers, via an asynchronous call; The Branch.BranchLinkCreateListener is called back with the url when the url is generated.

generateShortUrl(Context, LinkProperties, Branch.BranchLinkCreateListener) - Method in class io.branch.indexing.BranchUniversalObject

generateShortUrl(Branch.BranchLinkCreateListener) - Method in class io.branch.referral.BranchShortLinkBuilder

Configures and requests a short URL to be generated by the Branch servers, via a asynchronous call; The Branch.BranchLinkCreateListener is called back with the url when the url is generated.

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.

getActivity() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getAlias() - Method in class io.branch.referral.util.LinkProperties

Get the alias for this link.

getAPIBaseUrl() - Method in class io.branch.referral.PrefHelper

Returns the base URL to use for all calls to the Branch API as a String.

getAppLink() - Method in class io.branch.referral.PrefHelper

Get the App link which statrted the application.

getAppName() - Method in enum io.branch.referral.SharingHelper.SHARE_WITH

getAppVersion() - Method in class io.branch.referral.PrefHelper

Returns the current value of PrefHelper.KEY_APP_VERSION as stored in preferences.

getArray() - Method in class io.branch.referral.ServerResponse

Checks whether the post data associated with the current request is an instance of a JSONArray object, and if so type-casts it to the corresponding class type.

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.

getAutoInstance(Context, boolean) - 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.

getAutoTestInstance(Context, boolean) - 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.

getBranch() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getBranchAnalyticsData() - Method in class io.branch.referral.PrefHelper

getBranchKey() - Method in class io.branch.referral.PrefHelper

getBranchViewUsageCount(String) - Method in class io.branch.referral.PrefHelper

getCallback() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getCampaign() - Method in class io.branch.referral.util.LinkProperties

Gets the campaign for this link.

getCanonicalIdentifier() - Method in class io.branch.indexing.BranchUniversalObject

Get the canonical identifier for this BranchUniversalObject

getCanonicalUrl() - Method in class io.branch.indexing.BranchUniversalObject

Get the canonical url for this BranchUniversalObject

getCDPathProperties(Activity) - Method in class io.branch.indexing.ContentDiscoveryManifest

getChannel() - Method in class io.branch.referral.util.LinkProperties

Gets the channel for this link.

getChannelPropertiesCallback() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getConnectionStatus() - Method in class io.branch.referral.PrefHelper.DebugNetworkCallback

getContentDiscoverDataForCloseRequest(Context) - Method in class io.branch.indexing.ContentDiscoverer

getContentUrl() - Method in class io.branch.referral.BranchContentUrlBuilder

Configures and requests a content URL to be generated by the Branch servers, via a synchronous call.

getControlParams() - Method in class io.branch.referral.util.LinkProperties

Get all control params associated with this LinkProperties

getCopyUrlIcon() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getCopyUrlIcon() - Method in class io.branch.referral.util.ShareSheetStyle

getCopyURlText() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getCopyURlText() - Method in class io.branch.referral.util.ShareSheetStyle

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.

getCurrencyType() - Method in class io.branch.indexing.BranchUniversalObject

Get the currency type of the price for this BUO

getDeeplinkDebugParams() - Method in class io.branch.referral.Branch

getDefaultURL() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getDefaultURL() - Method in class io.branch.referral.util.ShareSheetStyle

getDescription() - Method in class io.branch.indexing.BranchUniversalObject

Get description for the content for the content referred by this object

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.

getDividerHeight() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getDividerHeight() - Method in class io.branch.referral.util.ShareSheetStyle

getErrorCode() - Method in class io.branch.referral.BranchError

Returns an error code for this Branch Error.

getExpirationTime() - Method in class io.branch.indexing.BranchUniversalObject

Get expiry date for the content and any associated links.

getExternalIntentExtra() - Method in class io.branch.referral.PrefHelper

Gets the PrefHelper.KEY_EXTERNAL_INTENT_EXTRA String value that has been set via the Branch API.

getExternalIntentUri() - Method in class io.branch.referral.PrefHelper

Gets the PrefHelper.KEY_EXTERNAL_INTENT_URI String value that has been set via the Branch API.

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.

getFailReason() - Method in class io.branch.referral.ServerResponse

Get the reason for failure if there any

getFeature() - Method in class io.branch.referral.util.LinkProperties

Get a name that identifies the feature that the link makes use of.

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.

getGetParams() - Method in class io.branch.referral.ServerRequest

Returns a JsonObject with the parameters that needed to be set with the get request.

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 PrefHelper.KEY_IDENTITY_ID String value that has been set via the Branch API.

getImageUrl() - Method in class io.branch.indexing.BranchUniversalObject

Get the url to any image associated with this content.

getInstallationID() - Static method in class io.branch.referral.InstallListener

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.indexing.ContentDiscoverer

getInstance(Context) - Static method in class io.branch.indexing.ContentDiscoveryManifest

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() - Static method in class io.branch.referral.BranchViewHandler

Get the singleton instance for BranchViewHandler

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.

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.

getIsAppLinkTriggeredInit() - Method in class io.branch.referral.PrefHelper

Specifies the value to specify if the current init is triggered by an FB app link

getIsFullWidthStyle() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getIsFullWidthStyle() - Method in class io.branch.referral.util.ShareSheetStyle

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.

getKey() - Method in enum io.branch.referral.Defines.Jsonkey

getKey() - Method in enum io.branch.referral.Defines.LinkParam

getKeywords() - Method in class io.branch.indexing.BranchUniversalObject

Get the keywords associated with this BranchUniversalObject

getKeywordsJsonArray() - Method in class io.branch.indexing.BranchUniversalObject

Get the keywords associated with this BranchUniversalObject

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_IDENTIFIER 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.

getManifestVersion() - Method in class io.branch.indexing.ContentDiscoveryManifest

getMatchDuration() - Method in class io.branch.referral.util.LinkProperties

Get the amount of time that Branch allows a click to remain outstanding.

getMaxPacketSize() - Method in class io.branch.indexing.ContentDiscoveryManifest

getMaxTextLen() - Method in class io.branch.indexing.ContentDiscoveryManifest

getMaxViewHistorySize() - Method in class io.branch.indexing.ContentDiscoveryManifest

getMessage() - Method in class io.branch.referral.BranchError

Returns the message explaining the error.

getMessageBody() - Method in class io.branch.referral.util.ShareSheetStyle

getMessageTitle() - Method in class io.branch.referral.util.ShareSheetStyle

getMetadata() - Method in class io.branch.indexing.BranchUniversalObject

Get the meta data provided for the content referred bt this object

getMoreOptionIcon() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getMoreOptionIcon() - Method in class io.branch.referral.util.ShareSheetStyle

getMoreOptionText() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getMoreOptionText() - Method in class io.branch.referral.util.ShareSheetStyle

getObject() - Method in class io.branch.referral.ServerResponse

Checks whether the post data associated with the current request is an instance of a JSONObject object, and if so type-casts it to the corresponding class type.

getPath() - Method in enum io.branch.referral.Defines.RequestPath

getPost() - Method in class io.branch.referral.ServerRequest

Gets a JSONObject containing the post data supplied with the current request as key-value pairs.

getPostWithInstrumentationValues(ConcurrentHashMap<String, String>) - Method in class io.branch.referral.ServerRequest

Gets a JSONObject containing the post data supplied with the current request as key-value pairs appended with the instrumentation data.

getPreferredOptions() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getPreferredOptions() - Method in class io.branch.referral.util.ShareSheetStyle

getPrice() - Method in class io.branch.indexing.BranchUniversalObject

Gets the price associated with this BUO content

getPushIdentifier() - Method in class io.branch.referral.PrefHelper

Get the branch url in push payload which started the application.

getQueueWaitTime() - Method in class io.branch.referral.ServerRequest

Returns the amount of time this request was in queque

getReferralUrl() - Method in class io.branch.referral.BranchReferralUrlBuilder

Configures and requests a referral URL to be generated by the Branch servers, via a synchronous call.

getReferredBranchUniversalObject() - Static method in class io.branch.indexing.BranchUniversalObject

Get the BranchUniversalObject associated with the latest deep linking.

getReferredLinkProperties() - Static method in class io.branch.referral.util.LinkProperties

Create a LinkProperties object based on the latest link click.

getRequestMetadata() - Method in class io.branch.referral.PrefHelper

getRequestPath() - Method in class io.branch.referral.ServerRequest

Provides the path to server for this request.

getRequestUrl() - Method in class io.branch.referral.ServerRequest

Provides the complete url for executing this request.

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 PrefHelper.KEY_SESSION_ID String value from preferences.

getSessionParams() - Method in class io.branch.referral.PrefHelper

Gets the session parameters as currently set in preferences.

getShareMsg() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getShareSub() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getSharingMessageForChannel(String) - Method in interface io.branch.referral.Branch.IChannelProperties

getSharingTitle() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getSharingTitle() - Method in class io.branch.referral.util.ShareSheetStyle

getSharingTitleForChannel(String) - Method in interface io.branch.referral.Branch.IChannelProperties

getSharingTitleView() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getSharingTitleView() - Method in class io.branch.referral.util.ShareSheetStyle

getShortLinkBuilder() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getShortUrl(Context, LinkProperties) - Method in class io.branch.indexing.BranchUniversalObject

getShortUrl() - Method in class io.branch.referral.BranchShortLinkBuilder

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.

getStage() - Method in class io.branch.referral.util.LinkProperties

Get a name that identify the stage in an application or user flow process.

getStatusCode() - Method in class io.branch.referral.ServerResponse

Gets the HttpStatus code of the current response.

getString(String) - Method in class io.branch.referral.PrefHelper

A basic method that returns a String value from a specified preferences Key.

getStyleResourceID() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getStyleResourceID() - Method in class io.branch.referral.util.ShareSheetStyle

getSystemObserver() - Method in class io.branch.referral.BranchRemoteInterface

getTag() - Method in class io.branch.referral.ServerResponse

Gets the String value of the Tag attribute of the current link.

getTags() - Method in class io.branch.referral.util.LinkProperties

Get the list of tags associated with this LinkProperties

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.

getTitle() - Method in class io.branch.indexing.BranchUniversalObject

Get a title for the content referred by this object

getType() - Method in class io.branch.indexing.BranchUniversalObject

Get a title for the content referred by this object

getUrlCopiedMessage() - Method in class io.branch.referral.Branch.ShareLinkBuilder

getUrlCopiedMessage() - Method in class io.branch.referral.util.ShareSheetStyle

getUserURL() - Method in class io.branch.referral.PrefHelper

Sets the user URL from preferences.

H

handleErrors(Context) - Method in class io.branch.referral.ServerRequest

Should be implemented by the child class.Specifies any error associated with request.

handleFailure(int, String) - Method in class io.branch.referral.ServerRequest

Called when there is an error on executing this request.

handleNewRequest(ServerRequest) - Method in class io.branch.referral.Branch

Handles execution of a new request other than open or install.

HASH_MODE_KEY - Static variable in class io.branch.indexing.ContentDiscoveryManifest

I

initSession(Branch.BranchUniversalReferralInitListener) - Method in class io.branch.referral.Branch

Initialises a session with the Branch API, assigning a Branch.BranchUniversalReferralInitListener to perform an action upon successful initialisation.

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.BranchUniversalReferralInitListener, Activity) - Method in class io.branch.referral.Branch

Initialises a session with the Branch API, passing the Activity and assigning a Branch.BranchUniversalReferralInitListener 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.BranchUniversalReferralInitListener, Uri) - Method in class io.branch.referral.Branch

Initialises a session with the Branch API.

initSession(Branch.BranchReferralInitListener, Uri) - Method in class io.branch.referral.Branch

Initialises a session with the Branch API.

initSession(Branch.BranchUniversalReferralInitListener, Uri, Activity) - 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.BranchUniversalReferralInitListener, boolean, Uri) - Method in class io.branch.referral.Branch

Initialises a session with the Branch API.

initSession(Branch.BranchReferralInitListener, boolean, Uri) - Method in class io.branch.referral.Branch

Initialises a session with the Branch API.

initSession(Branch.BranchUniversalReferralInitListener, boolean, Uri, Activity) - 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.BranchUniversalReferralInitListener, boolean) - 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.BranchUniversalReferralInitListener, boolean, Activity) - 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.

InstallListener - Class in io.branch.referral

Class for listening installation referrer params.

InstallListener() - Constructor for class io.branch.referral.InstallListener

io.branch.indexing - package io.branch.indexing

io.branch.referral - package io.branch.referral

io.branch.referral.util - package io.branch.referral.util

isAutoDeepLinkLaunch(Activity) - Static method in class io.branch.referral.Branch

Checks if an activity is launched by Branch auto deep link feature.

isCDEnabled() - Method in class io.branch.indexing.ContentDiscoveryManifest

isDebug() - Method in class io.branch.referral.PrefHelper

Gets the Boolean value of PrefHelper.BNC_Dev_Debug, which indicates whether or not debugging is enabled.

isDeviceIDFetchDisabled() - Static method in class io.branch.referral.Branch

Returns true if reading device id is disabled

isGAdsParamsRequired() - Method in class io.branch.referral.ServerRequest

Specifies whether this request need to be updated with Google Ads Id and LAT value By default update GAds params update is turned off.

isGetRequest() - Method in class io.branch.referral.ServerRequest

Specify whether the request is a GET or POST.

isInstallOrOpenBranchViewPending(Context) - Method in class io.branch.referral.BranchViewHandler

isPublicallyIndexable() - Method in class io.branch.indexing.BranchUniversalObject

Specifies whether the contents referred by this object is publically indexable

isUserIdentified() - Method in class io.branch.referral.Branch

Indicates whether or not this user has a custom identity specified for them.

isWaitingOnProcessToFinish() - Method in class io.branch.referral.ServerRequest

Check if this request is waiting on any operation to finish before processing

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.

LinkProperties - Class in io.branch.referral.util

Class for representing any additional information that is specific to the link.

LinkProperties() - Constructor for class io.branch.referral.util.LinkProperties

Create an instance of LinkProperties

listOnGoogleSearch(Context) - Method in class io.branch.indexing.BranchUniversalObject

Publish this BUO with Google app indexing so that the contents will be available with google search with branch link pointing to the app.

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.

logout(Branch.LogoutStatusListener) - 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.

M

MANIFEST_VERSION_KEY - Static variable in class io.branch.indexing.ContentDiscoveryManifest

markInstallOrOpenBranchViewPending(JSONObject, String) - Method in class io.branch.referral.BranchViewHandler

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.

onActivityStopped(Activity) - Method in class io.branch.indexing.ContentDiscoverer

onBranchInitialised(JSONObject) - Method in class io.branch.indexing.ContentDiscoveryManifest

onBranchViewAccepted(String, String) - Method in class io.branch.referral.Branch

onBranchViewAccepted(String, String) - Method in interface io.branch.referral.BranchViewHandler.IBranchViewEvents

Called when user click the positive button on Branch view

onBranchViewCancelled(String, String) - Method in class io.branch.referral.Branch

onBranchViewCancelled(String, String) - Method in interface io.branch.referral.BranchViewHandler.IBranchViewEvents

Called when user click the negative button app Branch view

onBranchViewError(int, String, String) - Method in class io.branch.referral.Branch

onBranchViewError(int, String, String) - Method in interface io.branch.referral.BranchViewHandler.IBranchViewEvents

Called when there is an error on creating or showing Branch view

onBranchViewVisible(String, String) - Method in class io.branch.referral.Branch

onBranchViewVisible(String, String) - Method in interface io.branch.referral.BranchViewHandler.IBranchViewEvents

Called when a Branch view shown

onChannelSelected(String) - Method in interface io.branch.referral.Branch.BranchLinkShareListener

Called when user select a channel for sharing a deep link.

onCreate(Bundle) - Method in class io.branch.referral.AnimatedDialog

onCreate() - Method in class io.branch.referral.BranchApp

onCurrentActivityDestroyed(Activity) - Method in class io.branch.referral.BranchViewHandler

onGAdsFetchFinished() - Method in class io.branch.referral.Branch

onInitFinished(JSONObject, BranchError) - Method in interface io.branch.referral.Branch.BranchReferralInitListener

onInitFinished(BranchUniversalObject, LinkProperties, BranchError) - Method in interface io.branch.referral.Branch.BranchUniversalReferralInitListener

onLinkCreate(String, BranchError) - Method in interface io.branch.referral.Branch.BranchLinkCreateListener

onLinkShareResponse(String, String, BranchError) - Method in interface io.branch.referral.Branch.BranchLinkShareListener

Callback method to update the sharing status.

onLogoutFinished(boolean, BranchError) - Method in interface io.branch.referral.Branch.LogoutStatusListener

Called on finishing the the logout process

onPreExecute() - Method in class io.branch.referral.ServerRequest

Called on UI thread just before executing a request.

onReceive(Context, Intent) - Method in class io.branch.referral.InstallListener

onReceivingResponse(JSONArray, BranchError) - Method in interface io.branch.referral.Branch.BranchListResponseListener

onRegisterViewFinished(boolean, BranchError) - Method in interface io.branch.indexing.BranchUniversalObject.RegisterViewStatusListener

Called on finishing the the register view process

onRequestQueued() - Method in class io.branch.referral.ServerRequest

Called when request is added to teh queue

onRequestSucceeded(ServerResponse, Branch) - Method in class io.branch.referral.ServerRequest

Called when execution of this request to server succeeds.

onSessionStarted(Activity, String) - Method in class io.branch.indexing.ContentDiscoverer

onShareLinkDialogDismissed() - Method in interface io.branch.referral.Branch.BranchLinkShareListener

Callback method to update when sharing dialog is dismissed.

onShareLinkDialogLaunched() - Method in interface io.branch.referral.Branch.BranchLinkShareListener

Callback method to update when share link dialog is launched.

onStateChanged(boolean, BranchError) - Method in interface io.branch.referral.Branch.BranchReferralStateChangedListener

P

PACKAGE_NAME_KEY - Static variable in class io.branch.indexing.ContentDiscoveryManifest

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

prefHelper_ - Variable in class io.branch.referral.ServerRequest

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.

registerView() - Method in class io.branch.indexing.BranchUniversalObject

Mark the content referred by this object as viewed.

registerView(BranchUniversalObject.RegisterViewStatusListener) - Method in class io.branch.indexing.BranchUniversalObject

Mark the content referred by this object as viewed.

registerView(BranchUniversalObject, BranchUniversalObject.RegisterViewStatusListener) - Method in class io.branch.referral.Branch

removeProcessWaitLock(ServerRequest.PROCESS_WAIT_LOCK) - Method in class io.branch.referral.ServerRequest

Unlock the specified lock from the request.

requestPath_ - Variable in class io.branch.referral.ServerRequest

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

saveBranchAnalyticsData(JSONObject) - Method in class io.branch.referral.PrefHelper

ServerRequest - Class in io.branch.referral

Abstract class defining the structure of a Branch Server request.

ServerRequest(Context, String) - Constructor for class io.branch.referral.ServerRequest

Creates an instance of ServerRequest.

ServerRequest(String, JSONObject, Context) - Constructor for class io.branch.referral.ServerRequest

Creates an instance of ServerRequest.

ServerResponse - Class in io.branch.referral

Class providing the structure of a HTTP response as recieved from the Branch API.

ServerResponse(String, int) - Constructor for class io.branch.referral.ServerResponse

Main constructor method for the ServerResponse class that allows for the instantiation of a server response object as a direct result of a server call.

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.

setAlias(String) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Sets the alias for this link.

setAlias(String) - Method in class io.branch.referral.BranchShortLinkBuilder

Sets the alias for this link.

setAlias(String) - Method in class io.branch.referral.util.LinkProperties

Sets the alias for this link.

setAppLink(String) - Method in class io.branch.referral.PrefHelper

Set the KEY_APP_LINK String values that has been started the application.

setAppVersion(String) - Method in class io.branch.referral.PrefHelper

Sets the value of PrefHelper.KEY_APP_VERSION in preferences.

setAsFullWidthStyle(boolean) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Sets the share dialog to full width mode.

setAsFullWidthStyle(boolean) - Method in class io.branch.referral.util.ShareSheetStyle

Sets the share dialog to full width mode.

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

Set the given Branch Key to preference.

setCallback(Branch.BranchLinkShareListener) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Adds a callback to get the sharing status.

setCampaign(String) - Method in class io.branch.referral.BranchShortLinkBuilder

Sets the campaign that the link belongs to.

setCampaign(String) - Method in class io.branch.referral.util.LinkProperties

Sets the campaign for this link.

setCanonicalIdentifier(String) - Method in class io.branch.indexing.BranchUniversalObject

Set the canonical identifier for this BranchUniversalObject.

setCanonicalUrl(String) - Method in class io.branch.indexing.BranchUniversalObject

Canonical url for the content referred.

setChannel(String) - Method in class io.branch.referral.BranchShortLinkBuilder

Sets the channel for this link.

setChannel(String) - Method in class io.branch.referral.util.LinkProperties

Sets the channel for this link.

setChannelProperties(Branch.IChannelProperties) - Method in class io.branch.referral.Branch.ShareLinkBuilder

setContentDescription(String) - Method in class io.branch.indexing.BranchUniversalObject

Set description for the content for the content referred by this object

setContentExpiration(Date) - Method in class io.branch.indexing.BranchUniversalObject

Set the content expiration time.

setContentImageUrl(String) - Method in class io.branch.indexing.BranchUniversalObject

Set the url to any image associated with this content.

setContentIndexingMode(BranchUniversalObject.CONTENT_INDEX_MODE) - Method in class io.branch.indexing.BranchUniversalObject

Set the indexing mode for the content referred in this object

setContentType(String) - Method in class io.branch.indexing.BranchUniversalObject

Sets the content type for this Object

setContentView(int) - Method in class io.branch.referral.AnimatedDialog

setCopyUrlStyle(Drawable, String, String) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Set the icon, label and success message for copy url option.

setCopyUrlStyle(int, int, int) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Set the icon, label and success message for copy url option.

setCopyUrlStyle(Drawable, String, String) - Method in class io.branch.referral.util.ShareSheetStyle

Set the icon, label and success message for copy url option.

setCopyUrlStyle(int, int, int) - Method in class io.branch.referral.util.ShareSheetStyle

Set the icon, label and success message for copy url option.

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

Enables the test mode for the SDK.

setDeepLinkDebugMode(JSONObject) - Method in class io.branch.referral.Branch

Sets the key-value pairs for debugging the deep link.

setDefaultURL(String) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Set a default url to share in case there is any error creating the deep link

setDefaultURL(String) - Method in class io.branch.referral.util.ShareSheetStyle

Set a default url to share in case there is any error creating the deep link

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.

setDialogWindowAttributes() - Method in class io.branch.referral.AnimatedDialog

Set the window attributes for the invite dialog.

setDividerHeight(int) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Set the height for the divider for the sharing channels in the list.

setDividerHeight(int) - Method in class io.branch.referral.util.ShareSheetStyle

Set the height for the divider for the sharing channels in the list.

setDuration(int) - Method in class io.branch.referral.BranchShortLinkBuilder

Sets the amount of time that Branch allows a click to remain outstanding.

setDuration(int) - Method in class io.branch.referral.util.LinkProperties

Sets the amount of time that Branch allows a click to remain outstanding.

setExternalIntentExtra(String) - Method in class io.branch.referral.PrefHelper

Sets the PrefHelper.KEY_EXTERNAL_INTENT_EXTRA with value with given intent extras in string format.

setExternalIntentUri(String) - Method in class io.branch.referral.PrefHelper

Sets the PrefHelper.KEY_EXTERNAL_INTENT_URI with value with given intent URI String.

setExternDebug() - Method in class io.branch.referral.PrefHelper

Switches external debugging on.

setFeature(String) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Adds a feature that make use of the link.

setFeature(String) - Method in class io.branch.referral.BranchShortLinkBuilder

Set a name that identifies the feature that the link makes use of.

setFeature(String) - Method in class io.branch.referral.util.LinkProperties

Set a name that identifies the feature that the link makes use of.

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 PrefHelper.KEY_IDENTITY String value that has been set via the Branch API.

setIdentityID(String) - Method in class io.branch.referral.PrefHelper

Sets the PrefHelper.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.

setIsAppLinkTriggeredInit(Boolean) - Method in class io.branch.referral.PrefHelper

Set the value to specify if the current init is triggered by an FB app link

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.

setMatchDuration(int) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Sets the amount of time that Branch allows a click to remain outstanding.

setMessage(String) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Sets the message to be shared with the link.

setMoreOptionStyle(Drawable, String) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Set the icon and label for the option to expand the application list to see more options.

setMoreOptionStyle(int, int) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Set the icon and label for the option to expand the application list to see more options.

setMoreOptionStyle(Drawable, String) - Method in class io.branch.referral.util.ShareSheetStyle

Set the icon and label for the option to expand the application list to see more options.

setMoreOptionStyle(int, int) - Method in class io.branch.referral.util.ShareSheetStyle

Set the icon and label for the option to expand the application list to see more options.

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.

setParameters(JSONObject) - Method in class io.branch.referral.BranchShortLinkBuilder

Set the parameters associated with the link.

setPost(JSONObject) - Method in class io.branch.referral.ServerRequest

Sets a JSONObject containing the post data supplied with the current request.

setPost(Object) - Method in class io.branch.referral.ServerResponse

Sets the post data attached to the current server request, as a generic Object instance.

setPrice(double, CURRENCY_TYPE) - Method in class io.branch.indexing.BranchUniversalObject

Set the price associated with content of this BUO if any

setPushIdentifier(String) - Method in class io.branch.referral.PrefHelper

Set the KEY_PUSH_IDENTIFIER String values that has been started the application.

setRequestMetadata(String, String) - Method in class io.branch.referral.Branch

Add key value pairs to all requests

setRequestMetadata(String, String) - Method in class io.branch.referral.PrefHelper

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 PrefHelper.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.

setSharingTitle(String) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Set the title for the sharing dialog

setSharingTitle(View) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Set the title for the sharing dialog

setSharingTitle(String) - Method in class io.branch.referral.util.ShareSheetStyle

Set the title for the sharing dialog

setSharingTitle(View) - Method in class io.branch.referral.util.ShareSheetStyle

Set the title for the sharing dialog

setShortLinkBuilderInternal(BranchShortLinkBuilder) - Method in class io.branch.referral.Branch.ShareLinkBuilder

setStage(String) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Adds a stage application or user flow associated with this link.

setStage(String) - Method in class io.branch.referral.BranchShortLinkBuilder

Set a name that identify the stage in an application or user flow process.

setStage(String) - Method in class io.branch.referral.util.LinkProperties

Set a name that identify the stage in an application or user flow process.

setString(String, String) - Method in class io.branch.referral.PrefHelper

Sets the value of the String key value supplied in preferences.

setStyleResourceID(int) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Set the given style to the List View showing the share sheet

setStyleResourceID(int) - Method in class io.branch.referral.util.ShareSheetStyle

Set the given style to the List View showing the share sheet

setSubject(String) - Method in class io.branch.referral.Branch.ShareLinkBuilder

Sets the subject of this message.

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.

setTitle(String) - Method in class io.branch.indexing.BranchUniversalObject

Set a title for the content referred by this object

setType(int) - Method in class io.branch.referral.BranchShortLinkBuilder

Sets an int that can be used for scenarios where you want the link to only deep link the first time or unlimited times

setUserURL(String) - Method in class io.branch.referral.PrefHelper

Sets the user URL from preferences.

setWhiteListedSchemes(List<String>) - Method in class io.branch.referral.Branch

Set the given list of URI Scheme as the external Uri white list.

shareLink() - Method in class io.branch.referral.Branch.ShareLinkBuilder

Creates an application selector dialog and share a link with user selected sharing option.

ShareSheetStyle - Class in io.branch.referral.util

Class for defining the share sheet properties.

ShareSheetStyle(Context, String, String) - Constructor for class io.branch.referral.util.ShareSheetStyle

SharingHelper - Class in io.branch.referral

Define the Applications for the sharing the link with.

SharingHelper() - Constructor for class io.branch.referral.SharingHelper

SharingHelper.SHARE_WITH - Enum in io.branch.referral

Defines the Application for sharing a deep link with.

shouldRetryOnFail() - Method in class io.branch.referral.ServerRequest

Specifies whether to retry this request on failure.

show() - Method in class io.branch.referral.AnimatedDialog

Opens the dialog with an animation to the content View.

showBranchView(JSONObject, String, Context, BranchViewHandler.IBranchViewEvents) - Method in class io.branch.referral.BranchViewHandler

showPendingBranchView(Context) - Method in class io.branch.referral.BranchViewHandler

showShareSheet(Activity, LinkProperties, ShareSheetStyle, Branch.BranchLinkShareListener) - Method in class io.branch.indexing.BranchUniversalObject

showShareSheet(Activity, LinkProperties, ShareSheetStyle, Branch.BranchLinkShareListener, Branch.IChannelProperties) - Method in class io.branch.indexing.BranchUniversalObject

skipBranchViewsOnThisActivity() - Method in interface io.branch.referral.Branch.IBranchViewControl

Defines if an activity is interested to show Branch views or not.

T

toJSON() - Method in class io.branch.referral.ServerRequest

Gets a JSONObject corresponding to the ServerRequest and ServerRequest.POST_KEY as currently configured.

toString() - Method in class io.branch.referral.BranchError

Overridden toString method for this object; returns the error message rather than the object's address.

toString() - Method in enum io.branch.referral.Defines.Jsonkey

toString() - Method in enum io.branch.referral.Defines.LinkParam

toString() - Method in enum io.branch.referral.Defines.RequestPath

toString() - Method in enum io.branch.referral.SharingHelper.SHARE_WITH

toString() - Method in enum io.branch.referral.util.CURRENCY_TYPE

U

updateBranchViewUsageCount(String) - Method in class io.branch.referral.PrefHelper

updateGAdsParams(SystemObserver) - Method in class io.branch.referral.ServerRequest

Updates the google ads parameters.

userCompletedAction(BranchUniversalObject.BUO_USER_ACTIONS) - Method in class io.branch.indexing.BranchUniversalObject

Method to report user actions happened on this BUO.

userCompletedAction(BranchUniversalObject.BUO_USER_ACTIONS, HashMap<String, String>) - Method in class io.branch.indexing.BranchUniversalObject

Method to report user actions happened on this BUO.

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.

userCompletedAction(String, BranchViewHandler.IBranchViewEvents) - 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.

userCompletedAction(String, JSONObject, BranchViewHandler.IBranchViewEvents) - 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.

V

valueOf(String) - Static method in enum io.branch.indexing.BranchUniversalObject.BUO_USER_ACTIONS

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.branch.indexing.BranchUniversalObject.CONTENT_INDEX_MODE

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.branch.referral.Branch.CreditHistoryOrder

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.branch.referral.Defines.Jsonkey

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.branch.referral.Defines.LinkParam

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.branch.referral.Defines.RequestPath

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.branch.referral.SharingHelper.SHARE_WITH

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.branch.referral.util.CURRENCY_TYPE

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.branch.indexing.BranchUniversalObject.BUO_USER_ACTIONS

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.branch.indexing.BranchUniversalObject.CONTENT_INDEX_MODE

Returns an array containing the constants of this enum type, in the order they are declared.

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.

values() - Static method in enum io.branch.referral.Defines.Jsonkey

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.branch.referral.Defines.LinkParam

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.branch.referral.Defines.RequestPath

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.branch.referral.SharingHelper.SHARE_WITH

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.branch.referral.util.CURRENCY_TYPE

Returns an array containing the constants of this enum type, in the order they are declared.

W

writeToParcel(Parcel, int) - Method in class io.branch.indexing.BranchUniversalObject

writeToParcel(Parcel, int) - Method in class io.branch.referral.util.LinkProperties

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