io.branch.indexing

Class BranchUniversalObject

java.lang.Object

io.branch.indexing.BranchUniversalObject

All Implemented Interfaces:

android.os.Parcelable

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

Class represents a single piece of content within your app, as well as any associated metadata. It provides convenient methods for sharing, deep linking, and tracking how often that content is viewed. This information is then used to provide you with powerful content analytics and deep linking.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BranchUniversalObject.CONTENT_INDEX_MODE Defines the Content indexing modes PUBLIC | PRIVATE
static interface	BranchUniversalObject.RegisterViewStatusListener Callback interface for listening register content view status

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
BranchUniversalObject() Create a BranchUniversalObject with the given content.

Method Summary

Methods

Modifier and Type	Method and Description
BranchUniversalObject	addContentMetadata(java.util.HashMap<java.lang.String,java.lang.String> metadata) Adds the the given set of key value pairs to the metadata associated with this content.
BranchUniversalObject	addContentMetadata(java.lang.String key, java.lang.String value) Adds the the given set of key value pair to the metadata associated with this content.
BranchUniversalObject	addKeyWord(java.lang.String keyword) Add a keyword associated with the content referred
BranchUniversalObject	addKeyWords(java.util.ArrayList<java.lang.String> keywords) Adds any keywords associated with the content referred
org.json.JSONObject	convertToJson() Convert the BUO to corresponding Json representation
static BranchUniversalObject	createInstance(org.json.JSONObject jsonObject) Creates a new BranchUniversalObject with the data provided by JSONObject.
int	describeContents()
void	generateShortUrl(android.content.Context context, LinkProperties linkProperties, Branch.BranchLinkCreateListener callback)
java.lang.String	getCanonicalIdentifier() Get the canonical identifier for this BranchUniversalObject
java.lang.String	getCanonicalUrl() Get the canonical url for this BranchUniversalObject
java.lang.String	getDescription() Get description for the content for the content referred by this object
long	getExpirationTime() Get expiry date for the content and any associated links.
java.lang.String	getImageUrl() Get the url to any image associated with this content.
java.util.ArrayList<java.lang.String>	getKeywords() Get the keywords associated with this BranchUniversalObject
org.json.JSONArray	getKeywordsJsonArray() Get the keywords associated with this BranchUniversalObject
java.util.HashMap<java.lang.String,java.lang.String>	getMetadata() Get the meta data provided for the content referred bt this object
static BranchUniversalObject	getReferredBranchUniversalObject() Get the BranchUniversalObject associated with the latest deep linking.
java.lang.String	getShortUrl(android.content.Context context, LinkProperties linkProperties)
java.lang.String	getTitle() Get a title for the content referred by this object
java.lang.String	getType() Get a title for the content referred by this object
boolean	isPublicallyIndexable() Specifies whether the contents referred by this object is publically indexable
void	registerView() Mark the content referred by this object as viewed.
void	registerView(BranchUniversalObject.RegisterViewStatusListener callback) Mark the content referred by this object as viewed.
BranchUniversalObject	setCanonicalIdentifier(java.lang.String canonicalIdentifier) Set the canonical identifier for this BranchUniversalObject.
BranchUniversalObject	setCanonicalUrl(java.lang.String canonicalUrl) Canonical url for the content referred.
BranchUniversalObject	setContentDescription(java.lang.String description) Set description for the content for the content referred by this object
BranchUniversalObject	setContentExpiration(java.util.Date expirationDate) Set the content expiration time.
BranchUniversalObject	setContentImageUrl(java.lang.String imageUrl) Set the url to any image associated with this content.
BranchUniversalObject	setContentIndexingMode(BranchUniversalObject.CONTENT_INDEX_MODE indexMode) Set the indexing mode for the content referred in this object
BranchUniversalObject	setContentType(java.lang.String type) Sets the content type for this Object
BranchUniversalObject	setTitle(java.lang.String title) Set a title for the content referred by this object
void	showShareSheet(android.app.Activity activity, LinkProperties linkProperties, ShareSheetStyle style, Branch.BranchLinkShareListener callback)
void	showShareSheet(android.app.Activity activity, LinkProperties linkProperties, ShareSheetStyle style, Branch.BranchLinkShareListener callback, Branch.IChannelProperties channelProperties)
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

BranchUniversalObject

public BranchUniversalObject()

Create a BranchUniversalObject with the given content.

Method Detail

setCanonicalIdentifier

public BranchUniversalObject setCanonicalIdentifier(java.lang.String canonicalIdentifier)

Set the canonical identifier for this BranchUniversalObject. Canonical identifier is normally the canonical path for your content in the application or web

Parameters:

canonicalIdentifier - A String with value for the canonical identifier

Returns:

This instance to allow for chaining of calls to set methods

setCanonicalUrl

public BranchUniversalObject setCanonicalUrl(java.lang.String canonicalUrl)

Canonical url for the content referred. This would be the corresponding website URL.

Parameters:

canonicalUrl - A String with value for the canonical url

Returns:

This instance to allow for chaining of calls to set methods

setTitle

public BranchUniversalObject setTitle(java.lang.String title)

Set a title for the content referred by this object

Parameters:

title - A String with value of for the content title

Returns:

This instance to allow for chaining of calls to set methods

setContentDescription

public BranchUniversalObject setContentDescription(java.lang.String description)

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

Parameters:

description - A String with value for the description of the content referred by this object

Returns:

This instance to allow for chaining of calls to set methods

setContentImageUrl

public BranchUniversalObject setContentImageUrl(java.lang.String imageUrl)

Set the url to any image associated with this content.

Parameters:

imageUrl - A String specifying a url to an image associated with content referred by this object

