Summary: Ctors | Methods | Inherited Methods

Channel.Builder

Kotlin |Java

public static final class Channel.Builder
extends Object

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

The builder class that makes it easy to chain setters to create a Channel object.

Summary

Public constructors
`Builder()`
`Builder(Channel other)`

Public methods
`Channel`	`build()` Takes the values of the Builder object and creates a Channel object.
`Channel.Builder`	`setAppLinkColor(int appLinkColor)` Sets the background color of the App Linking card.
`Channel.Builder`	`setAppLinkIconUri(Uri appLinkIconUri)` Sets the icon to be displayed next to the text of the App Linking card.
`Channel.Builder`	`setAppLinkIntent(Intent appLinkIntent)` Sets the App Linking Intent.
`Channel.Builder`	`setAppLinkIntentUri(Uri appLinkIntentUri)` Sets the App Linking Intent.
`Channel.Builder`	`setAppLinkPosterArtUri(Uri appLinkPosterArtUri)` Sets the background image of the App Linking card.
`Channel.Builder`	`setAppLinkText(String appLinkText)` Sets the text to be displayed in the App Linking card.
`Channel.Builder`	`setConfigurationDisplayOrder(int value)` Sets the configuration display order for this channel.
`Channel.Builder`	`setDescription(String description)` Sets the description of the Channel.
`Channel.Builder`	`setDisplayName(String displayName)` Sets the name to be displayed for the Channel.
`Channel.Builder`	`setDisplayNumber(String displayNumber)` Sets the display number of the Channel.
`Channel.Builder`	`setGlobalContentId(String value)` Sets the global content ID for this channel.
`Channel.Builder`	`setInputId(String inputId)` Sets the input id of the Channel.
`Channel.Builder`	`setInternalProviderData(byte[] internalProviderData)` Sets the internal provider data of the channel.
`Channel.Builder`	`setInternalProviderData(String internalProviderData)` Sets the internal provider data of the channel.
`Channel.Builder`	`setInternalProviderFlag1(long flag)` Sets the internal provider flag1 for the channel.
`Channel.Builder`	`setInternalProviderFlag2(long flag)` Sets the internal provider flag2 for the channel.
`Channel.Builder`	`setInternalProviderFlag3(long flag)` Sets the internal provider flag3 for the channel.
`Channel.Builder`	`setInternalProviderFlag4(long flag)` Sets the internal provider flag4 for the channel.
`Channel.Builder`	`setInternalProviderId(String internalProviderId)` Sets the internal provider ID for the channel.
`Channel.Builder`	`setNetworkAffiliation(String networkAffiliation)` Sets the network name for the channel, which may be different from its display name.
`Channel.Builder`	`setOriginalNetworkId(int originalNetworkId)` Sets the original network id of the Channel.
`Channel.Builder`	`setSearchable(boolean searchable)` Sets whether this channel can be searched for in other applications.
`Channel.Builder`	`setServiceId(int serviceId)` Sets the service id of the Channel.
`Channel.Builder`	`setServiceType(String serviceType)` Sets the type of content that will appear on this channel.
`Channel.Builder`	`setSystemChannelKey(String value)` Sets the system channel key for this channel.
`Channel.Builder`	`setTransient(boolean value)` Sets whether this channel is transient or not.
`Channel.Builder`	`setTransportStreamId(int transportStreamId)` Sets the transport stream id of the Channel.
`Channel.Builder`	`setType(String type)` Sets the broadcast standard of the Channel.
`Channel.Builder`	`setVideoFormat(String videoFormat)` Sets the video format of the Channel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public constructors

Builder

public Builder ()

Builder

public Builder (Channel other)

Parameters
`other`	`Channel`

Public methods

build

public Channel build ()

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

Returns
`Channel`	Channel object with values from the Builder.

setAppLinkColor

public Channel.Builder setAppLinkColor (int appLinkColor)

Sets the background color of the App Linking card.

Parameters
`appLinkColor`	`int`: The value of `TvContractCompat.Channels.COLUMN_APP_LINK_COLOR` for the channel.

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

setAppLinkIconUri

public Channel.Builder setAppLinkIconUri (Uri appLinkIconUri)

