-
- All Implemented Interfaces:
-
android.os.Parcelable
public class LinkProperties implements 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.
-
-
Field Summary
Fields Modifier and Type Field Description public final static Parcelable.Creator
CREATOR
-
Constructor Summary
Constructors Constructor Description LinkProperties()
Create an instance of LinkProperties
-
Method Summary
Modifier and Type Method Description LinkProperties
setAlias(String alias)
Sets the alias for this link. LinkProperties
addTag(String tag)
Adds a tag to the iterable collection of name associated with a deep link. LinkProperties
addControlParameter(String key, String value)
Adds any control params that control the behaviour of the link. LinkProperties
setFeature(String feature)
Set a name that identifies the feature that the link makes use of. LinkProperties
setDuration(int duration)
Sets the amount of time that Branch allows a click to remain outstanding. LinkProperties
setStage(String stage)
Set a name that identify the stage in an application or user flow process. LinkProperties
setChannel(String channel)
Sets the channel for this link. LinkProperties
setCampaign(String campaign)
Sets the campaign for this link. ArrayList<String>
getTags()
Get the list of tags associated with this LinkProperties HashMap<String, String>
getControlParams()
Get all control params associated with this LinkProperties int
getMatchDuration()
Get the amount of time that Branch allows a click to remain outstanding. String
getAlias()
Get the alias for this link. String
getFeature()
Get a name that identifies the feature that the link makes use of. String
getStage()
Get a name that identify the stage in an application or user flow process. String
getChannel()
Gets the channel for this link. String
getCampaign()
Gets the campaign for this link. int
describeContents()
static LinkProperties
getReferredLinkProperties()
Create a LinkProperties object based on the latest link click. void
writeToParcel(Parcel dest, int flags)
-
-
Constructor Detail
-
LinkProperties
LinkProperties()
Create an instance of LinkProperties
-
-
Method Detail
-
setAlias
LinkProperties setAlias(String alias)
Sets the alias for this link.
- Parameters:
alias
- Link 'alias' can be used to label the endpoint on the link.
-
addTag
LinkProperties addTag(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.
-
addControlParameter
LinkProperties addControlParameter(String key, 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
-
setFeature
LinkProperties setFeature(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.
-
setDuration
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 toremain outstanding and be eligible to be matched with a new app session.
-
setStage
LinkProperties setStage(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 flowprocess.
-
setChannel
LinkProperties setChannel(String channel)
Sets the channel for this link.
- Parameters:
channel
- A String denoting the channel that the link belongs to.
-
setCampaign
LinkProperties setCampaign(String campaign)
Sets the campaign for this link.
- Parameters:
campaign
- A String denoting the campaign that the link belongs to.
-
getTags
ArrayList<String> getTags()
Get the list of tags associated with this LinkProperties
-
getControlParams
HashMap<String, String> getControlParams()
Get all control params associated with this LinkProperties
-
getMatchDuration
int getMatchDuration()
Get the amount of time that Branch allows a click to remain outstanding.
-
getFeature
String getFeature()
Get a name that identifies the feature that the link makes use of.
-
getStage
String getStage()
Get a name that identify the stage in an application or user flow process.
-
getChannel
String getChannel()
Gets the channel for this link.
-
getCampaign
String getCampaign()
Gets the campaign for this link.
-
describeContents
int describeContents()
-
getReferredLinkProperties
static LinkProperties getReferredLinkProperties()
Create a LinkProperties object based on the latest link click.
-
writeToParcel
void writeToParcel(Parcel dest, int flags)
-
-
-
-