All Implemented Interfaces:

android.os.Parcelable
```
public class BranchUniversalObject
 implements 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	Description
`public enum`	`BranchUniversalObject.CONTENT_INDEX_MODE`	Defines the Content indexing modesPUBLIC \| PRIVATE
`public interface`	`BranchUniversalObject.RegisterViewStatusListener`	Callback interface for listening register content view status

Field Summary

Fields
Modifier and Type	Field	Description
`public final static Parcelable.Creator`	`CREATOR`

Constructor Summary

Constructors
Constructor	Description
`BranchUniversalObject()`	Create a BranchUniversalObject with the given content.

Method Summary

Modifier and Type	Method	Description
`BranchUniversalObject`	`setCanonicalIdentifier(@NonNull() String canonicalIdentifier)`	Set the canonical identifier for this BranchUniversalObject.
`BranchUniversalObject`	`setCanonicalUrl(@NonNull() String canonicalUrl)`	Canonical url for the content referred.
`BranchUniversalObject`	`setTitle(@NonNull() String title)`	Set a title for the content referred by this object
`BranchUniversalObject`	`setContentDescription(String description)`	Set description for the content for the content referred by this object
`BranchUniversalObject`	`setContentImageUrl(@NonNull() String imageUrl)`	Set the url to any image associated with this content.
`BranchUniversalObject`	`addContentMetadata(HashMap<String, String> metadata)`
`BranchUniversalObject`	`addContentMetadata(String key, String value)`
`BranchUniversalObject`	`setContentMetadata(ContentMetadata metadata)`	Set the metadata associated with the content.
`BranchUniversalObject`	`setContentType(String type)`
`BranchUniversalObject`	`setContentIndexingMode(BranchUniversalObject.CONTENT_INDEX_MODE indexMode)`	Set the indexing mode for the content referred in this object
`BranchUniversalObject`	`setLocalIndexMode(BranchUniversalObject.CONTENT_INDEX_MODE localIndexMode)`	Set the Local indexing mode for the content referred in this object.NOTE: The locally indexable contents are added to the local indexing services , if supported, when listing the contents on Google or other content indexing services.
`BranchUniversalObject`	`addKeyWords(ArrayList<String> keywords)`	Adds any keywords associated with the content referred
`BranchUniversalObject`	`addKeyWord(String keyword)`	Add a keyword associated with the content referred
`BranchUniversalObject`	`setContentExpiration(Date expirationDate)`	Set the content expiration time.
`BranchUniversalObject`	`setPrice(double price, CurrencyType currency)`	Set the price associated with content of this BUO if any
`void`	`listOnGoogleSearch(Context context)`	Publish this BUO with Google app indexing so that the contents will be available with google searchwith branch link pointing to the app.
`void`	`listOnGoogleSearch(Context context, LinkProperties linkProperties)`	Publish this BUO with Google app indexing so that the contents will be available with google searchwith branch link pointing to the app.
`void`	`removeFromLocalIndexing(Context context)`	Remove the BUO from the local indexing if it is added to the local indexing alreadyThis will remove the content from Google(Firebase) and other supported Indexing services
`void`	`removeFromLocalIndexing(Context context, LinkProperties linkProperties)`	Remove the BUO from the local indexing if it is added to the local indexing alreadyThis will remove the content from Google(Firebase) and other supported Indexing servicesThis method takes additional LinkProperties parameter.
`void`	`userCompletedAction(String action)`	Method to report user actions happened on this BUO.
`void`	`userCompletedAction(BRANCH_STANDARD_EVENT action)`	Method to report user actions happened on this BUO.
`void`	`userCompletedAction(String action, HashMap<String, String> metadata)`	Method to report user actions happened on this BUO.
`void`	`userCompletedAction(BRANCH_STANDARD_EVENT action, HashMap<String, String> metadata)`	Method to report user actions happened on this BUO.
`boolean`	`isPublicallyIndexable()`	Specifies whether the contents referred by this object is publically indexable
`boolean`	`isLocallyIndexable()`	Specifies whether the contents referred by this object is locally indexable
`HashMap<String, String>`	`getMetadata()`
`ContentMetadata`	`getContentMetadata()`	Get the ContentMetadata associated with this BUO which holds the metadata for content represented
`long`	`getExpirationTime()`	Get expiry date for the content and any associated links.
`String`	`getCanonicalIdentifier()`	Get the canonical identifier for this BranchUniversalObject
`String`	`getCanonicalUrl()`	Get the canonical url for this BranchUniversalObject
`String`	`getDescription()`	Get description for the content for the content referred by this object
`String`	`getImageUrl()`	Get the url to any image associated with this content.
`String`	`getTitle()`	Get a title for the content referred by this object
`String`	`getType()`
`double`	`getPrice()`	Gets the price associated with this BUO content
`String`	`getCurrencyType()`	Get the currency type of the price for this BUO
`JSONArray`	`getKeywordsJsonArray()`	Get the keywords associated with this BranchUniversalObject
`ArrayList<String>`	`getKeywords()`	Get the keywords associated with this BranchUniversalObject
`void`	`registerView()`	Mark the content referred by this object as viewed.
`void`	`registerView(@Nullable() BranchUniversalObject.RegisterViewStatusListener callback)`	Mark the content referred by this object as viewed.
`String`	`getShortUrl(@NonNull() Context context, @NonNull() LinkProperties linkProperties)`	Creates a short url for the BUO synchronously.
`String`	`getShortUrl(@NonNull() Context context, @NonNull() LinkProperties linkProperties, boolean defaultToLongUrl)`	Creates a short url for the BUO synchronously.
`void`	`generateShortUrl(@NonNull() Context context, @NonNull() LinkProperties linkProperties, @Nullable() Branch.BranchLinkCreateListener callback)`	Creates a short url for the BUO asynchronously
`void`	`generateShortUrl(@NonNull() Context context, @NonNull() LinkProperties linkProperties, @Nullable() Branch.BranchLinkCreateListener callback, boolean defaultToLongUrl)`	Creates a short url for the BUO asynchronously.
`void`	`showShareSheet(@NonNull() Activity activity, @NonNull() LinkProperties linkProperties, @NonNull() ShareSheetStyle style, @Nullable() Branch.BranchLinkShareListener callback)`
`void`	`showShareSheet(@NonNull() Activity activity, @NonNull() LinkProperties linkProperties, @NonNull() ShareSheetStyle style, @Nullable() Branch.BranchLinkShareListener callback, Branch.IChannelProperties channelProperties)`
`static BranchUniversalObject`	`getReferredBranchUniversalObject()`	Get the BranchUniversalObject associated with the latest deep linking.
`static BranchUniversalObject`	`createInstance(JSONObject jsonObject)`	Creates a new BranchUniversalObject with the data provided by JSONObject.
`JSONObject`	`convertToJson()`	Convert the BUO to corresponding Json representation
`int`	`describeContents()`
`void`	`writeToParcel(Parcel dest, int flags)`

Methods inherited from class android.os.Parcelable
describeContents, writeToParcel
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BranchUniversalObject
```
BranchUniversalObject()
```
    Create a BranchUniversalObject with the given content.
- Method Detail
  - setCanonicalIdentifier
```
 BranchUniversalObject setCanonicalIdentifier(@NonNull() 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
  - setCanonicalUrl
```
 BranchUniversalObject setCanonicalUrl(@NonNull() 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
  - setTitle
```
 BranchUniversalObject setTitle(@NonNull() String title)
```
    Set a title for the content referred by this object
    
    Parameters:
    
    title - A String with value of for the content title
  - setContentDescription
```
 BranchUniversalObject setContentDescription(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
  - setContentImageUrl
```
 BranchUniversalObject setContentImageUrl(@NonNull() 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
  - addContentMetadata
```
 BranchUniversalObject addContentMetadata(HashMap<String, String> metadata)
```
  - addContentMetadata
```
 BranchUniversalObject addContentMetadata(String key, String value)
```
  - setContentMetadata
```
 BranchUniversalObject setContentMetadata(ContentMetadata metadata)
```
    Set the metadata associated with the content. Please see ContentMetadata
    
    Parameters:
    
    metadata - Instance of ContentMetadata.
  - setContentType
```
 BranchUniversalObject setContentType(String type)
```
  - setContentIndexingMode
```
 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
  - setLocalIndexMode
```
 BranchUniversalObject setLocalIndexMode(BranchUniversalObject.CONTENT_INDEX_MODE localIndexMode)
```
    Set the Local indexing mode for the content referred in this object.NOTE: The locally indexable contents are added to the local indexing services , if supported, when listing the contents on Google or other content indexing services.So please make sure you are marking local index mode to PRIVATE if you don't want to list the contents locally on device
    
    Parameters:
    
    localIndexMode - BranchUniversalObject.CONTENT_INDEX_MODE value for the content referred
  - addKeyWords
```
 BranchUniversalObject addKeyWords(ArrayList<String> keywords)
```
    Adds any keywords associated with the content referred
    
    Parameters:
    
    keywords - An ArrayList of String values
  - addKeyWord
```
 BranchUniversalObject addKeyWord(String keyword)
```
    Add a keyword associated with the content referred
    
    Parameters:
    
    keyword - AString with value for keyword
  - setContentExpiration
```
 BranchUniversalObject setContentExpiration(Date expirationDate)
```
    Set the content expiration time.
    
    Parameters:
    
    expirationDate - A Date value representing the expiration date.
  - setPrice
```
 BranchUniversalObject setPrice(double price, CurrencyType currency)
```
    Set the price associated with content of this BUO if any
    
    Parameters:
    
    price - A Double value specifying the price info associated with BUO
    
    currency - ISO 4217 currency code defined in CurrencyType for the price
  - listOnGoogleSearch
```
 void listOnGoogleSearch(Context context)
```
    Publish this BUO with Google app indexing so that the contents will be available with google searchwith branch link pointing to the app.
    
    Parameters:
    
    context - Application context
  - listOnGoogleSearch
```
 void listOnGoogleSearch(Context context, LinkProperties linkProperties)
```
    Publish this BUO with Google app indexing so that the contents will be available with google searchwith branch link pointing to the app. This method takes additional LinkProperties parameter to configure the link settings for your link that is indexed
    
    Parameters:
    
    context - Application context
  - removeFromLocalIndexing
```
 void removeFromLocalIndexing(Context context)
```
    Remove the BUO from the local indexing if it is added to the local indexing alreadyThis will remove the content from Google(Firebase) and other supported Indexing services
    
    Parameters:
    
    context - Application context
  - removeFromLocalIndexing
```
 void removeFromLocalIndexing(Context context, LinkProperties linkProperties)
```
    Remove the BUO from the local indexing if it is added to the local indexing alreadyThis will remove the content from Google(Firebase) and other supported Indexing servicesThis method takes additional LinkProperties parameter. Use this method if you indexed the content using listOnGoogleSearch methodotherwise use removeFromLocalIndexing
    
    Parameters:
    
    context - Application context
  - userCompletedAction
```
 void userCompletedAction(String action)
```
    Method to report user actions happened on this BUO. Use this method to report the user actions for analytics purpose.
    
    Parameters:
    
    action - A Stringwith value of user action name.
  - userCompletedAction
```
 void userCompletedAction(BRANCH_STANDARD_EVENT action)
```
    Method to report user actions happened on this BUO. Use this method to report the user actions for analytics purpose.
    
    Parameters:
    
    action - A BRANCH_STANDARD_EVENTwith value of user action name.
  - userCompletedAction
```
 void userCompletedAction(String action, HashMap<String, String> metadata)
```
    Method to report user actions happened on this BUO. Use this method to report the user actions for analytics purpose.
    
    Parameters:
    
    action - A Stringwith value of user action name.
    
    metadata - A HashMap containing any additional metadata need to add to this user eventNOTE : please consider using userCompletedAction instead
  - userCompletedAction
```
 void userCompletedAction(BRANCH_STANDARD_EVENT action, HashMap<String, String> metadata)
```
    Method to report user actions happened on this BUO. Use this method to report the user actions for analytics purpose.
    
    Parameters:
    
    action - A BRANCH_STANDARD_EVENTwith value of user action name.
    
    metadata - A HashMap containing any additional metadata need to add to this user event
  - isPublicallyIndexable
```
 boolean isPublicallyIndexable()
```
    Specifies whether the contents referred by this object is publically indexable
  - isLocallyIndexable
```
 boolean isLocallyIndexable()
```
    Specifies whether the contents referred by this object is locally indexable
  - getMetadata
```
 HashMap<String, String> getMetadata()
```
  - getContentMetadata
```
 ContentMetadata getContentMetadata()
```
    Get the ContentMetadata associated with this BUO which holds the metadata for content represented
  - getExpirationTime
```
 long getExpirationTime()
```
    Get expiry date for the content and any associated links. Represented as epoch milli second
  - getCanonicalIdentifier
```
 String getCanonicalIdentifier()
```
    Get the canonical identifier for this BranchUniversalObject
  - getCanonicalUrl
```
 String getCanonicalUrl()
```
    Get the canonical url for this BranchUniversalObject
  - getDescription
```
 String getDescription()
```
    Get description for the content for the content referred by this object
  - getImageUrl
```
 String getImageUrl()
```
    Get the url to any image associated with this content.
  - getTitle
```
 String getTitle()
```
    Get a title for the content referred by this object
  - getType
```
 String getType()
```
  - getPrice
```
 double getPrice()
```
    Gets the price associated with this BUO content
  - getCurrencyType
```
 String getCurrencyType()
```
    Get the currency type of the price for this BUO
  - getKeywordsJsonArray
```
 JSONArray getKeywordsJsonArray()
```
    Get the keywords associated with this BranchUniversalObject
  - getKeywords
```
 ArrayList<String> getKeywords()
```
    Get the keywords associated with this BranchUniversalObject
  - registerView
```
 void registerView()
```
    Mark the content referred by this object as viewed. This increment the view count of the contents referred by this object.
  - registerView
```
 void registerView(@Nullable() 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 RegisterViewStatusListener to listen to results of the operation
  - getShortUrl
```
 String getShortUrl(@NonNull() Context context, @NonNull() LinkProperties linkProperties)
```
    Creates a short url for the BUO synchronously.
    
    Parameters:
    
    context - Context instance
    
    linkProperties - An object of LinkProperties specifying the properties of this link
  - getShortUrl
```
 String getShortUrl(@NonNull() Context context, @NonNull() LinkProperties linkProperties, boolean defaultToLongUrl)
```
    Creates a short url for the BUO synchronously.
    
    Parameters:
    
    context - Context instance
    
    linkProperties - An object of LinkProperties specifying the properties of this link
    
    defaultToLongUrl - A specifies if a long url should be returned in case of link creation errorIf set to false, NULL is returned in case of link creation error
  - generateShortUrl
```
 void generateShortUrl(@NonNull() Context context, @NonNull() LinkProperties linkProperties, @Nullable() Branch.BranchLinkCreateListener callback)
```
    Creates a short url for the BUO asynchronously
    
    Parameters:
    
    context - Context instance
    
    linkProperties - An object of LinkProperties specifying the properties of this link
    
    callback - An instance of io.branch.referral.Branch.BranchLinkCreateListener to receive the results
  - generateShortUrl
```
 void generateShortUrl(@NonNull() Context context, @NonNull() LinkProperties linkProperties, @Nullable() Branch.BranchLinkCreateListener callback, boolean defaultToLongUrl)
```
    Creates a short url for the BUO asynchronously.
    
    Parameters:
    
    context - Context instance
    
    linkProperties - An object of LinkProperties specifying the properties of this link
    
    callback - An instance of io.branch.referral.Branch.BranchLinkCreateListener to receive the results
    
    defaultToLongUrl - A specifies if a long url should be returned in case of link creation errorIf set to false, NULL is returned in case of link creation error
  - showShareSheet
```
 void showShareSheet(@NonNull() Activity activity, @NonNull() LinkProperties linkProperties, @NonNull() ShareSheetStyle style, @Nullable() Branch.BranchLinkShareListener callback)
```
  - showShareSheet
```
 void showShareSheet(@NonNull() Activity activity, @NonNull() LinkProperties linkProperties, @NonNull() ShareSheetStyle style, @Nullable() Branch.BranchLinkShareListener callback, Branch.IChannelProperties channelProperties)
```
  - getReferredBranchUniversalObject
```
 static BranchUniversalObject getReferredBranchUniversalObject()
```
    Get the BranchUniversalObject associated with the latest deep linking. This should retrieve theexact object used for creating the deep link. This should be called only after initialising Branch Session.
  - createInstance
```
 static BranchUniversalObject createInstance(JSONObject jsonObject)
```
    Creates a new BranchUniversalObject with the data provided by JSONObject.
    
    Parameters:
    
    jsonObject - JSONObject to create the BranchUniversalObject
  - convertToJson
```
 JSONObject convertToJson()
```
    Convert the BUO to corresponding Json representation
  - describeContents
```
 int describeContents()
```
  - writeToParcel
```
 void writeToParcel(Parcel dest, int flags)
```

Class BranchUniversalObject

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class android.os.Parcelable

Methods inherited from class java.lang.Object

Constructor Detail

BranchUniversalObject

Method Detail

setCanonicalIdentifier

setCanonicalUrl

setTitle

setContentDescription

setContentImageUrl

addContentMetadata

addContentMetadata

setContentMetadata

setContentType

setContentIndexingMode

setLocalIndexMode

addKeyWords

addKeyWord

setContentExpiration

setPrice

listOnGoogleSearch

listOnGoogleSearch

removeFromLocalIndexing

removeFromLocalIndexing

userCompletedAction

userCompletedAction

userCompletedAction

userCompletedAction

isPublicallyIndexable

isLocallyIndexable

getMetadata

getContentMetadata

getExpirationTime

getCanonicalIdentifier

getCanonicalUrl

getDescription

getImageUrl

getTitle

getType

getPrice

getCurrencyType

getKeywordsJsonArray

getKeywords

registerView

registerView

getShortUrl

getShortUrl

generateShortUrl

generateShortUrl

showShareSheet

showShareSheet

getReferredBranchUniversalObject

createInstance

convertToJson

describeContents

writeToParcel