ContentRecommendation

const val CONTENT_MATURITY_ALL = "android.contentMaturity.all": String!

Value to be used with setMaturityRating to indicate that the content referred by the notification is suitable for all audiences.

const val CONTENT_MATURITY_HIGH = "android.contentMaturity.high": String!

Value to be used with setMaturityRating to indicate that the content referred by the notification is suitable for audiences of high maturity and above.

const val CONTENT_MATURITY_LOW = "android.contentMaturity.low": String!

Value to be used with setMaturityRating to indicate that the content referred by the notification is suitable for audiences of low maturity and above.

const val CONTENT_MATURITY_MEDIUM = "android.contentMaturity.medium": String!

Value to be used with setMaturityRating to indicate that the content referred by the notification is suitable for audiences of medium maturity and above.

const val CONTENT_PRICING_FREE = "android.contentPrice.free": String!

Value to be used with setPricingInformation to indicate that the content referred by the notification item is free to consume.

const val CONTENT_PRICING_PREORDER = "android.contentPrice.preorder": String!

Value to be used with setPricingInformation to indicate that the content referred by the notification item is available currently as a pre-order, and the price value provided is the purchase price for the item.

const val CONTENT_PRICING_PURCHASE = "android.contentPrice.purchase": String!

Value to be used with setPricingInformation to indicate that the content referred by the notification item is available for purchase, and the price value provided is the purchase price for the item.

const val CONTENT_PRICING_RENTAL = "android.contentPrice.rental": String!

Value to be used with setPricingInformation to indicate that the content referred by the notification item is available as a rental, and the price value provided is the rental price for the item.

const val CONTENT_PRICING_SUBSCRIPTION = "android.contentPrice.subscription": String!

Value to be used with setPricingInformation to indicate that the content referred by the notification item is available as part of a subscription based service, and the price value provided is the subscription price for the service.

const val CONTENT_STATUS_AVAILABLE = 2: Int

Value to be used with setStatus to indicate that the content referred by the notification is available, but needs to be first purchased, rented, subscribed or downloaded before it can be consumed.

const val CONTENT_STATUS_PENDING = 1: Int

Value to be used with setStatus to indicate that the content referred by the notification is pending, waiting on either a download or purchase operation to complete before it can be consumed.

const val CONTENT_STATUS_READY = 0: Int

Value to be used with setStatus to indicate that the content referred by the notification is available and ready to be consumed immediately.

const val CONTENT_STATUS_UNAVAILABLE = 3: Int

Value to be used with setStatus to indicate that the content referred by the notification is not available. This could be content not available in a certain region or incompatible with the device in use.

const val CONTENT_TYPE_APP = "android.contentType.app": String!

Value to be used with setContentTypes to indicate that the content referred by the notification item is an application.

const val CONTENT_TYPE_BOOK = "android.contentType.book": String!

Value to be used with setContentTypes to indicate that the content referred by the notification item is a book.

const val CONTENT_TYPE_COMIC = "android.contentType.comic": String!

Value to be used with setContentTypes to indicate that the content referred by the notification item is a comic book.

const val CONTENT_TYPE_GAME = "android.contentType.game": String!

Value to be used with setContentTypes to indicate that the content referred by the notification item is a game.

const val CONTENT_TYPE_MAGAZINE = "android.contentType.magazine": String!

Value to be used with setContentTypes to indicate that the content referred by the notification item is a magazine.

const val CONTENT_TYPE_MOVIE = "android.contentType.movie": String!

Value to be used with setContentTypes to indicate that the content referred by the notification item is a movie.

const val CONTENT_TYPE_MUSIC = "android.contentType.music": String!

Value to be used with setContentTypes to indicate that the content referred by the notification item is a song or album.

const val CONTENT_TYPE_NEWS = "android.contentType.news": String!

Value to be used with setContentTypes to indicate that the content referred by the notification item is a news item.

const val CONTENT_TYPE_PODCAST = "android.contentType.podcast": String!

Value to be used with setContentTypes to indicate that the content referred by the notification item is a podcast.

const val CONTENT_TYPE_RADIO = "android.contentType.radio": String!

Value to be used with setContentTypes to indicate that the content referred by the notification item is a radio station.

const val CONTENT_TYPE_SERIAL = "android.contentType.serial": String!

Value to be used with setContentTypes to indicate that the content referred by the notification item is serial. It can refer to an entire show, a single season or series, or a single episode.

const val CONTENT_TYPE_SPORTS = "android.contentType.sports": String!

Value to be used with setContentTypes to indicate that the content referred by the notification item is sports.

const val CONTENT_TYPE_TRAILER = "android.contentType.trailer": String!

Value to be used with setContentTypes to indicate that the content referred by the notification item is a trailer.

const val CONTENT_TYPE_VIDEO = "android.contentType.video": String!

Value to be used with setContentTypes to indicate that the content referred by the notification item is a video clip.

const val CONTENT_TYPE_WEBSITE = "android.contentType.website": String!

Value to be used with setContentTypes to indicate that the content referred by the notification item is a website.

const val INTENT_TYPE_ACTIVITY = 1: Int

Value to be used with setContentIntentData and setDismissIntentData to indicate that a PendingIntent for an Activity should be created when posting the recommendation to the HomeScreen.

const val INTENT_TYPE_BROADCAST = 2: Int

Value to be used with setContentIntentData and setDismissIntentData to indicate that a PendingIntent for a Broadcast should be created when posting the recommendation to the HomeScreen.

const val INTENT_TYPE_SERVICE = 3: Int

Value to be used with setContentIntentData and setDismissIntentData to indicate that a PendingIntent for a Service should be created when posting the recommendation to the HomeScreen.

fun getBackgroundImageUri(): String!

Returns a Content URI that can be used to retrieve the background image for this recommendation.

fun getBadgeImageResourceId(): Int

Returns the resource id for the recommendation badging icon.

The resource id represents the icon resource in the source application package.

fun getColor(): Int

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

fun getContentImage(): Bitmap!

Returns the Bitmap containing the recommendation image.

fun getContentIntent(): ContentRecommendation.IntentData!

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

fun getContentTypes(): Array<String!>!

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

fun getDismissIntent(): ContentRecommendation.IntentData!

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

fun getGenres(): Array<String!>!

Returns an array containing the genres that describe the content. Genres are open ended String tags.

fun getGroup(): String!

Returns the String group ID tag for this recommendation.

fun getIdTag(): String!

Returns the String Id tag which uniquely identifies this recommendation.

fun getMaturityRating(): String!

Returns the maturity level rating for the content.

fun getNotificationObject(context: Context!): Notification!

Returns a Notification object which contains the content recommendation data encapsulated by this object, which can be used for posting the recommendation via the NotificationManager.

fun getPricingType(): String!

Gets the pricing type for the content.

fun getPricingValue(): String!

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

fun getPrimaryContentType(): String!

Returns the primary content type tag for the recommendation, or null if no content types have been specified.

fun getProgressMax(): Int

Returns the maximum value for the progress data of this recommendation.

fun getProgressValue(): Int

Returns the progress amount for this recommendation.

fun getRunningTime(): Long

Returns the running time for the content.

fun getSortKey(): String!

Returns the String sort key for this recommendation.

fun getSourceName(): String!

Returns the source application name for this recommendation.

fun getStatus(): Int

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

fun getText(): String!

Returns the description text for this recommendation.

fun getTitle(): String!

Returns the content title for this recommendation.

fun hasProgressInfo(): Boolean

Indicates if this recommendation contains valid progress information.

fun isAutoDismiss(): Boolean

Indicates whether this recommendation should be dismissed automatically.

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

fun setAutoDismiss(autoDismiss: Boolean): Unit

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

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

fun setGroup(groupTag: String!): Unit

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

fun setProgress(max: Int, progress: Int): Unit

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

fun setSortKey(sortKey: String!): Unit

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

fun setStatus(@ContentRecommendation.ContentStatus status: Int): Unit

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