io.branch.referral.util

Class ContentMetadata

java.lang.Object

io.branch.referral.util.ContentMetadata

All Implemented Interfaces:

android.os.Parcelable

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

Created by sojanpr on 7/25/17.

Class for describing metadata for a piece of content represented by a BranchUniversalObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContentMetadata.CONDITION

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
java.lang.String	addressCity City name associated with the qualifying content item
java.lang.String	addressCountry Country name associated with the qualifying content item
java.lang.String	addressPostalCode Postal code associated with the qualifying content item
java.lang.String	addressRegion Region or province name associated with the qualifying content item
java.lang.String	addressStreet Street address associated with the qualifying content item
ContentMetadata.CONDITION	condition Condition of the product item.
static android.os.Parcelable.Creator	CREATOR
CurrencyType	currencyType Currency type associated with the price
java.lang.Double	latitude Latitude value associated with the qualifying content item
java.lang.Double	longitude Latitude value associated with the qualifying content item
java.lang.Double	price Any price associated with the qualifying content item
java.lang.String	productBrand Any brand name associated with this metadata
ProductCategory	productCategory Category of product if this metadata is for a product Value should be one of the enumeration from ProductCategory
java.lang.String	productName Name of any product specified by this metadata
java.lang.String	productVariant Variant of product if this metadata is for a product
java.lang.Double	quantity Quantity of the thing associated with the qualifying content item
java.lang.Double	rating Rating for the qualifying content item
java.lang.Double	ratingAverage Average rating for the qualifying content item
java.lang.Integer	ratingCount Total number of ratings for the qualifying content item
java.lang.Double	ratingMax Maximum ratings for the qualifying content item
java.lang.String	sku Holds any associated store keeping unit

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
ContentMetadata()

Method Summary

Modifier and Type	Method and Description
ContentMetadata	addCustomMetadata(java.lang.String key, java.lang.String value) Adds any custom metadata associated with the qualifying content item
ContentMetadata	addImageCaptions(java.lang.String... captions) Adds any image captions associated with the qualifying content item
org.json.JSONObject	convertToJson()
static ContentMetadata	createFromJson(BranchUtil.JsonReader jsonReader)
int	describeContents()
java.util.HashMap<java.lang.String,java.lang.String>	getCustomMetadata() Returns a Map of custom metadata associated with the qualifying content item
java.util.ArrayList<java.lang.String>	getImageCaptions() Gets the list of Image Captions
ContentMetadata	setAddress(java.lang.String street, java.lang.String city, java.lang.String region, java.lang.String country, java.lang.String postalCode)
ContentMetadata	setContentSchema(BranchContentSchema contentSchema)
ContentMetadata	setLocation(java.lang.Double latitude, java.lang.Double longitude)
ContentMetadata	setPrice(java.lang.Double price, CurrencyType currency)
ContentMetadata	setProductBrand(java.lang.String productBrand)
ContentMetadata	setProductCategory(ProductCategory productCategory)
ContentMetadata	setProductCondition(ContentMetadata.CONDITION productCondition)
ContentMetadata	setProductName(java.lang.String productName)
ContentMetadata	setProductVariant(java.lang.String productVariant)
ContentMetadata	setQuantity(java.lang.Double quantity)
ContentMetadata	setRating(java.lang.Double rating, java.lang.Double averageRating, java.lang.Double maximumRating, java.lang.Integer ratingCount)
ContentMetadata	setRating(java.lang.Double averageRating, java.lang.Double maximumRating, java.lang.Integer ratingCount) Deprecated. please use setRating(Double, Double, Double, Integer) instead
ContentMetadata	setSku(java.lang.String sku)
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

quantity

public java.lang.Double quantity

Quantity of the thing associated with the qualifying content item

price

public java.lang.Double price

Any price associated with the qualifying content item

currencyType

public CurrencyType currencyType

Currency type associated with the price

sku

public java.lang.String sku

Holds any associated store keeping unit

productName

