added in version 24.1.0
belongs to Maven artifact com.android.support:recommendation:28.0.0-alpha1
Summary: Ctors | Methods | Inherited Methods | [Expand All]

RecommendationExtender

public final class RecommendationExtender
extends Object implements Notification.Extender

java.lang.Object
   ↳ android.support.app.recommendation.RecommendationExtender

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

  1. Create an Notification.CarExtender.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

RecommendationExtender()

Create a RecommendationExtender with default options.

RecommendationExtender(Notification notif)

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

Public methods

Notification.Builder extend(Notification.Builder builder)

Apply content extensions to a notification that is being built.

String[] getContentTypes()

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

String[] getGenres()

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

String getMaturityRating()

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

String getPricingType()

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

String getPricingValue()

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

String getPrimaryContentType()

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

long getRunningTime()

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

int getStatus()

Returns status value for the content associated with the notification.

RecommendationExtender setContentTypes(String[] types)

Sets the content types associated with the notification content.

RecommendationExtender setGenres(String[] genres)

Sets the content genres associated with the notification content.

RecommendationExtender setMaturityRating(String maturityRating)

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

RecommendationExtender setPricingInformation(String priceType, String priceValue)

Sets the pricing and availability information for the content associated with the notification.

RecommendationExtender setRunningTime(long length)

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

RecommendationExtender setStatus(int contentStatus)

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

Inherited methods

From class java.lang.Object
From interface android.app.Notification.Extender

Public constructors

RecommendationExtender

added in version 24.1.0
RecommendationExtender ()

Create a RecommendationExtender with default options.

RecommendationExtender

added in version 24.1.0
RecommendationExtender (Notification notif)

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

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

Public methods

extend

added in version 24.1.0
Notification.Builder extend (Notification.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.CarExtender.Builder.

Parameters
builder Notification.Builder

Returns
Notification.Builder

getContentTypes

added in version 24.1.0
String[] getContentTypes ()

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.

Returns
String[] An array of predefined type tags (see the CONTENT_TYPE_* constants) that describe the content associated with the notification.

getGenres

added in version 24.1.0
String[] getGenres ()

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

Returns
String[] An array of genre tags that describe the content associated with the notification.

getMaturityRating

added in version 24.1.0
String getMaturityRating ()

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

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

getPricingType

added in version 24.1.0
String getPricingType ()

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

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

getPricingValue

added in version 24.1.0
String getPricingValue ()

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.

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

getPrimaryContentType

added in version 24.1.0
String getPrimaryContentType ()

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

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

getRunningTime

added in version 24.1.0
long getRunningTime ()

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

Returns
long The running time, in seconds, of the content associated with the notification.

getStatus

added in version 24.1.0
int getStatus ()

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.

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

See also:

setContentTypes

added in version 24.1.0
RecommendationExtender setContentTypes (String[] types)

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

Returns
RecommendationExtender

setGenres

added in version 24.1.0
RecommendationExtender setGenres (String[] genres)

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 String: Array of genre string tags that describe the content referred to by a notification.

Returns
RecommendationExtender

setMaturityRating

added in version 24.1.0
RecommendationExtender setMaturityRating (String maturityRating)

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

Returns
RecommendationExtender

setPricingInformation

added in version 24.1.0
RecommendationExtender setPricingInformation (String priceType, 
                String priceValue)

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.
Returns
RecommendationExtender This object for method chaining.

setRunningTime

added in version 24.1.0
RecommendationExtender setRunningTime (long length)

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.

Returns
RecommendationExtender

setStatus

added in version 24.1.0
RecommendationExtender setStatus (int contentStatus)

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

Returns
RecommendationExtender