Android APIs
public final class

ContentRecommendation

extends Object
java.lang.Object
   ↳ android.support.app.recommendation.ContentRecommendation

Class Overview

The ContentRecommendation object encapsulates all application provided data for a single content recommendation item.

Summary

Nested Classes
class ContentRecommendation.Builder Builder class for ContentRecommendation objects. 
@interface ContentRecommendation.ContentMaturity  
@interface ContentRecommendation.ContentPricing  
@interface ContentRecommendation.ContentStatus  
@interface ContentRecommendation.ContentType  
class ContentRecommendation.IntentData Object used to encapsulate the data to be used to build the PendingIntent object associated with a given content recommendation, at the time this recommendation gets posted to the home Screen. 
@interface ContentRecommendation.IntentType  
Constants
String CONTENT_MATURITY_ALL Value to be used with setMaturityRating(String) to indicate that the content referred by the notification is suitable for all audiences.
String CONTENT_MATURITY_HIGH Value to be used with setMaturityRating(String) to indicate that the content referred by the notification is suitable for audiences of high maturity and above.
String CONTENT_MATURITY_LOW Value to be used with setMaturityRating(String) to indicate that the content referred by the notification is suitable for audiences of low maturity and above.
String CONTENT_MATURITY_MEDIUM Value to be used with setMaturityRating(String) to indicate that the content referred by the notification is suitable for audiences of medium maturity and above.
String CONTENT_PRICING_FREE Value to be used with setPricingInformation(String, String) to indicate that the content referred by the notification item is free to consume.
String CONTENT_PRICING_PREORDER Value to be used with setPricingInformation(String, String) to indicate that the content referred by the notification item is available currently as a pre-order, and the price value provided is the purchase price for the item.
String CONTENT_PRICING_PURCHASE Value to be used with setPricingInformation(String, String) to indicate that the content referred by the notification item is available for purchase, and the price value provided is the purchase price for the item.
String CONTENT_PRICING_RENTAL Value to be used with setPricingInformation(String, String) to indicate that the content referred by the notification item is available as a rental, and the price value provided is the rental price for the item.
String CONTENT_PRICING_SUBSCRIPTION Value to be used with setPricingInformation(String, String) to indicate that the content referred by the notification item is available as part of a subscription based service, and the price value provided is the subscription price for the service.
int CONTENT_STATUS_AVAILABLE Value to be used with setStatus(int) to indicate that the content referred by the notification is available, but needs to be first purchased, rented, subscribed or downloaded before it can be consumed.
int CONTENT_STATUS_PENDING Value to be used with setStatus(int) to indicate that the content referred by the notification is pending, waiting on either a download or purchase operation to complete before it can be consumed.
int CONTENT_STATUS_READY Value to be used with setStatus(int) to indicate that the content referred by the notification is available and ready to be consumed immediately.
int CONTENT_STATUS_UNAVAILABLE Value to be used with setStatus(int) to indicate that the content referred by the notification is not available.
String CONTENT_TYPE_APP Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is an application.
String CONTENT_TYPE_BOOK Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a book.
String CONTENT_TYPE_COMIC Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a comic book.
String CONTENT_TYPE_GAME Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a game.
String CONTENT_TYPE_MAGAZINE Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a magazine.
String CONTENT_TYPE_MOVIE Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a movie.
String CONTENT_TYPE_MUSIC Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a song or album.
String CONTENT_TYPE_NEWS Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a news item.
String CONTENT_TYPE_PODCAST Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a podcast.
String CONTENT_TYPE_RADIO Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a radio station.
String CONTENT_TYPE_SERIAL Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is serial.
String CONTENT_TYPE_SPORTS Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is sports.
String CONTENT_TYPE_TRAILER Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a trailer.
String CONTENT_TYPE_VIDEO Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a video clip.
String CONTENT_TYPE_WEBSITE Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a website.
int INTENT_TYPE_ACTIVITY Value to be used with setContentIntentData(int, Intent, int, Bundle) and setDismissIntentData(int, Intent, int, Bundle) to indicate that a PendingIntent for an Activity should be created when posting the recommendation to the HomeScreen.
int INTENT_TYPE_BROADCAST Value to be used with setContentIntentData(int, Intent, int, Bundle) and setDismissIntentData(int, Intent, int, Bundle) to indicate that a PendingIntent for a Broadcast should be created when posting the recommendation to the HomeScreen.
int INTENT_TYPE_SERVICE Value to be used with setContentIntentData(int, Intent, int, Bundle) and setDismissIntentData(int, Intent, int, Bundle) to indicate that a PendingIntent for a Service should be created when posting the recommendation to the HomeScreen.
Public Methods
boolean equals(Object other)
Compares this instance with the specified object and indicates if they are equal.
String getBackgroundImageUri()
Returns a Content URI that can be used to retrieve the background image for this recommendation.
int getBadgeImageResourceId()
Returns the resource id for the recommendation badging icon.
int getColor()
Returns the accent color value to be used in the UI when displaying this content recommendation to the user.
Bitmap getContentImage()
Returns the Bitmap containing the recommendation image.
ContentRecommendation.IntentData getContentIntent()
Returns the data for the Intent that will be issued when the user clicks on the recommendation.
String[] getContentTypes()
Returns an array containing the content types tags that describe the content.
ContentRecommendation.IntentData getDismissIntent()
Returns the data for the Intent that will be issued when the recommendation gets dismissed from the Home Screen, due to an user action.
String[] getGenres()
Returns an array containing the genres that describe the content.
String getGroup()
Returns the String group ID tag for this recommendation.
String getIdTag()
Returns the String Id tag which uniquely identifies this recommendation.
String getMaturityRating()
Returns the maturity level rating for the content.
Notification getNotificationObject(Context context)
Returns a Notification object which contains the content recommendation data encapsulated by this object, which can be used for posting the recommendation via the NotificationManager.
String getPricingType()
Gets the pricing type for the content.
String getPricingValue()
Gets the price value (when applicable) for the content.
String getPrimaryContentType()
Returns the primary content type tag for the recommendation, or null if no content types have been specified.
int getProgressMax()
Returns the maximum value for the progress data of this recommendation.
int getProgressValue()
Returns the progress amount for this recommendation.
long getRunningTime()
Returns the running time for the content.
String getSortKey()
Returns the String sort key for this recommendation.
String getSourceName()
Returns the source application name for this recommendation.
int getStatus()
Returns availability status value for the content.
String getText()
Returns the description text for this recommendation.
String getTitle()
Returns the content title for this recommendation.
boolean hasProgressInfo()
Indicates if this recommendation contains valid progress information.
int hashCode()
Returns an integer hash code for this object.
boolean isAutoDismiss()
Indicates whether this recommendation should be dismissed automatically.
void setAutoDismiss(boolean autoDismiss)
Sets the flag indicating if this recommendation should be dismissed automatically.
void setGroup(String groupTag)
Sets the String group ID tag for this recommendation.
void setProgress(int max, int progress)
Sets the progress information for the content pointed to by this recommendation.
void setSortKey(String sortKey)
Sets the String sort key for this recommendation.
void setStatus(int status)
Sets the availability status value for the content.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String CONTENT_MATURITY_ALL

