Skip to content

Most visited

Recently visited

navigation
added in version 24.1.0
belongs to Maven artifact com.android.support:recommendation:27.0.0

ContentRecommendation.Builder

public static final class ContentRecommendation.Builder
extends Object

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


Builder class for ContentRecommendation objects. Provides a convenient way to set the various fields of a ContentRecommendation.

Example:

 ContentRecommendation rec = new ContentRecommendation.Builder()
         .setIdInfo(id, "MyTagId")
         .setTitle("My Content Recommendation")
         .setText("An example of content recommendation")
         .setContentImage(myBitmap)
         .setBadgeIcon(R.drawable.app_icon)
         .setGroup("Trending")
         .build();
 

Summary

Public constructors

ContentRecommendation.Builder()

Constructs a new Builder.

Public methods

ContentRecommendation build()

Combine all of the options that have been set and return a new ContentRecommendation object.

ContentRecommendation.Builder setAutoDismiss(boolean autoDismiss)

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

ContentRecommendation.Builder setBackgroundImageUri(String imageUri)

Sets the Content URI that will be used to retrieve the background image for the recommendation.

ContentRecommendation.Builder setBadgeIcon(int iconResourceId)

Sets the resource ID for the recommendation badging icon.

ContentRecommendation.Builder setColor(int color)

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

ContentRecommendation.Builder setContentImage(Bitmap image)

Sets the recommendation image.

ContentRecommendation.Builder setContentIntentData(int intentType, Intent intent, int requestCode, Bundle options)

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

ContentRecommendation.Builder setContentTypes(String[] types)

Sets the content types associated with the content recommendation.

ContentRecommendation.Builder setDismissIntentData(int intentType, Intent intent, int requestCode, Bundle options)

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

ContentRecommendation.Builder setGenres(String[] genres)

Sets the content genres for the recommendation.

ContentRecommendation.Builder setGroup(String groupTag)

Sets the String group ID tag for the recommendation.

ContentRecommendation.Builder setIdTag(String idTag)

Sets the Id tag that uniquely identifies this recommendation object.

ContentRecommendation.Builder setMaturityRating(String maturityRating)

Sets the maturity level rating for the content.

ContentRecommendation.Builder setPricingInformation(String priceType, String priceValue)

Sets the pricing and availability information for the recommendation.

ContentRecommendation.Builder setProgress(int max, int progress)

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

ContentRecommendation.Builder setRunningTime(long length)

Sets the running time (when applicable) for the content.

ContentRecommendation.Builder setSortKey(String sortKey)

Sets the String sort key for the recommendation.

ContentRecommendation.Builder setSourceName(String source)

Sets the source application name for the recommendation.

ContentRecommendation.Builder setStatus(int contentStatus)

Sets the availability status for the content.

ContentRecommendation.Builder setText(String description)

Sets the description text for the recommendation.

ContentRecommendation.Builder setTitle(String title)

Sets the content title for the recommendation.

Inherited methods

From class java.lang.Object

Public constructors

ContentRecommendation.Builder

added in version 24.1.0
ContentRecommendation.Builder ()

Constructs a new Builder.

Public methods

build

added in version 24.1.0
ContentRecommendation build ()

Combine all of the options that have been set and return a new ContentRecommendation object.

Returns
ContentRecommendation

setAutoDismiss

added in version 24.1.0
ContentRecommendation.Builder setAutoDismiss (boolean autoDismiss)

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

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

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

Returns
ContentRecommendation.Builder The Builder object, for chaining.

setBackgroundImageUri

added in version 24.1.0
ContentRecommendation.Builder setBackgroundImageUri (String imageUri)

Sets the Content URI that will be used to retrieve the background image for the recommendation.

Parameters
imageUri String: A Content URI pointing to the recommendation background image.

Returns
ContentRecommendation.Builder The Builder object, for chaining.

setBadgeIcon

added in version 24.1.0
ContentRecommendation.Builder setBadgeIcon (int iconResourceId)

Sets the resource ID for the recommendation badging icon.

The resource id represents the icon resource in the source application package. If not set, or an invalid resource ID is specified, the application icon retrieved from its package will be used by default.

Parameters
iconResourceId int: An integer id for the badge icon resource.

Returns
ContentRecommendation.Builder The Builder object, for chaining.

setColor

added in version 24.1.0
ContentRecommendation.Builder setColor (int color)

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

Parameters
color int: An integer value representing the accent color for this recommendation.

Returns
ContentRecommendation.Builder The Builder object, for chaining.

setContentImage

added in version 24.1.0
ContentRecommendation.Builder setContentImage (Bitmap image)

Sets the recommendation image.

Parameters
image Bitmap: A Bitmap containing the recommendation image.

Returns
ContentRecommendation.Builder The Builder object, for chaining.

setContentIntentData

added in version 24.1.0
ContentRecommendation.Builder setContentIntentData (int intentType, 
                Intent intent, 
                int requestCode, 
                Bundle options)

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

The Intent data fields provided correspond to the fields passed into the PendingIntent factory methods, when creating a new PendingIntent. The actual PengindIntent object will only be created at the time a recommendation is posted to the Home Screen.

Parameters
intentType int: The type of PendingIntent to be created when posting this recommendation.