Sets the icon to be displayed next to the text of the App Linking card.

Parameters
`appLinkIconUri`	`Uri`: The value of `TvContractCompat.Channels.COLUMN_APP_LINK_ICON_URI` for the channel.

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

setAppLinkIntent

public Channel.Builder setAppLinkIntent (Intent appLinkIntent)

Sets the App Linking Intent.

Parameters
`appLinkIntent`	`Intent`: The Intent to be executed when the App Linking card is selected

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

setAppLinkIntentUri

public Channel.Builder setAppLinkIntentUri (Uri appLinkIntentUri)

Sets the App Linking Intent.

Parameters
`appLinkIntentUri`	`Uri`: The Intent that should be executed when the App Linking card is selected. Use the method toUri(Intent.URI_INTENT_SCHEME) on your Intent to turn it into a String. See `TvContractCompat.Channels.COLUMN_APP_LINK_INTENT_URI`.

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

setAppLinkPosterArtUri

public Channel.Builder setAppLinkPosterArtUri (Uri appLinkPosterArtUri)

Sets the background image of the App Linking card.

Parameters
`appLinkPosterArtUri`	`Uri`: The value of `TvContractCompat.Channels.COLUMN_APP_LINK_POSTER_ART_URI` for the channel.

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

setAppLinkText

public Channel.Builder setAppLinkText (String appLinkText)

Sets the text to be displayed in the App Linking card.

Parameters
`appLinkText`	`String`: The value of `TvContractCompat.Channels.COLUMN_APP_LINK_TEXT` for the channel.

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

setConfigurationDisplayOrder

public Channel.Builder setConfigurationDisplayOrder (int value)

Sets the configuration display order for this channel. This value will be used to order channels within the configure channels menu.

Parameters
`value`	`int`: The value of `TvContractCompat.Channels.COLUMN_CONFIGURATION_DISPLAY_ORDER` for the channel

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

setDescription

public Channel.Builder setDescription (String description)

Sets the description of the Channel.

Parameters
`description`	`String`: The value of `TvContractCompat.Channels.COLUMN_DESCRIPTION` for the channel.

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

setDisplayName

public Channel.Builder setDisplayName (String displayName)

Sets the name to be displayed for the Channel.

Parameters
`displayName`	`String`: The value of `TvContractCompat.Channels.COLUMN_DISPLAY_NAME` for the channel.

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

setDisplayNumber

public Channel.Builder setDisplayNumber (String displayNumber)

Sets the display number of the Channel.

Parameters
`displayNumber`	`String`: The value of `TvContractCompat.Channels.COLUMN_DISPLAY_NUMBER` for the channel.

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

setGlobalContentId

public Channel.Builder setGlobalContentId (String value)

Sets the global content ID for this channel.

Parameters
`value`	`String`: The value of `TvContractCompat.Channels.COLUMN_GLOBAL_CONTENT_ID` for the channel.

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

setInputId

public Channel.Builder setInputId (String inputId)

Sets the input id of the Channel.

Parameters
`inputId`	`String`: The value of `TvContractCompat.Channels.COLUMN_INPUT_ID` for the channel.

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

setInternalProviderData

public Channel.Builder setInternalProviderData (byte[] internalProviderData)

Sets the internal provider data of the channel.

Parameters
`internalProviderData`	`byte`: The value of `TvContractCompat.Channels.COLUMN_INTERNAL_PROVIDER_DATA` for the channel.

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

setInternalProviderData

public Channel.Builder setInternalProviderData (String internalProviderData)

Sets the internal provider data of the channel.

Parameters
`internalProviderData`	`String`: The value of `TvContractCompat.Channels.COLUMN_INTERNAL_PROVIDER_DATA` for the channel.

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

setInternalProviderFlag1

public Channel.Builder setInternalProviderFlag1 (long flag)

Sets the internal provider flag1 for the channel.

Parameters
`flag`	`long`: The value of `TvContractCompat.Channels.COLUMN_INTERNAL_PROVIDER_FLAG1` for the program.

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

setInternalProviderFlag2

public Channel.Builder setInternalProviderFlag2 (long flag)

Sets the internal provider flag2 for the channel.