Value to be used with setMaturityRating(String) to indicate that the content referred by the notification is suitable for all audiences.

Constant Value: "android.contentMaturity.all"

public static final String CONTENT_MATURITY_HIGH

Value to be used with setMaturityRating(String) to indicate that the content referred by the notification is suitable for audiences of high maturity and above.

Constant Value: "android.contentMaturity.high"

public static final String CONTENT_MATURITY_LOW

Value to be used with setMaturityRating(String) to indicate that the content referred by the notification is suitable for audiences of low maturity and above.

Constant Value: "android.contentMaturity.low"

public static final String CONTENT_MATURITY_MEDIUM

Value to be used with setMaturityRating(String) to indicate that the content referred by the notification is suitable for audiences of medium maturity and above.

Constant Value: "android.contentMaturity.medium"

public static final String CONTENT_PRICING_FREE

Value to be used with setPricingInformation(String, String) to indicate that the content referred by the notification item is free to consume.

Constant Value: "android.contentPrice.free"

public static final String CONTENT_PRICING_PREORDER

Value to be used with setPricingInformation(String, String) to indicate that the content referred by the notification item is available currently as a pre-order, and the price value provided is the purchase price for the item.

Constant Value: "android.contentPrice.preorder"

public static final String CONTENT_PRICING_PURCHASE

Value to be used with setPricingInformation(String, String) to indicate that the content referred by the notification item is available for purchase, and the price value provided is the purchase price for the item.

Constant Value: "android.contentPrice.purchase"

public static final String CONTENT_PRICING_RENTAL

Value to be used with setPricingInformation(String, String) to indicate that the content referred by the notification item is available as a rental, and the price value provided is the rental price for the item.

Constant Value: "android.contentPrice.rental"

public static final String CONTENT_PRICING_SUBSCRIPTION

Value to be used with setPricingInformation(String, String) to indicate that the content referred by the notification item is available as part of a subscription based service, and the price value provided is the subscription price for the service.

Constant Value: "android.contentPrice.subscription"

public static final int CONTENT_STATUS_AVAILABLE

Value to be used with setStatus(int) to indicate that the content referred by the notification is available, but needs to be first purchased, rented, subscribed or downloaded before it can be consumed.

Constant Value: 2 (0x00000002)

