io.branch.referral.util

Class LinkProperties

java.lang.Object

io.branch.referral.util.LinkProperties

All Implemented Interfaces:

android.os.Parcelable

public class LinkProperties
extends java.lang.Object
implements android.os.Parcelable

Class for representing any additional information that is specific to the link. Use this class to specify the properties of a deep link such as channel, feature etc and any control params associated with the link.

See Also:

BranchUniversalObject.getShortUrl(Context, LinkProperties), BranchUniversalObject.generateShortUrl(Context, LinkProperties, Branch.BranchLinkCreateListener),

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
LinkProperties() Create an instance of LinkProperties

Method Summary

Modifier and Type	Method and Description
LinkProperties	addControlParameter(java.lang.String key, java.lang.String value) Adds any control params that control the behaviour of the link.
LinkProperties	addTag(java.lang.String tag) Adds a tag to the iterable collection of name associated with a deep link.
int	describeContents()
java.lang.String	getAlias() Get the alias for this link.
java.lang.String	getCampaign() Gets the campaign for this link.
java.lang.String	getChannel() Gets the channel for this link.
java.util.HashMap<java.lang.String,java.lang.String>	getControlParams() Get all control params associated with this LinkProperties
java.lang.String	getFeature() Get a name that identifies the feature that the link makes use of.
int	getMatchDuration() Get the amount of time that Branch allows a click to remain outstanding.
static LinkProperties	getReferredLinkProperties() Create a LinkProperties object based on the latest link click.
java.lang.String	getStage() Get a name that identify the stage in an application or user flow process.
java.util.ArrayList<java.lang.String>	getTags() Get the list of tags associated with this LinkProperties
LinkProperties	setAlias(java.lang.String alias) Sets the alias for this link.
LinkProperties	setCampaign(java.lang.String campaign) Sets the campaign for this link.
LinkProperties	setChannel(java.lang.String channel) Sets the channel for this link.
LinkProperties	setDuration(int duration) Sets the amount of time that Branch allows a click to remain outstanding.
LinkProperties	setFeature(java.lang.String feature) Set a name that identifies the feature that the link makes use of.
LinkProperties	setStage(java.lang.String stage) Set a name that identify the stage in an application or user flow process.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator CREATOR

Constructor Detail

LinkProperties

public LinkProperties()

Create an instance of LinkProperties

Method Detail

setAlias

public LinkProperties setAlias(java.lang.String alias)

Sets the alias for this link.

Parameters:

alias - Link 'alias' can be used to label the endpoint on the link.

For example: http://bnc.lt/AUSTIN28. Should not exceed 128 characters

Returns:

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

addTag

public LinkProperties 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.

addControlParameter

public LinkProperties addControlParameter(java.lang.String key,
                                          java.lang.String value)

Adds any control params that control the behaviour of the link. Control parameters include Custom redirect url ($android_url,$ios_url), path for auto deep linking($android_deeplink_path,$deeplink_path) etc

Parameters:

key - A String with value of key for the parameter

value - A String with value of value for the parameter

Returns:

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

setFeature

public LinkProperties setFeature(java.lang.String feature)

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

Parameters:

feature - A String value identifying the feature that the link makes use of. Should not exceed 128 characters.

Returns:

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

setDuration

public LinkProperties setDuration(int duration)

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

Parameters:

duration - A Integer value specifying the time that Branch allows a click to remain outstanding and be eligible to be matched with a new app session.

Returns:

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

setStage

public LinkProperties setStage(java.lang.String stage)

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

Parameters:

stage - A String value identifying the stage in an application or user flow process. Should not exceed 128 characters.

Returns:

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

setChannel

public LinkProperties setChannel(java.lang.String channel)

Sets the channel for this link.

Parameters:

channel - A String denoting the channel that the link belongs to. Should not exceed 128 characters.

Returns:

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

setCampaign

public LinkProperties setCampaign(java.lang.String campaign)

Sets the campaign for this link.

Parameters:

campaign - A String denoting the campaign that the link belongs to. Should not exceed 128 characters.

Returns:

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

getTags

public java.util.ArrayList<java.lang.String> getTags()

Get the list of tags associated with this LinkProperties

Returns:

ArrayList with the tags associated with this LinkProperties

getControlParams

public java.util.HashMap<java.lang.String,java.lang.String> getControlParams()

Get all control params associated with this LinkProperties

Returns:

A HashMap with key value pairs for the control params associated with this LinkProperties

getMatchDuration

public int getMatchDuration()

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

Returns:

A Integer value specifying the time that Branch allows a click to remain outstanding and be eligible to be matched with a new app session.

getAlias

public java.lang.String getAlias()

Get the alias for this link.

Returns:

A String with value alias 'alias' used to label the endpoint on the link.

getFeature

public java.lang.String getFeature()

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

Returns:

A String value identifying the feature that the link makes use of.

getStage

public java.lang.String getStage()

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

Returns:

A String value identifying the stage in an application or user flow process

getChannel

public java.lang.String getChannel()

Gets the channel for this link.

Returns:

A String denoting the channel that the link belongs to

getCampaign

public java.lang.String getCampaign()

Gets the campaign for this link.

Returns:

A String denoting the campaign that the link belongs to

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

getReferredLinkProperties

public static LinkProperties getReferredLinkProperties()

Create a LinkProperties object based on the latest link click.

Returns:

A LinkProperties object based on the latest link click or a null if there is no link click registered for this session

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable