belongs to Maven artifact androidx.tvprovider:tvprovider:1.0.0-alpha1

PreviewChannel.Builder

public static final class PreviewChannel.Builder
extends Object

java.lang.Object
   ↳ androidx.tvprovider.media.tv.PreviewChannel.Builder


This builder makes it easy to create a PreviewChannel object by allowing you to chain setters. Even though this builder provides a no-arg constructor, certain fields are required or the build() method will throw an exception. The required fields are displayName and appLinkIntentUri; use the respective methods to set them.

Summary

Public constructors

PreviewChannel.Builder()
PreviewChannel.Builder(PreviewChannel other)

Public methods

PreviewChannel build()

Takes the values of the Builder object and creates a PreviewChannel object.

PreviewChannel.Builder setAppLinkIntent(Intent appLinkIntent)

When user clicks on this channel's logo, the system will send an Intent for your app to open an Activity with contents relevant to this channel.

PreviewChannel.Builder setAppLinkIntentUri(Uri appLinkIntentUri)

When user clicks on this channel's logo, the system will send an Intent for your app to open an Activity with contents relevant to this channel.

PreviewChannel.Builder setDescription(CharSequence description)

It's good practice to include a general description of the programs in this channel.

PreviewChannel.Builder setDisplayName(CharSequence displayName)

This is the name user sees when your channel appears on their TV home screen.

PreviewChannel.Builder setInternalProviderData(byte[] internalProviderData)

This is one of the optional fields that your app may set.

PreviewChannel.Builder setInternalProviderFlag1(long flag)

This is one of the optional fields that your app may set.

PreviewChannel.Builder setInternalProviderFlag2(long flag)

This is one of the optional fields that your app may set.

PreviewChannel.Builder setInternalProviderFlag3(long flag)

This is one of the optional fields that your app may set.

PreviewChannel.Builder setInternalProviderFlag4(long flag)

This is one of the optional fields that your app may set.

PreviewChannel.Builder setInternalProviderId(String internalProviderId)

It is expected that your app or your server has its own internal representation (i.e.

PreviewChannel.Builder setLogo(Bitmap logoImage)

A logo visually identifies your channel.

PreviewChannel.Builder setLogo(Uri logoUri)

A logo visually identifies your channel.

Inherited methods

Public constructors

PreviewChannel.Builder

PreviewChannel.Builder ()

PreviewChannel.Builder

PreviewChannel.Builder (PreviewChannel other)

Parameters
other PreviewChannel

Public methods

build

PreviewChannel build ()

Takes the values of the Builder object and creates a PreviewChannel object.

Returns
PreviewChannel PreviewChannel object with values from the Builder.

setAppLinkIntent

PreviewChannel.Builder setAppLinkIntent (Intent appLinkIntent)

When user clicks on this channel's logo, the system will send an Intent for your app to open an Activity with contents relevant to this channel. Hence, the Intent data you provide here must point to content relevant to this channel.

Parameters
appLinkIntent Intent

Returns
PreviewChannel.Builder This Builder object to allow for chaining of calls to builder methods.

setAppLinkIntentUri

PreviewChannel.Builder setAppLinkIntentUri (Uri appLinkIntentUri)

When user clicks on this channel's logo, the system will send an Intent for your app to open an Activity with contents relevant to this channel. Hence, the Uri you provide here must point to content relevant to this channel.

Parameters
appLinkIntentUri Uri

Returns
PreviewChannel.Builder This Builder object to allow for chaining of calls to builder methods.

setDescription

PreviewChannel.Builder setDescription (CharSequence description)

It's good practice to include a general description of the programs in this channel.

Parameters
description CharSequence

Returns
PreviewChannel.Builder This Builder object to allow for chaining of calls to builder methods.

setDisplayName

PreviewChannel.Builder setDisplayName (CharSequence displayName)

This is the name user sees when your channel appears on their TV home screen. For example "New Arrivals." This field is required.

Parameters
displayName CharSequence

Returns
PreviewChannel.Builder This Builder object to allow for chaining of calls to builder methods.

setInternalProviderData

PreviewChannel.Builder setInternalProviderData (byte[] internalProviderData)

This is one of the optional fields that your app may set. Use these fields at your discretion to help you remember important information about this channel. For example, if this channel needs a byte array that is expensive for your app to construct, you may choose to save it here.

Parameters
internalProviderData byte

Returns
PreviewChannel.Builder This Builder object to allow for chaining of calls to builder methods.

setInternalProviderFlag1

PreviewChannel.Builder setInternalProviderFlag1 (long flag)

This is one of the optional fields that your app may set. Use these fields at your discretion to help you remember important information about this channel. For example, you may use this flag to track additional data about this particular channel.

Parameters
flag long

Returns
PreviewChannel.Builder This Builder object to allow for chaining of calls to builder methods.

setInternalProviderFlag2

PreviewChannel.Builder setInternalProviderFlag2 (long flag)

This is one of the optional fields that your app may set. Use these fields at your discretion to help you remember important information about this channel. For example, you may use this flag to track additional data about this particular channel.

Parameters
flag long

Returns
PreviewChannel.Builder This Builder object to allow for chaining of calls to builder methods.

setInternalProviderFlag3

PreviewChannel.Builder setInternalProviderFlag3 (long flag)

This is one of the optional fields that your app may set. Use these fields at your discretion to help you remember important information about this channel. For example, you may use this flag to track additional data about this particular channel.

Parameters
flag long

Returns
PreviewChannel.Builder This Builder object to allow for chaining of calls to builder methods.

setInternalProviderFlag4

PreviewChannel.Builder setInternalProviderFlag4 (long flag)

This is one of the optional fields that your app may set. Use these fields at your discretion to help you remember important information about this channel. For example, you may use this flag to track additional data about this particular channel.

Parameters
flag long

Returns
PreviewChannel.Builder This Builder object to allow for chaining of calls to builder methods.

setInternalProviderId

PreviewChannel.Builder setInternalProviderId (String internalProviderId)

It is expected that your app or your server has its own internal representation (i.e. data structure) of channels. It is highly recommended that you store your app/server's channel ID here; so that you may easily relate this published preview channel with the corresponding channel from your server. The publish method check this field to verify whether a preview channel being published would result in a duplicate. :

Parameters
internalProviderId String

Returns
PreviewChannel.Builder This Builder object to allow for chaining of calls to builder methods.

setLogo

PreviewChannel.Builder setLogo (Bitmap logoImage)

A logo visually identifies your channel. Hence, you should consider adding a unique logo to every channel you create, so user can quickly identify your channel.

Parameters
logoImage Bitmap

Returns
PreviewChannel.Builder This Builder object to allow for chaining of calls to builder methods.

setLogo

PreviewChannel.Builder setLogo (Uri logoUri)

A logo visually identifies your channel. Hence, you should consider adding a unique logo to every channel you create, so user can quickly identify your channel.

Parameters
logoUri Uri

Returns
PreviewChannel.Builder This Builder object to allow for chaining of calls to builder methods.