public static final int CONTENT_STATUS_PENDING

Value to be used with setStatus(int) to indicate that the content referred by the notification is pending, waiting on either a download or purchase operation to complete before it can be consumed.

Constant Value: 1 (0x00000001)

public static final int CONTENT_STATUS_READY

Value to be used with setStatus(int) to indicate that the content referred by the notification is available and ready to be consumed immediately.

Constant Value: 0 (0x00000000)

public static final int CONTENT_STATUS_UNAVAILABLE

Value to be used with setStatus(int) to indicate that the content referred by the notification is not available. This could be content not available in a certain region or incompatible with the device in use.

Constant Value: 3 (0x00000003)

public static final String CONTENT_TYPE_APP

Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is an application.

Constant Value: "android.contentType.app"

public static final String CONTENT_TYPE_BOOK

Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a book.

Constant Value: "android.contentType.book"

public static final String CONTENT_TYPE_COMIC

Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a comic book.

Constant Value: "android.contentType.comic"

public static final String CONTENT_TYPE_GAME

Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a game.

Constant Value: "android.contentType.game"

public static final String CONTENT_TYPE_MAGAZINE

Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a magazine.

Constant Value: "android.contentType.magazine"

public static final String CONTENT_TYPE_MOVIE

Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a movie.

Constant Value: "android.contentType.movie"

public static final String CONTENT_TYPE_MUSIC

Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a song or album.

Constant Value: "android.contentType.music"

public static final String CONTENT_TYPE_NEWS

Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a news item.

Constant Value: "android.contentType.news"

public static final String CONTENT_TYPE_PODCAST

Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a podcast.

Constant Value: "android.contentType.podcast"

public static final String CONTENT_TYPE_RADIO

Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a radio station.

Constant Value: "android.contentType.radio"

public static final String CONTENT_TYPE_SERIAL

Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is serial. It can refer to an entire show, a single season or series, or a single episode.

Constant Value: "android.contentType.serial"

public static final String CONTENT_TYPE_SPORTS

Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is sports.

Constant Value: "android.contentType.sports"

public static final String CONTENT_TYPE_TRAILER

Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a trailer.

Constant Value: "android.contentType.trailer"

public static final String CONTENT_TYPE_VIDEO

Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a video clip.

Constant Value: "android.contentType.video"

public static final String CONTENT_TYPE_WEBSITE

Value to be used with setContentTypes(String[]) to indicate that the content referred by the notification item is a website.

Constant Value: "android.contentType.website"

public static final int INTENT_TYPE_ACTIVITY

Value to be used with setContentIntentData(int, Intent, int, Bundle) and setDismissIntentData(int, Intent, int, Bundle) to indicate that a PendingIntent for an Activity should be created when posting the recommendation to the HomeScreen.

Constant Value: 1 (0x00000001)

public static final int INTENT_TYPE_BROADCAST

Value to be used with setContentIntentData(int, Intent, int, Bundle) and setDismissIntentData(int, Intent, int, Bundle) to indicate that a PendingIntent for a Broadcast should be created when posting the recommendation to the HomeScreen.

Constant Value: 2 (0x00000002)

public static final int INTENT_TYPE_SERVICE

Value to be used with setContentIntentData(int, Intent, int, Bundle) and setDismissIntentData(int, Intent, int, Bundle) to indicate that a PendingIntent for a Service should be created when posting the recommendation to the HomeScreen.

Constant Value: 3 (0x00000003)

Public Methods

public boolean equals (Object other)

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
other the object to compare this instance with.
Returns
  • true if the specified object is equal to this Object; false otherwise.

public String getBackgroundImageUri ()

Returns a Content URI that can be used to retrieve the background image for this recommendation.

Returns
  • A Content URI pointing to the recommendation background image.

public int getBadgeImageResourceId ()

Returns the resource id for the recommendation badging icon.

The resource id represents the icon resource in the source application package.

Returns
  • An integer id for the badge icon resource.

public int getColor ()

Returns the accent color value to be used in the UI when displaying this content recommendation to the user.

Returns
  • An integer value representing the accent color for this recommendation.

public Bitmap getContentImage ()

Returns the Bitmap containing the recommendation image.

Returns
  • A Bitmap containing the recommendation image.

public ContentRecommendation.IntentData getContentIntent ()

Returns the data for the Intent that will be issued when the user clicks on the recommendation.

Returns
  • An IntentData object, containing the data for the Intent that gets issued when the recommendation is clicked on.

public String[] getContentTypes ()

Returns an array containing the content types tags that describe the content. The first tag entry is considered the primary type for the content, and is used for content ranking purposes.

Returns
  • An array of predefined type tags (see the CONTENT_TYPE_* constants) that describe the recommended content.

public ContentRecommendation.IntentData getDismissIntent ()

