PreviewChannel
public 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 |
|---|
public final class PreviewChannel.BuilderThis builder makes it easy to create a PreviewChannel object by allowing you to chain setters. |
Public methods |
|
|---|---|
boolean |
|
static @Nullable PreviewChannel |
fromCursor(Cursor cursor)Used by |
Intent |
|
Uri |
|
CharSequence |
|
CharSequence |
|
long |
getId() |
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(PreviewChannel update)Indicates whether some other PreviewChannel has any set attribute that is different from this PreviewChannel's respective attributes. |
int |
hashCode() |
boolean |
|
String |
toString() |
Public methods
fromCursor
public static @Nullable PreviewChannel fromCursor(Cursor cursor)
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 | |
|---|---|
@Nullable PreviewChannel |
a PreviewChannel whose values come from the cursor row or |
getAppLinkIntent
public Intent getAppLinkIntent()
| Returns | |
|---|---|
Intent |
The value of |
| Throws | |
|---|---|
java.net.URISyntaxException |
getAppLinkIntentUri
public Uri getAppLinkIntentUri()
| Returns | |
|---|---|
Uri |
The value of |
getDescription
public CharSequence getDescription()
| Returns | |
|---|---|
CharSequence |
The value of |
getDisplayName
public CharSequence getDisplayName()
| Returns | |
|---|---|
CharSequence |
The name users see when this channel appears on the home screen |
getId
public long getId()
| Returns | |
|---|---|
long |
the ID the system assigns to this preview channel upon publication. |
getInternalProviderDataByteArray
public byte[] getInternalProviderDataByteArray()
| Returns | |
|---|---|
byte[] |
The value of |
getInternalProviderFlag1
public Long getInternalProviderFlag1()
| Returns | |
|---|---|
Long |
The value of |
getInternalProviderFlag2
public Long getInternalProviderFlag2()
| Returns | |
|---|---|
Long |
The value of |
getInternalProviderFlag3
public Long getInternalProviderFlag3()
| Returns | |
|---|---|
Long |
The value of |
getInternalProviderFlag4
public Long getInternalProviderFlag4()
| Returns | |
|---|---|
Long |
The value of |
getInternalProviderId
public String getInternalProviderId()
| Returns | |
|---|---|
String |
The value of |
getLogo
@WorkerThread
public Bitmap getLogo(Context context)
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
public String getPackageName()
| Returns | |
|---|---|
String |
package name of the app that created this channel |
getType
public String getType()
| Returns | |
|---|---|
String |
what type of channel this is. For preview channels, the type is always TvContractCompat.Channels.TYPE_PREVIEW |
hasAnyUpdatedValues
public boolean hasAnyUpdatedValues(PreviewChannel update)
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
public boolean isBrowsable()
| Returns | |
|---|---|
boolean |
The value of |