PreviewChannel
class PreviewChannel
Since API 26, all TV apps may create preview channels and publish them to the home screen. We call these App Channels (as distinct from the Live Channels row on the home screen). To help you create App Channels, the support library provides a number of classes prefixed by the word Preview-. This is a convenience class for mapping your app's content into a TvProvider Channel for publication. Use the provided Builder for creating your preview channel object. Once you create a preview channel, you can use PreviewChannelHelper to publish it and add programs to it.
Summary
Nested types |
|---|
class PreviewChannel.BuilderThis builder makes it easy to create a PreviewChannel object by allowing you to chain setters. |
Public functions |
|
|---|---|
Boolean |
|
java-static PreviewChannel? |
fromCursor(cursor: Cursor!)Used by |
Intent! |
|
Uri! |
|
CharSequence! |
|
CharSequence! |
|
Long |
getId() |
ByteArray<Byte>! |
|
Long! |
|
Long! |
|
Long! |
|
Long! |
|
String! |
|
Bitmap! |
@WorkerThreadThis method should be called on a worker thread since decoding Bitmap is an expensive operation and therefore should not be performed on the main thread. |
String! |
|
String! |
getType() |
Boolean |
hasAnyUpdatedValues(update: PreviewChannel!)Indicates whether some other PreviewChannel has any set attribute that is different from this PreviewChannel's respective attributes. |
Int |
hashCode() |
Boolean |
|
String! |
toString() |
Public functions
fromCursor
java-static fun fromCursor(cursor: Cursor!): PreviewChannel?
Used by PreviewChannelHelper to transduce a TvProvider channel row into a PreviewChannel Java object. You never need to use this method unless you want to convert database rows to PreviewChannel objects yourself.
.PreviewChannel.Columns#PROJECTION. This way, all indices are known beforehand.
| Parameters | |
|---|---|
cursor: Cursor! |
a cursor row from the TvProvider |
| Returns | |
|---|---|
PreviewChannel? |
a PreviewChannel whose values come from the cursor row or |
getAppLinkIntent
fun getAppLinkIntent(): Intent!
| Returns | |
|---|---|
Intent! |
The value of |
| Throws | |
|---|---|
java.net.URISyntaxException |
getAppLinkIntentUri
fun getAppLinkIntentUri(): Uri!
| Returns | |
|---|---|
Uri! |
The value of |
getDescription
fun getDescription(): CharSequence!
| Returns | |
|---|---|
CharSequence! |
The value of |
getDisplayName
fun getDisplayName(): CharSequence!
| Returns | |
|---|---|
CharSequence! |
The name users see when this channel appears on the home screen |
getId
fun getId(): Long
| Returns | |
|---|---|
Long |
the ID the system assigns to this preview channel upon publication. |
getInternalProviderDataByteArray
fun getInternalProviderDataByteArray(): ByteArray<Byte>!
| Returns | |
|---|---|
ByteArray<Byte>! |
The value of |
getInternalProviderFlag1
fun getInternalProviderFlag1(): Long!
| Returns | |
|---|---|
Long! |
The value of |
getInternalProviderFlag2
fun getInternalProviderFlag2(): Long!
| Returns | |
|---|---|
Long! |
The value of |
getInternalProviderFlag3
fun getInternalProviderFlag3(): Long!
| Returns | |
|---|---|
Long! |
The value of |
getInternalProviderFlag4
fun getInternalProviderFlag4(): Long!
| Returns | |
|---|---|
Long! |
The value of |
getInternalProviderId
fun getInternalProviderId(): String!
| Returns | |
|---|---|
String! |
The value of |
getLogo
@WorkerThread
fun getLogo(context: Context!): Bitmap!
This method should be called on a worker thread since decoding Bitmap is an expensive operation and therefore should not be performed on the main thread.
| Returns | |
|---|---|
Bitmap! |
The logo associated with this preview channel |
getPackageName
fun getPackageName(): String!
| Returns | |
|---|---|
String! |
package name of the app that created this channel |
getType
fun getType(): String!
| Returns | |
|---|---|
String! |
what type of channel this is. For preview channels, the type is always TvContractCompat.Channels.TYPE_PREVIEW |
hasAnyUpdatedValues
fun hasAnyUpdatedValues(update: PreviewChannel!): Boolean
Indicates whether some other PreviewChannel has any set attribute that is different from this PreviewChannel's respective attributes. An attribute is considered "set" if its key is present in the ContentValues vector.
isBrowsable
fun isBrowsable(): Boolean
| Returns | |
|---|---|
Boolean |
The value of |