intent Intent: The Intent which to be issued when the recommendation is clicked on.

requestCode int: The private request code to be used when creating the PendingIntent

options Bundle: Only used for the Activity Intent type. Additional options for how the Activity should be started. May be null if there are no options.

Returns
ContentRecommendation.Builder The Builder object, for chaining.

setContentTypes

added in version 24.1.0
ContentRecommendation.Builder setContentTypes (String[] types)

Sets the content types associated with the content recommendation. The first tag entry will be considered the primary type for the content and will be used for ranking purposes. Other secondary type tags may be provided, if applicable, and may be used for filtering purposes.

Parameters
types String: Array of predefined type tags (see the CONTENT_TYPE_* constants) that describe the recommended content.

Returns
ContentRecommendation.Builder

setDismissIntentData

added in version 24.1.0
ContentRecommendation.Builder setDismissIntentData (int intentType, 
                Intent intent, 
                int requestCode, 
                Bundle options)

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

The Intent data fields provided correspond to the fields passed into the PendingIntent factory methods, when creating a new PendingIntent. The actual PengindIntent object will only be created at the time a recommendation is posted to the Home Screen.

Parameters
intentType int: The type of PendingIntent to be created when posting this recommendation.

intent Intent: The Intent which gets issued when the recommendation is dismissed from the Home Screen.

requestCode int: The private request code to be used when creating the PendingIntent

options Bundle: Only used for the Activity Intent type. Additional options for how the Activity should be started. May be null if there are no options.

Returns
ContentRecommendation.Builder The Builder object, for chaining.

setGenres

added in version 24.1.0
ContentRecommendation.Builder setGenres (String[] genres)

Sets the content genres for the recommendation. These genres may be used for content ranking. Genres are open ended String tags.

Some examples: "comedy", "action", "dance", "electronica", "racing", etc.

Parameters
genres String: Array of genre string tags that describe the recommended content.

Returns
ContentRecommendation.Builder

setGroup

added in version 24.1.0
ContentRecommendation.Builder setGroup (String groupTag)

Sets the String group ID tag for the 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 String: A String containing the group ID tag for this recommendation.

Returns
ContentRecommendation.Builder The Builder object, for chaining.

setIdTag

added in version 24.1.0
ContentRecommendation.Builder setIdTag (String idTag)

Sets the Id tag that uniquely identifies this recommendation object.

Parameters
idTag String: A String tag identifier for this recommendation.

Returns
ContentRecommendation.Builder The Builder object, for chaining.

setMaturityRating

added in version 24.1.0
ContentRecommendation.Builder setMaturityRating (String maturityRating)

Sets the maturity level rating for the content.

Parameters
maturityRating String: A tag indicating the maturity level rating for the content. This tag must be one of the predefined maturity rating tags (see the CONTENT_MATURITY_* constants).

Returns
ContentRecommendation.Builder

setPricingInformation

added in version 24.1.0
ContentRecommendation.Builder setPricingInformation (String priceType, 
                String priceValue)

Sets the pricing and availability information for the recommendation. The provided information will indicate the access model for the content (free, rental, purchase or subscription) and the price value (if not free).

Parameters
priceType String: Pricing type for this content. Must be one of the predefined pricing type tags (see the CONTENT_PRICING_* constants).

priceValue String: A string containing a representation of the content price in the current locale and currency.

Returns
ContentRecommendation.Builder

setProgress

added in version 24.1.0
ContentRecommendation.Builder setProgress (int max, 
                int progress)

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

Parameters
max int: The maximum value for the progress of this content.

progress int: The progress amount for this content. Must be in the range (0 - max).

Returns
ContentRecommendation.Builder The Builder object, for chaining.

setRunningTime

added in version 24.1.0
ContentRecommendation.Builder setRunningTime (long length)

Sets the running time (when applicable) for the content.

Parameters
length long: The running time, in seconds, of the content.

Returns
ContentRecommendation.Builder

setSortKey

added in version 24.1.0
ContentRecommendation.Builder setSortKey (String sortKey)

Sets the String sort key for the 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 String: A String containing the sort key for this recommendation.

Returns
ContentRecommendation.Builder The Builder object, for chaining.

setSourceName

added in version 24.1.0
ContentRecommendation.Builder setSourceName (String source)

Sets the source application name for the recommendation.

If the source name is never set, or set to null, the application name retrieved from its package will be used by default.

Parameters
source String: A String containing the recommendation source name.

Returns
ContentRecommendation.Builder The Builder object, for chaining.

setStatus

added in version 24.1.0
ContentRecommendation.Builder setStatus (int contentStatus)

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

Parameters
contentStatus int: The status value for this content. Must be one of the predefined content status values (see the CONTENT_STATUS_* constants).

Returns
ContentRecommendation.Builder

setText

added in version 24.1.0
ContentRecommendation.Builder setText (String description)

Sets the description text for the recommendation.

Parameters
description String: A String containing the recommendation description text.

Returns
ContentRecommendation.Builder The Builder object, for chaining.

setTitle

added in version 24.1.0
ContentRecommendation.Builder setTitle (String title)

Sets the content title for the recommendation.

Parameters
title String: A String containing the recommendation content title.

Returns
ContentRecommendation.Builder The Builder object, for chaining.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)