ContentRecommendation.Builder

public Builder()

Constructs a new Builder.

public ContentRecommendation build()

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

public 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.

public ContentRecommendation.Builder setBackgroundImageUri(@Nullable String imageUri)

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

public ContentRecommendation.Builder setBadgeIcon(@DrawableRes 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.

public ContentRecommendation.Builder setColor(@ColorInt int color)

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

public ContentRecommendation.Builder setContentImage(Bitmap image)

Sets the recommendation image.

public ContentRecommendation.Builder setContentIntentData(
    @ContentRecommendation.IntentType int intentType,
    Intent intent,
    int requestCode,
    @Nullable 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.

public 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.

public ContentRecommendation.Builder setDismissIntentData(
    @ContentRecommendation.IntentType int intentType,
    @Nullable Intent intent,
    int requestCode,
    @Nullable 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.

public 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.

public ContentRecommendation.Builder setGroup(@Nullable 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.

public ContentRecommendation.Builder setIdTag(String idTag)

Sets the Id tag that uniquely identifies this recommendation object.

public ContentRecommendation.Builder setMaturityRating(
    @ContentRecommendation.ContentMaturity String maturityRating
)

Sets the maturity level rating for the content.

public ContentRecommendation.Builder setPricingInformation(
    @ContentRecommendation.ContentPricing String priceType,
    @Nullable 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).

public ContentRecommendation.Builder setProgress(int max, int progress)

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

public ContentRecommendation.Builder setRunningTime(long length)

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

public ContentRecommendation.Builder setSortKey(@Nullable 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.

public ContentRecommendation.Builder setSourceName(@Nullable 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.

public ContentRecommendation.Builder setStatus(@ContentRecommendation.ContentStatus 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.

public ContentRecommendation.Builder setText(@Nullable String description)

Sets the description text for the recommendation.

public ContentRecommendation.Builder setTitle(String title)

Sets the content title for the recommendation.