Returns the data for the Intent that will be issued when the recommendation gets dismissed from the Home Screen, due to an user action.

Returns
  • An IntentData object, containing the data for the Intent that gets issued when the recommendation is dismissed from the Home Screen.

public String[] getGenres ()

Returns an array containing the genres that describe the content. Genres are open ended String tags.

Returns
  • An array of genre tags that describe the recommended content.

public String getGroup ()

Returns the String group ID tag for this recommendation.

Returns
  • A String containing the group ID tag for this recommendation.

public String getIdTag ()

Returns the String Id tag which uniquely identifies this recommendation.

Returns
  • The String Id tag for this recommendation.

public String getMaturityRating ()

Returns the maturity level rating for the content.

Returns
  • returns a predefined tag indicating the maturity level rating for the content (see the CONTENT_MATURITY_* constants).

public Notification getNotificationObject (Context context)

Returns a Notification object which contains the content recommendation data encapsulated by this object, which can be used for posting the recommendation via the NotificationManager.

Parameters
context A Context that will be used to construct the Notification object which will carry the recommendation data.
Returns

public String getPricingType ()

Gets the pricing type for the content.

Returns
  • A predefined tag indicating the pricing type for the content (see the CONTENT_PRICING_* constants).

public String getPricingValue ()

Gets the price value (when applicable) for the content. The value will be provided as a String containing the price in the appropriate currency for the current locale.

Returns
  • A string containing a representation of the content price in the current locale and currency.

public String getPrimaryContentType ()

Returns the primary content type tag for the recommendation, or null if no content types have been specified.

Returns
  • A predefined type tag (see the CONTENT_TYPE_* constants) indicating the primary content type for the recommendation.

public int getProgressMax ()

Returns the maximum value for the progress data of this recommendation.

Returns
  • An integer representing the maximum progress value.

public int getProgressValue ()

Returns the progress amount for this recommendation.

Returns
  • An integer representing the recommendation progress amount.

public long getRunningTime ()

Returns the running time for the content.

Returns
  • The run length, in seconds, of the content associated with the notification.

public String getSortKey ()

Returns the String sort key for this recommendation.

Returns
  • A String containing the sort key for this recommendation.

public String getSourceName ()

Returns the source application name for this recommendation.

Returns
  • A String containing the recommendation source name.

public int getStatus ()

Returns availability status value for the content. This status indicates whether the content is ready to be consumed on the device, or if the user must first purchase, rent, subscribe to, or download the content.

Returns
  • The status value for the content, or -1 is a valid status has not been specified (see the CONTENT_STATUS_* constants for the valid status values).

public String getText ()

Returns the description text for this recommendation.

Returns
  • A String containing the recommendation description text.

public String getTitle ()

Returns the content title for this recommendation.

Returns
  • A String containing the recommendation content title.

public boolean hasProgressInfo ()

Indicates if this recommendation contains valid progress information.

Returns
  • true if the recommendation contains valid progress data, false otherwise.

public int hashCode ()

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
  • this object's hash code.

public boolean isAutoDismiss ()

Indicates whether this recommendation should be dismissed automatically.

Auto-dismiss notifications are automatically removed from the Home Screen when the user clicks on them.

Returns
  • true if the recommendation is marked for auto dismissal, or false otherwise.

public void setAutoDismiss (boolean autoDismiss)

Sets the flag indicating if this recommendation should be dismissed automatically.

Auto-dismiss notifications are automatically removed from the Home Screen when the user clicks on them.

Parameters
autoDismiss A boolean indicating if the recommendation should be auto dismissed or not.

public void setGroup (String groupTag)

Sets the String group ID tag for this recommendation.

Recommendations in the same group are ranked by the Home Screen together, and the sort order within a group is respected. This can be useful if the application has different sources for recommendations, like "trending", "subscriptions", and "new music" categories for YouTube, where the user can be more interested in recommendations from one group than another.

Parameters
groupTag A String containing the group ID tag for this recommendation.

public void setProgress (int max, int progress)

Sets the progress information for the content pointed to by this recommendation.

Parameters
max The maximum value for the progress of this content.
progress The progress amount for this content. Must be in the range (0 - max).

public void setSortKey (String sortKey)

Sets the String sort key for this recommendation.

The sort key must be a String representation of a float number between 0.0 and 1.0, and is used to indicate the relative importance (and sort order) of a single recommendation within its specified group. The recommendations will be ordered in decreasing order of importance within a given group.

Parameters
sortKey A String containing the sort key for this recommendation.

public void setStatus (int status)

Sets the availability status value for the content. This status indicates whether the content is ready to be consumed on the device, or if the user must first purchase, rent, subscribe to, or download the content.

Parameters
status The status value for the content. (see the CONTENT_STATUS_* for the valid status values).