public java.lang.String productName

Name of any product specified by this metadata

productBrand

public java.lang.String productBrand

Any brand name associated with this metadata

productCategory

public ProductCategory productCategory

Category of product if this metadata is for a product Value should be one of the enumeration from ProductCategory

condition

public ContentMetadata.CONDITION condition

Condition of the product item. Value is one of the enum constants from ContentMetadata.CONDITION

productVariant

public java.lang.String productVariant

Variant of product if this metadata is for a product

rating

public java.lang.Double rating

Rating for the qualifying content item

ratingAverage

public java.lang.Double ratingAverage

Average rating for the qualifying content item

ratingCount

public java.lang.Integer ratingCount

Total number of ratings for the qualifying content item

ratingMax

public java.lang.Double ratingMax

Maximum ratings for the qualifying content item

addressStreet

public java.lang.String addressStreet

Street address associated with the qualifying content item

addressCity

public java.lang.String addressCity

City name associated with the qualifying content item

addressRegion

public java.lang.String addressRegion

Region or province name associated with the qualifying content item

addressCountry

public java.lang.String addressCountry

Country name associated with the qualifying content item

addressPostalCode

public java.lang.String addressPostalCode

Postal code associated with the qualifying content item

latitude

public java.lang.Double latitude

Latitude value associated with the qualifying content item

longitude

public java.lang.Double longitude

Latitude value associated with the qualifying content item

CREATOR

public static final android.os.Parcelable.Creator CREATOR

Constructor Detail

ContentMetadata

public ContentMetadata()

Method Detail

addImageCaptions

public ContentMetadata addImageCaptions(java.lang.String... captions)

Adds any image captions associated with the qualifying content item

Parameters:

captions - String image captions

Returns:

ContentMetadata object for method chaining

addCustomMetadata

public ContentMetadata addCustomMetadata(java.lang.String key,
                                         java.lang.String value)

Adds any custom metadata associated with the qualifying content item

Parameters:

key - Name of the custom data

value - Value for the custom data

Returns:

ContentMetadata object for method chaining

setContentSchema

public ContentMetadata setContentSchema(BranchContentSchema contentSchema)

setQuantity

public ContentMetadata setQuantity(java.lang.Double quantity)

setAddress

public ContentMetadata setAddress(java.lang.String street,
                                  java.lang.String city,
                                  java.lang.String region,
                                  java.lang.String country,
                                  java.lang.String postalCode)

setLocation

public ContentMetadata setLocation(java.lang.Double latitude,
                                   java.lang.Double longitude)

setRating

public ContentMetadata setRating(java.lang.Double rating,
                                 java.lang.Double averageRating,
                                 java.lang.Double maximumRating,
                                 java.lang.Integer ratingCount)

setRating

public ContentMetadata setRating(java.lang.Double averageRating,
                                 java.lang.Double maximumRating,
                                 java.lang.Integer ratingCount)

Deprecated. please use setRating(Double, Double, Double, Integer) instead

setPrice

public ContentMetadata setPrice(java.lang.Double price,
                                CurrencyType currency)

setProductBrand

public ContentMetadata setProductBrand(java.lang.String productBrand)

setProductCategory

public ContentMetadata setProductCategory(ProductCategory productCategory)

setProductCondition

public ContentMetadata setProductCondition(ContentMetadata.CONDITION productCondition)

setProductName

public ContentMetadata setProductName(java.lang.String productName)

setProductVariant

public ContentMetadata setProductVariant(java.lang.String productVariant)

setSku

public ContentMetadata setSku(java.lang.String sku)

getImageCaptions

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

Gets the list of Image Captions

Returns:

ArrayList containing the collection of image captions

getCustomMetadata

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

Returns a Map of custom metadata associated with the qualifying content item

Returns:

HashMap custom metadata keys and values

convertToJson

public org.json.JSONObject convertToJson()

createFromJson

public static ContentMetadata createFromJson(BranchUtil.JsonReader jsonReader)

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