io.branch.referral

Class BranchReferralUrlBuilder

java.lang.Object

io.branch.referral.BranchReferralUrlBuilder

public class BranchReferralUrlBuilder
extends java.lang.Object

Class for creating builder for getting a referral url with Branch. This builder provide an easy and flexible way to configure and create a referral url synchronously or asynchronously.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	alias_
protected Branch	branchReferral_
protected java.lang.String	campaign_
protected java.lang.String	channel_
protected int	duration_
protected java.lang.String	feature_
protected org.json.JSONObject	params_
protected java.lang.String	stage_
protected java.util.ArrayList<java.lang.String>	tags_
protected int	type_

Constructor Summary

Constructors

Constructor and Description
BranchReferralUrlBuilder(android.content.Context context, java.lang.String channel)

Method Summary

Modifier and Type	Method and Description
T	addParameters(java.lang.String key, java.lang.Object value) Adds the the given key value pair to the parameters associated with this link.
T	addTag(java.lang.String tag) Adds a tag to the iterable collection of name associated with a deep link.
T	addTags(java.util.List<java.lang.String> tags) Adds a tag to the iterable collection of name associated with a deep link.
void	generateReferralUrl(Branch.BranchLinkCreateListener callback) 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.
protected void	generateUrl(Branch.BranchLinkCreateListener callback)
protected void	generateUrlInternal(Branch.BranchLinkCreateListener callback, boolean isFromShareSheet)
java.lang.String	getReferralUrl() Configures and requests a referral URL to be generated by the Branch servers, via a synchronous call.
protected java.lang.String	getUrl()
T	setDefaultToLongUrl(boolean defaultToLongUrl)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

params_

protected org.json.JSONObject params_

channel_

protected java.lang.String channel_

feature_

protected java.lang.String feature_

stage_

protected java.lang.String stage_

campaign_

protected java.lang.String campaign_

alias_

protected java.lang.String alias_

type_

protected int type_

duration_

protected int duration_

tags_

protected java.util.ArrayList<java.lang.String> tags_

branchReferral_

protected Branch branchReferral_

Constructor Detail

BranchReferralUrlBuilder

public BranchReferralUrlBuilder(android.content.Context context,
                                java.lang.String channel)

Method Detail

getReferralUrl

public java.lang.String getReferralUrl()

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

Returns:

A String containing the resulting referral URL. Null is returned in case of an error or if Branch is not initialised.

generateReferralUrl

public void generateReferralUrl(Branch.BranchLinkCreateListener callback)

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.

Parameters:

callback - A Branch.BranchLinkCreateListener callback instance that will trigger when link is generated.

addTag

public T addTag(java.lang.String tag)

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

Parameters:

tag - String tags associated with a deep link.

Returns:

This Builder object to allow for chaining of calls to set methods.

addTags

public T addTags(java.util.List<java.lang.String> tags)

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

Parameters:

tags - List with collection of tags associated with a deep link.

Returns:

This Builder object to allow for chaining of calls to set methods.

addParameters

public T addParameters(java.lang.String key,
                       java.lang.Object value)

Adds the the given key value pair to the parameters associated with this link.

Parameters:

key - A String with value of key for the parameter

value - A Object with value of value for the parameter

Returns:

This Builder object to allow for chaining of calls to set methods.

setDefaultToLongUrl

public T setDefaultToLongUrl(boolean defaultToLongUrl)

getUrl

protected java.lang.String getUrl()

generateUrl

protected void generateUrl(Branch.BranchLinkCreateListener callback)

generateUrlInternal

protected void generateUrlInternal(Branch.BranchLinkCreateListener callback,
                                   boolean isFromShareSheet)