Returns:

This instance to allow for chaining of calls to set methods

addContentMetadata

public BranchUniversalObject addContentMetadata(java.util.HashMap<java.lang.String,java.lang.String> metadata)

Adds the the given set of key value pairs to the metadata associated with this content. These key values are passed to another user on deep linking.

Parameters:

metadata - A HashMap with String key value pairs

Returns:

This instance to allow for chaining of calls to set methods

addContentMetadata

public BranchUniversalObject addContentMetadata(java.lang.String key,
                                       java.lang.String value)

Adds the the given set of key value pair to the metadata associated with this content. These key value is passed to another user on deep linking.

Parameters:

key - A String value for metadata key

value - A String value for metadata value

Returns:

This instance to allow for chaining of calls to set methods

setContentType

public BranchUniversalObject setContentType(java.lang.String type)

Sets the content type for this Object

Parameters:

type - String with value for the mime type of the content referred

Returns:

This instance to allow for chaining of calls to set methods

setContentIndexingMode

public BranchUniversalObject setContentIndexingMode(BranchUniversalObject.CONTENT_INDEX_MODE indexMode)

Set the indexing mode for the content referred in this object

Parameters:

indexMode - BranchUniversalObject.CONTENT_INDEX_MODE value for the content referred

Returns:

This instance to allow for chaining of calls to set methods

addKeyWords

public BranchUniversalObject addKeyWords(java.util.ArrayList<java.lang.String> keywords)

Adds any keywords associated with the content referred

Parameters:

keywords - An ArrayList of String values

Returns:

This instance to allow for chaining of calls to set methods

addKeyWord

public BranchUniversalObject addKeyWord(java.lang.String keyword)

Add a keyword associated with the content referred

Parameters:

keyword - AString with value for keyword

Returns:

This instance to allow for chaining of calls to set methods

setContentExpiration

public BranchUniversalObject setContentExpiration(java.util.Date expirationDate)

Set the content expiration time.

Parameters:

expirationDate - A Date value representing the expiration date.

Returns:

This instance to allow for chaining of calls to set methods

isPublicallyIndexable

public boolean isPublicallyIndexable()

Specifies whether the contents referred by this object is publically indexable

Returns:

A Boolean whose value is set to true if index mode is public

getMetadata

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

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

Returns:

A HashMap containing metadata for the provided for this BranchUniversalObject

getExpirationTime

public long getExpirationTime()

Get expiry date for the content and any associated links. Represented as epoch milli second

Returns:

A Long with content expiration time in epoch milliseconds

getCanonicalIdentifier

public java.lang.String getCanonicalIdentifier()

Get the canonical identifier for this BranchUniversalObject

Returns:

A String with value for the canonical identifier

getCanonicalUrl

public java.lang.String getCanonicalUrl()

Get the canonical url for this BranchUniversalObject

Returns:

A String with value for the canonical url

getDescription

public java.lang.String getDescription()

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

Returns:

A String with value for the description of the content referred by this object

getImageUrl

public java.lang.String getImageUrl()

Get the url to any image associated with this content.

Returns:

A String specifying a url to an image associated with content referred by this object

getTitle

public java.lang.String getTitle()

Get a title for the content referred by this object

Returns:

A String with value of for the content title

getType

public java.lang.String getType()

Get a title for the content referred by this object

Returns:

A String with value of for the content title

getKeywordsJsonArray

public org.json.JSONArray getKeywordsJsonArray()

Get the keywords associated with this BranchUniversalObject

Returns:

A JSONArray with keywords associated with this BranchUniversalObject

getKeywords

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

Get the keywords associated with this BranchUniversalObject

Returns:

A ArrayList with keywords associated with this BranchUniversalObject

registerView

public void registerView()

Mark the content referred by this object as viewed. This increment the view count of the contents referred by this object.

registerView

public void registerView(BranchUniversalObject.RegisterViewStatusListener callback)

Mark the content referred by this object as viewed. This increment the view count of the contents referred by this object.

Parameters:

callback - An instance of BranchUniversalObject.RegisterViewStatusListener to listen to results of the operation

getShortUrl

public java.lang.String getShortUrl(android.content.Context context,
                           LinkProperties linkProperties)

generateShortUrl

public void generateShortUrl(android.content.Context context,
                    LinkProperties linkProperties,
                    Branch.BranchLinkCreateListener callback)

showShareSheet

public void showShareSheet(android.app.Activity activity,
                  LinkProperties linkProperties,
                  ShareSheetStyle style,
                  Branch.BranchLinkShareListener callback)

showShareSheet

public void showShareSheet(android.app.Activity activity,
                  LinkProperties linkProperties,
                  ShareSheetStyle style,
                  Branch.BranchLinkShareListener callback,
                  Branch.IChannelProperties channelProperties)

getReferredBranchUniversalObject

public static BranchUniversalObject getReferredBranchUniversalObject()

Get the BranchUniversalObject associated with the latest deep linking. This should retrieve the exact object used for creating the deep link. This should be called only after initialising Branch Session.

Returns:

A BranchUniversalObject used to create the deep link that started the this app session. Null is returned if this session is not started by Branch link click

createInstance

public static BranchUniversalObject createInstance(org.json.JSONObject jsonObject)

Creates a new BranchUniversalObject with the data provided by JSONObject.

Parameters:

jsonObject - JSONObject to create the BranchUniversalObject

Returns:

A BranchUniversalObject corresponding to the Json data passed in

convertToJson

public org.json.JSONObject convertToJson()

Convert the BUO to corresponding Json representation

Returns:

A JSONObject which represent this BUO

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

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

Specified by:

writeToParcel in interface android.os.Parcelable