ContentRecommendation
public final class ContentRecommendation
The ContentRecommendation object encapsulates all application provided data for a single content recommendation item.
Summary
Nested types |
|---|
public final class ContentRecommendation.BuilderBuilder class for |
@StringDef(value = ) |
@StringDef(value = ) |
@IntDef(value = ) |
@StringDef(value = ) |
public class ContentRecommendation.IntentDataObject used to encapsulate the data to be used to build the |
@IntDef(value = ) |
Constants |
|
|---|---|
static final String |
CONTENT_MATURITY_ALL = "android.contentMaturity.all"Value to be used with |
static final String |
CONTENT_MATURITY_HIGH = "android.contentMaturity.high"Value to be used with |
static final String |
CONTENT_MATURITY_LOW = "android.contentMaturity.low"Value to be used with |
static final String |
CONTENT_MATURITY_MEDIUM = "android.contentMaturity.medium"Value to be used with |
static final String |
CONTENT_PRICING_FREE = "android.contentPrice.free"Value to be used with |
static final String |
CONTENT_PRICING_PREORDER = "android.contentPrice.preorder"Value to be used with |
static final String |
CONTENT_PRICING_PURCHASE = "android.contentPrice.purchase"Value to be used with |
static final String |
CONTENT_PRICING_RENTAL = "android.contentPrice.rental"Value to be used with |
static final String |
CONTENT_PRICING_SUBSCRIPTION = "android.contentPrice.subscription"Value to be used with |
static final int |
Value to be used with |
static final int |
Value to be used with |
static final int |
Value to be used with |
static final int |
Value to be used with |
static final String |
CONTENT_TYPE_APP = "android.contentType.app"Value to be used with |
static final String |
CONTENT_TYPE_BOOK = "android.contentType.book"Value to be used with |
static final String |
CONTENT_TYPE_COMIC = "android.contentType.comic"Value to be used with |
static final String |
CONTENT_TYPE_GAME = "android.contentType.game"Value to be used with |
static final String |
CONTENT_TYPE_MAGAZINE = "android.contentType.magazine"Value to be used with |
static final String |
CONTENT_TYPE_MOVIE = "android.contentType.movie"Value to be used with |
static final String |
CONTENT_TYPE_MUSIC = "android.contentType.music"Value to be used with |
static final String |
CONTENT_TYPE_NEWS = "android.contentType.news"Value to be used with |
static final String |
CONTENT_TYPE_PODCAST = "android.contentType.podcast"Value to be used with |
static final String |
CONTENT_TYPE_RADIO = "android.contentType.radio"Value to be used with |
static final String |
CONTENT_TYPE_SERIAL = "android.contentType.serial"Value to be used with |
static final String |
CONTENT_TYPE_SPORTS = "android.contentType.sports"Value to be used with |
static final String |
CONTENT_TYPE_TRAILER = "android.contentType.trailer"Value to be used with |
static final String |
CONTENT_TYPE_VIDEO = "android.contentType.video"Value to be used with |
static final String |
CONTENT_TYPE_WEBSITE = "android.contentType.website"Value to be used with |
static final int |
Value to be used with |
static final int |
Value to be used with |
static final int |
Value to be used with |
Public methods |
|
|---|---|
boolean |
|
String |
Returns a Content URI that can be used to retrieve the background image for this recommendation. |
int |
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 |
Returns the Bitmap containing the recommendation image. |
ContentRecommendation.IntentData |
Returns the data for the Intent that will be issued when the user clicks on the recommendation. |
String[] |
Returns an array containing the content types tags that describe the content. |
ContentRecommendation.IntentData |
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[] |
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 |
Returns the maturity level rating for the content. |
Notification |
getNotificationObject(Context context)Returns a |
String |
Gets the pricing type for the content. |
String |
Gets the price value (when applicable) for the content. |
String |
Returns the primary content type tag for the recommendation, or null if no content types have been specified. |
int |
Returns the maximum value for the progress data of this recommendation. |
int |
Returns the progress amount for this recommendation. |
long |
Returns the running time for the content. |
String |
Returns the String sort key for this recommendation. |
String |
Returns the source application name for this recommendation. |
int |
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 |
Indicates if this recommendation contains valid progress information. |
int |
hashCode() |
boolean |
Indicates whether this recommendation should be dismissed automatically. |
void |
setAutoDismiss(boolean autoDismiss)Sets the flag indicating if this recommendation should be dismissed automatically. |
void |
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(@ContentRecommendation.ContentStatus int status)Sets the availability status value for the content. |
Constants
CONTENT_MATURITY_ALL
public static final String CONTENT_MATURITY_ALL = "android.contentMaturity.all"
Value to be used with setMaturityRating to indicate that the content referred by the notification is suitable for all audiences.
CONTENT_MATURITY_HIGH
public static final String CONTENT_MATURITY_HIGH = "android.contentMaturity.high"
Value to be used with setMaturityRating to indicate that the content referred by the notification is suitable for audiences of high maturity and above.
CONTENT_MATURITY_LOW
public static final String CONTENT_MATURITY_LOW = "android.contentMaturity.low"
Value to be used with setMaturityRating to indicate that the content referred by the notification is suitable for audiences of low maturity and above.
CONTENT_MATURITY_MEDIUM
public static final String CONTENT_MATURITY_MEDIUM = "android.contentMaturity.medium"
Value to be used with setMaturityRating to indicate that the content referred by the notification is suitable for audiences of medium maturity and above.
CONTENT_PRICING_FREE
public static final String CONTENT_PRICING_FREE = "android.contentPrice.free"
Value to be used with setPricingInformation to indicate that the content referred by the notification item is free to consume.
CONTENT_PRICING_PREORDER
public static final String CONTENT_PRICING_PREORDER = "android.contentPrice.preorder"
Value to be used with setPricingInformation 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.
CONTENT_PRICING_PURCHASE
public static final String CONTENT_PRICING_PURCHASE = "android.contentPrice.purchase"
Value to be used with setPricingInformation 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.
CONTENT_PRICING_RENTAL
public static final String CONTENT_PRICING_RENTAL = "android.contentPrice.rental"
Value to be used with setPricingInformation 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.
CONTENT_PRICING_SUBSCRIPTION
public static final String CONTENT_PRICING_SUBSCRIPTION = "android.contentPrice.subscription"
Value to be used with setPricingInformation 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.
CONTENT_STATUS_AVAILABLE
public static final int CONTENT_STATUS_AVAILABLE = 2
Value to be used with setStatus 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.
CONTENT_STATUS_PENDING
public static final int CONTENT_STATUS_PENDING = 1
Value to be used with setStatus 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.
CONTENT_STATUS_READY
public static final int CONTENT_STATUS_READY = 0
Value to be used with setStatus to indicate that the content referred by the notification is available and ready to be consumed immediately.
CONTENT_STATUS_UNAVAILABLE
public static final int CONTENT_STATUS_UNAVAILABLE = 3
Value to be used with setStatus 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.
CONTENT_TYPE_APP
public static final String CONTENT_TYPE_APP = "android.contentType.app"
Value to be used with setContentTypes to indicate that the content referred by the notification item is an application.
CONTENT_TYPE_BOOK
public static final String CONTENT_TYPE_BOOK = "android.contentType.book"
Value to be used with setContentTypes to indicate that the content referred by the notification item is a book.
CONTENT_TYPE_COMIC
public static final String CONTENT_TYPE_COMIC = "android.contentType.comic"
Value to be used with setContentTypes to indicate that the content referred by the notification item is a comic book.
CONTENT_TYPE_GAME
public static final String CONTENT_TYPE_GAME = "android.contentType.game"
Value to be used with setContentTypes to indicate that the content referred by the notification item is a game.
CONTENT_TYPE_MAGAZINE
public static final String CONTENT_TYPE_MAGAZINE = "android.contentType.magazine"
Value to be used with setContentTypes to indicate that the content referred by the notification item is a magazine.
CONTENT_TYPE_MOVIE
public static final String CONTENT_TYPE_MOVIE = "android.contentType.movie"
Value to be used with setContentTypes to indicate that the content referred by the notification item is a movie.
CONTENT_TYPE_MUSIC
public static final String CONTENT_TYPE_MUSIC = "android.contentType.music"
Value to be used with setContentTypes to indicate that the content referred by the notification item is a song or album.
CONTENT_TYPE_NEWS
public static final String CONTENT_TYPE_NEWS = "android.contentType.news"
Value to be used with setContentTypes to indicate that the content referred by the notification item is a news item.
CONTENT_TYPE_PODCAST
public static final String CONTENT_TYPE_PODCAST = "android.contentType.podcast"
Value to be used with setContentTypes to indicate that the content referred by the notification item is a podcast.
CONTENT_TYPE_RADIO
public static final String CONTENT_TYPE_RADIO = "android.contentType.radio"
Value to be used with setContentTypes to indicate that the content referred by the notification item is a radio station.
CONTENT_TYPE_SERIAL
public static final String CONTENT_TYPE_SERIAL = "android.contentType.serial"
Value to be used with setContentTypes 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.
CONTENT_TYPE_SPORTS
public static final String CONTENT_TYPE_SPORTS = "android.contentType.sports"
Value to be used with setContentTypes to indicate that the content referred by the notification item is sports.
CONTENT_TYPE_TRAILER
public static final String CONTENT_TYPE_TRAILER = "android.contentType.trailer"
Value to be used with setContentTypes to indicate that the content referred by the notification item is a trailer.
CONTENT_TYPE_VIDEO
public static final String CONTENT_TYPE_VIDEO = "android.contentType.video"
Value to be used with setContentTypes to indicate that the content referred by the notification item is a video clip.
CONTENT_TYPE_WEBSITE
public static final String CONTENT_TYPE_WEBSITE = "android.contentType.website"
Value to be used with setContentTypes to indicate that the content referred by the notification item is a website.
INTENT_TYPE_ACTIVITY
public static final int INTENT_TYPE_ACTIVITY = 1
Value to be used with setContentIntentData and setDismissIntentData to indicate that a PendingIntent for an Activity should be created when posting the recommendation to the HomeScreen.
INTENT_TYPE_BROADCAST
public static final int INTENT_TYPE_BROADCAST = 2
Value to be used with setContentIntentData and setDismissIntentData to indicate that a PendingIntent for a Broadcast should be created when posting the recommendation to the HomeScreen.
INTENT_TYPE_SERVICE
public static final int INTENT_TYPE_SERVICE = 3
Value to be used with setContentIntentData and setDismissIntentData to indicate that a PendingIntent for a Service should be created when posting the recommendation to the HomeScreen.
Public methods
getBackgroundImageUri
public String getBackgroundImageUri()
Returns a Content URI that can be used to retrieve the background image for this recommendation.
| Returns | |
|---|---|
String |
A Content URI pointing to the recommendation background image. |
getBadgeImageResourceId
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 | |
|---|---|
int |
An integer id for the badge icon resource. |
getColor
public int getColor()
Returns the accent color value to be used in the UI when displaying this content recommendation to the user.
| Returns | |
|---|---|
int |
An integer value representing the accent color for this recommendation. |
getContentImage
public Bitmap getContentImage()
Returns the Bitmap containing the recommendation image.
| Returns | |
|---|---|
Bitmap |
A Bitmap containing the recommendation image. |
getContentIntent
public ContentRecommendation.IntentData getContentIntent()
Returns the data for the Intent that will be issued when the user clicks on the recommendation.
| Returns | |
|---|---|
ContentRecommendation.IntentData |
An IntentData object, containing the data for the Intent that gets issued when the recommendation is clicked on. |
getContentTypes
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 | |
|---|---|
String[] |
An array of predefined type tags (see the |
getDismissIntent
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 | |
|---|---|
ContentRecommendation.IntentData |
An IntentData object, containing the data for the Intent that gets issued when the recommendation is dismissed from the Home Screen. |
getGenres
public String[] getGenres()
Returns an array containing the genres that describe the content. Genres are open ended String tags.
| Returns | |
|---|---|
String[] |
An array of genre tags that describe the recommended content. |
getGroup
public String getGroup()
Returns the String group ID tag for this recommendation.
| Returns | |
|---|---|
String |
A String containing the group ID tag for this recommendation. |
getIdTag
public String getIdTag()
Returns the String Id tag which uniquely identifies this recommendation.
| Returns | |
|---|---|
String |
The String Id tag for this recommendation. |
getMaturityRating
public String getMaturityRating()
Returns the maturity level rating for the content.
| Returns | |
|---|---|
String |
returns a predefined tag indicating the maturity level rating for the content (see the |
getNotificationObject
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 context |
A |
| Returns | |
|---|---|
Notification |
A |
getPricingType
public String getPricingType()
Gets the pricing type for the content.
| Returns | |
|---|---|
String |
A predefined tag indicating the pricing type for the content (see the |
getPricingValue
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 | |
|---|---|
String |
A string containing a representation of the content price in the current locale and currency. |
getPrimaryContentType
public String getPrimaryContentType()
Returns the primary content type tag for the recommendation, or null if no content types have been specified.
| Returns | |
|---|---|
String |
A predefined type tag (see the |
getProgressMax
public int getProgressMax()
Returns the maximum value for the progress data of this recommendation.
| Returns | |
|---|---|
int |
An integer representing the maximum progress value. |
getProgressValue
public int getProgressValue()
Returns the progress amount for this recommendation.
| Returns | |
|---|---|
int |
An integer representing the recommendation progress amount. |
getRunningTime
public long getRunningTime()
Returns the running time for the content.
| Returns | |
|---|---|
long |
The run length, in seconds, of the content associated with the notification. |
getSortKey
public String getSortKey()
Returns the String sort key for this recommendation.
| Returns | |
|---|---|
String |
A String containing the sort key for this recommendation. |
getSourceName
public String getSourceName()
Returns the source application name for this recommendation.
| Returns | |
|---|---|
String |
A String containing the recommendation source name. |
getStatus
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 | |
|---|---|
int |
The status value for the content, or -1 is a valid status has not been specified (see the |
getText
public String getText()
Returns the description text for this recommendation.
| Returns | |
|---|---|
String |
A String containing the recommendation description text. |
getTitle
public String getTitle()
Returns the content title for this recommendation.
| Returns | |
|---|---|
String |
A String containing the recommendation content title. |
hasProgressInfo
public boolean hasProgressInfo()
Indicates if this recommendation contains valid progress information.
| Returns | |
|---|---|
boolean |
true if the recommendation contains valid progress data, false otherwise. |
isAutoDismiss
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 | |
|---|---|
boolean |
true if the recommendation is marked for auto dismissal, or false otherwise. |
setAutoDismiss
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 | |
|---|---|
boolean autoDismiss |
A boolean indicating if the recommendation should be auto dismissed or not. |
setGroup
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 | |
|---|---|
String groupTag |
A String containing the group ID tag for this recommendation. |
setProgress
public void setProgress(int max, int progress)
Sets the progress information for the content pointed to by this recommendation.
| Parameters | |
|---|---|
int max |
The maximum value for the progress of this content. |
int progress |
The progress amount for this content. Must be in the range (0 - max). |
setSortKey
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 | |
|---|---|
String sortKey |
A String containing the sort key for this recommendation. |
setStatus
public void setStatus(@ContentRecommendation.ContentStatus 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 | |
|---|---|
@ContentRecommendation.ContentStatus int status |
The status value for the content. (see the |