Android 12 Developer Preview is here! Try it out, and give us your feedback!

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
Builder!
extend(builder: Builder!)

Apply content extensions to a notification that is being built.

Array<String!>!

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

Array<String!>!

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

String!

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

String!

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

String!

Gets the price value (when applicable) for the content associated with a 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.

Int

Returns status value for the content associated with the notification.

RecommendationExtender!

Sets the content types associated with the notification content.

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

Sets the content genres associated with the notification content.

RecommendationExtender!
setMaturityRating(maturityRating: String!)

Sets the maturity level rating 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.

RecommendationExtender!

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

RecommendationExtender!
setStatus(contentStatus: Int)

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

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.

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.

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.

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

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