io.branch.referral

Class BranchLinkData

java.lang.Object

org.json.JSONObject

io.branch.referral.BranchLinkData

public class BranchLinkData
extends org.json.JSONObject

The BranchLinkData object is based on JSONObject and expands the class to enable collections of tags.

Tags are returned from the server, and form the data dictionary that each deep link shared via the Branch platform contains.

Field Summary

Fields inherited from class org.json.JSONObject

NULL

Constructor Summary

Constructors

Constructor and Description
BranchLinkData() BranchLinkData constructor requires no parameters, and is identical to that of its superclass JSONObject.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compares a BranchLinkData object by instance ("is the object the exact same one in memory") and by associated attributes ("is this object identically configured?")
int	hashCode() Calculates the hash for this object as currently configured and returns the resultant int.
void	putAlias(java.lang.String alias) Adds an alias to the link.
void	putChannel(java.lang.String channel) [Optional] The channel in which the link will be shared.
void	putDuration(int duration) [Optional] You can set the duration manually.
void	putFeature(java.lang.String feature) [Optional] The feature in which the link will be used.
void	putParams(java.lang.String params) Any other params to be added; you can define your own.
void	putStage(java.lang.String stage) A string value that represents the stage of the user in the app.
void	putTags(java.util.Collection<java.lang.String> tags) Use this method to add tags to the data dictionary that will go along with the deep link that is being created.
void	putType(int type) Adds a type to the link.

Methods inherited from class org.json.JSONObject

accumulate, get, getBoolean, getDouble, getInt, getJSONArray, getJSONObject, getLong, getString, has, isNull, keys, length, names, numberToString, opt, optBoolean, optBoolean, optDouble, optDouble, optInt, optInt, optJSONArray, optJSONObject, optLong, optLong, optString, optString, put, put, put, put, put, putOpt, quote, remove, toJSONArray, toString, toString, wrap

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BranchLinkData

public BranchLinkData()

BranchLinkData constructor requires no parameters, and is identical to that of its superclass JSONObject.

Method Detail

putTags

public void putTags(java.util.Collection<java.lang.String> tags)
             throws org.json.JSONException

Use this method to add tags to the data dictionary that will go along with the deep link that is being created.

Parameters:

tags - A Collection of String objects, each element of which contains a tag and value to be added to the data dictionary of a link. If it is not, a JSONException will be thrown.

Throws:

org.json.JSONException

putAlias

public void putAlias(java.lang.String alias)
              throws org.json.JSONException

Adds an alias to the link.

Parameters:

alias - A String value containing the desired alias name to add.

Throws:

org.json.JSONException - The parameter value must be in valid JSON format, or a JSONException will be thrown.

putType

public void putType(int type)
             throws org.json.JSONException

Adds a type to the link.

Parameters:

type -

An Integer value of the type specified. Valid values are:

• Branch.LINK_TYPE_UNLIMITED_USE
• Branch.LINK_TYPE_ONE_TIME_USE

Throws:

org.json.JSONException - The parameter value must be in valid JSON format, or a JSONException will be thrown.

putDuration

public void putDuration(int duration)
                 throws org.json.JSONException

[Optional] You can set the duration manually. This is the time that Branch allows a click to remain outstanding and be eligible to be matched with a new app session.

Parameters:

duration -

An Integer value in seconds.

Throws:

org.json.JSONException - The parameter value must be in valid JSON format, or a JSONException will be thrown.

putChannel

public void putChannel(java.lang.String channel)
                throws org.json.JSONException

[Optional] The channel in which the link will be shared. eg: "facebook", "text_message".

Parameters:

channel - A String value containing the channel which the link belongs to. (max 128 characters)

Throws:

org.json.JSONException - The parameter value must be in valid JSON format, or a JSONException will be thrown.

putFeature

public void putFeature(java.lang.String feature)
                throws org.json.JSONException

[Optional] The feature in which the link will be used. eg: "invite", "referral", "share", "gift", etc.

Parameters:

feature - A String specifying the feature. (max 128 characters)

Throws:

org.json.JSONException - The parameter value must be in valid JSON format, or a JSONException will be thrown.

putStage

public void putStage(java.lang.String stage)
              throws org.json.JSONException

A string value that represents the stage of the user in the app. eg: "level1", "logged_in", etc.

Parameters:

stage - A String value specifying the stage.

Throws:

org.json.JSONException - The parameter value must be in valid JSON format, or a JSONException will be thrown.

putParams

public void putParams(java.lang.String params)
               throws org.json.JSONException

Any other params to be added; you can define your own.

Parameters:

params - A String containing other params in JSON format.

Throws:

org.json.JSONException - The parameter value must be in valid JSON format, or a JSONException will be thrown.

equals

public boolean equals(java.lang.Object obj)

Compares a BranchLinkData object by instance ("is the object the exact same one in memory") and by associated attributes ("is this object identically configured?")

Overrides:

equals in class java.lang.Object

Parameters:

obj - A BranchLinkData object to be compared to the one that this method belongs to.

Returns:

Returns true if identical, false if different.

hashCode

public int hashCode()

Calculates the hash for this object as currently configured and returns the resultant int.

The hash value is a combination of the hashCode of:

• alias
• channel
• feature
• stage
• params

Changing any of these attributes will change the hashCode, making comparison straightforward.

Overrides:

hashCode in class java.lang.Object