Platform Android Studio Google Play Android Jetpack Docs News
Overview Guides Reference Samples Design & Quality
Save the date! Android Dev Summit is coming to Sunnyvale, CA on Oct 23-24, 2019.

RecommendationExtender

class RecommendationExtender : Extender
kotlin.Any
   ↳ androidx.recommendation.app.RecommendationExtender

Helper class to add content info extensions to notifications. To create a notification with content info extensions:

  1. Create an Notification.Builder, setting any desired properties.
  2. Create a RecommendationExtender.
  3. Set content info specific properties using the add and set methods of RecommendationExtender.
  4. Call Notification.Builder.extend(Notification.Extender) to apply the extensions to a notification. 
Notification notification = new Notification.Builder(context) * ... * .extend(new RecommendationExtender() * .set*(...)) * .build(); *

Content info extensions can be accessed on an existing notification by using the RecommendationExtender(Notification) constructor, and then using the get methods to access values.

Summary

Public constructors

Create a RecommendationExtender with default options.

Create a RecommendationExtender from the RecommendationExtender options of an existing Notification.
Public methods
Int

Returns status value for the content associated with the notification.
RecommendationExtender!

Sets the content types associated with the notification content.
RecommendationExtender!
setStatus(contentStatus: Int)

Sets the availability status for the content associated with the notification.
RecommendationExtender!

Sets the running time (when applicable) for the content associated with the notification.
RecommendationExtender!
setPricingInformation(priceType: String!, priceValue: String!)

Sets the pricing and availability information for the content associated with the notification.
Builder!
extend(builder: Builder!)

Apply content extensions to a notification that is being built.
String!

Gets the pricing type for the content associated with the notification.
Array<String!>!

Returns an array containing the content types that describe the content associated with the notification.
String!

Returns the primary content type tag for the content associated with the notification.
Long

Returns the running time for the content associated with the notification.
RecommendationExtender!
setMaturityRating(maturityRating: String!)

Sets the maturity level rating for the content associated with the notification.
Array<String!>!

Returns an array containing the content genres that describe the content associated with the notification.
RecommendationExtender!
setGenres(genres: Array<String!>!)

Sets the content genres associated with the notification content.
String!

Returns the maturity level rating for the content associated with the notification.
String!

Gets the price value (when applicable) for the content associated with a notification.

Public constructors

<init>

RecommendationExtender()

Create a RecommendationExtender with default options.

<init>

RecommendationExtender(notif: Notification!)

Create a RecommendationExtender from the RecommendationExtender options of an existing Notification.

Parameters
notif Notification!: The notification from which to copy options.

Public methods

getStatus

fun getStatus(): Int

Returns status value for the content associated with the notification. 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.

Return
Int: The status value for this content, or -1 is a valid status has not been specified (see the CONTENT_STATUS_* for the defined valid status values).

setContentTypes

fun setContentTypes(types: Array<String!>!): RecommendationExtender!

Sets the content types associated with the notification content. 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 Array<String!>!: Array of predefined type tags (see the CONTENT_TYPE_* constants) that describe the content referred to by a notification.

setStatus

fun setStatus(contentStatus: Int): RecommendationExtender!

Sets the availability status for the content associated with the notification. 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).

setRunningTime

fun setRunningTime(length: Long): RecommendationExtender!

Sets the running time (when applicable) for the content associated with the notification.

Parameters
length Long: The runing time, in seconds, of the content associated with the notification.

setPricingInformation

fun setPricingInformation(priceType: String!, priceValue: String!): RecommendationExtender!

Sets the pricing and availability information for the content associated with the notification. 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.
Return
RecommendationExtender!: This object for method chaining.

extend

fun extend(builder: Builder!): Builder!

Apply content extensions to a notification that is being built. This is typically called by the Notification.Builder.extend(Notification.Extender) method of Notification.Builder.

getPricingType

fun getPricingType(): String!

Gets the pricing type for the content associated with the notification.

Return
String!: A predefined tag indicating the pricing type for the content (see the CONTENT_PRICING_* constants).

getContentTypes

fun getContentTypes(): Array<String!>!

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

Return
Array<String!>!: An array of predefined type tags (see the CONTENT_TYPE_* constants) that describe the content associated with the notification.

getPrimaryContentType

fun getPrimaryContentType(): String!

Returns the primary content type tag for the content associated with the notification.

Return
String!: A predefined type tag (see the CONTENT_TYPE_* constants) indicating the primary type for the content associated with the notification.

getRunningTime

fun getRunningTime(): Long

Returns the running time for the content associated with the notification.

Return
Long: The running time, in seconds, of the content associated with the notification.

setMaturityRating

fun setMaturityRating(maturityRating: String!): RecommendationExtender!

Sets the maturity level rating for the content associated with the notification.

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

getGenres

fun getGenres(): Array<String!>!

Returns an array containing the content genres that describe the content associated with the notification.

Return
Array<String!>!: An array of genre tags that describe the content associated with the notification.

setGenres

fun setGenres(genres: Array<String!>!): RecommendationExtender!

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

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

Parameters
genres Array<String!>!: Array of genre string tags that describe the content referred to by a notification.

getMaturityRating

fun getMaturityRating(): String!

Returns the maturity level rating for the content associated with the notification.

Return
String!: returns a predefined tag indicating the maturity level rating for the content (see the CONTENT_MATURITY_* constants).

getPricingValue

fun getPricingValue(): String!

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

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