Parameters
`flag`	`long`: The value of `TvContractCompat.Channels.COLUMN_INTERNAL_PROVIDER_FLAG2` for the program.

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

setInternalProviderFlag3

public Channel.Builder setInternalProviderFlag3 (long flag)

Sets the internal provider flag3 for the channel.

Parameters
`flag`	`long`: The value of `TvContractCompat.Channels.COLUMN_INTERNAL_PROVIDER_FLAG3` for the program.

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

setInternalProviderFlag4

public Channel.Builder setInternalProviderFlag4 (long flag)

Sets the internal provider flag4 for the channel.

Parameters
`flag`	`long`: The value of `TvContractCompat.Channels.COLUMN_INTERNAL_PROVIDER_FLAG4` for the program.

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

setInternalProviderId

public Channel.Builder setInternalProviderId (String internalProviderId)

Sets the internal provider ID for the channel.

Parameters
`internalProviderId`	`String`: The value of `TvContractCompat.Channels.COLUMN_INTERNAL_PROVIDER_ID` for the program.

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

setNetworkAffiliation

public Channel.Builder setNetworkAffiliation (String networkAffiliation)

Sets the network name for the channel, which may be different from its display name.

Parameters
`networkAffiliation`	`String`: The value of `TvContractCompat.Channels.COLUMN_NETWORK_AFFILIATION` for the channel.

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

setOriginalNetworkId

public Channel.Builder setOriginalNetworkId (int originalNetworkId)

Sets the original network id of the Channel.

Parameters
`originalNetworkId`	`int`: The value of `TvContractCompat.Channels.COLUMN_ORIGINAL_NETWORK_ID` for the channel.

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

setSearchable

public Channel.Builder setSearchable (boolean searchable)

Sets whether this channel can be searched for in other applications.

Parameters
`searchable`	`boolean`: The value of `TvContractCompat.Channels.COLUMN_SEARCHABLE` for the channel.

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

setServiceId

public Channel.Builder setServiceId (int serviceId)

Sets the service id of the Channel.

Parameters
`serviceId`	`int`: The value of `TvContractCompat.Channels.COLUMN_SERVICE_ID` for the channel.

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

setServiceType

public Channel.Builder setServiceType (String serviceType)

Sets the type of content that will appear on this channel. This could refer to the underlying broadcast standard or refer to TvContractCompat.Channels.SERVICE_TYPE_AUDIO, TvContractCompat.Channels.SERVICE_TYPE_AUDIO_VIDEO, or TvContractCompat.Channels.SERVICE_TYPE_OTHER.

Parameters
`serviceType`	`String`: The value of `TvContractCompat.Channels.COLUMN_SERVICE_TYPE` for the channel.

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

setSystemChannelKey

public Channel.Builder setSystemChannelKey (String value)

Sets the system channel key for this channel. This identifier helps OEM differentiate among the app's channels. This identifier should be unique per channel for each app, and should be agreed between the app and the OEM. It is up to the OEM on how they use this identifier for customization purposes.

Parameters
`value`	`String`: The value of `TvContractCompat.Channels.COLUMN_SYSTEM_CHANNEL_KEY` for the channel.

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

setTransient

public Channel.Builder setTransient (boolean value)

Sets whether this channel is transient or not.

Parameters
`value`	`boolean`: The value of `TvContractCompat.Channels.COLUMN_TRANSIENT` for the channel.

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

setTransportStreamId

public Channel.Builder setTransportStreamId (int transportStreamId)

Sets the transport stream id of the Channel.

Parameters
`transportStreamId`	`int`: The value of `TvContractCompat.Channels.COLUMN_TRANSPORT_STREAM_ID` for the channel.

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

setType

public Channel.Builder setType (String type)

Sets the broadcast standard of the Channel.

Parameters
`type`	`String`: The value of `TvContractCompat.Channels.COLUMN_TYPE` for the channel.

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

setVideoFormat

public Channel.Builder setVideoFormat (String videoFormat)

Sets the video format of the Channel.

Parameters
`videoFormat`	`String`: The value of `TvContractCompat.Channels.COLUMN_VIDEO_FORMAT` for the channel.

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