Package com.github.twitch4j.helix.domain

Class ChannelInformation.ChannelInformationBuilder

java.lang.Object

com.github.twitch4j.helix.domain.ChannelInformation.ChannelInformationBuilder

Enclosing class:

ChannelInformation

public static class ChannelInformation.ChannelInformationBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
ChannelInformation.ChannelInformationBuilder	broadcasterId(String broadcasterId)	Twitch User ID of this channel owner
ChannelInformation.ChannelInformationBuilder	broadcasterLanguage(String broadcasterLanguage)	Language of the channel
ChannelInformation.ChannelInformationBuilder	broadcasterLogin(String broadcasterLogin)	Twitch User Login Name of this channel owner
ChannelInformation.ChannelInformationBuilder	broadcasterName(String broadcasterName)	Twitch User Display Name of this channel owner
ChannelInformation	build()
ChannelInformation.ChannelInformationBuilder	clearContentClassificationLabels()
ChannelInformation.ChannelInformationBuilder	contentClassificationLabel(ContentClassificationState contentClassificationLabel)
ChannelInformation.ChannelInformationBuilder	contentClassificationLabels(Collection<? extends ContentClassificationState> contentClassificationLabels)
ChannelInformation.ChannelInformationBuilder	delay(@Nullable Integer delay)	Stream delay in seconds.
ChannelInformation.ChannelInformationBuilder	gameId(String gameId)	Current game ID being played on the channel
ChannelInformation.ChannelInformationBuilder	gameName(String gameName)	Current game name being played on the channel
ChannelInformation.ChannelInformationBuilder	isBrandedContent(Boolean isBrandedContent)	Whether the channel has branded content.
ChannelInformation.ChannelInformationBuilder	tags(List<String> tags)	A list of channel-defined tags to apply to the channel.
ChannelInformation.ChannelInformationBuilder	title(String title)	Title of the stream
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

broadcasterId

public ChannelInformation.ChannelInformationBuilder broadcasterId(String broadcasterId)

Twitch User ID of this channel owner

Returns:

this.

broadcasterLogin

public ChannelInformation.ChannelInformationBuilder broadcasterLogin(String broadcasterLogin)

Twitch User Login Name of this channel owner

Returns:

this.

broadcasterName

public ChannelInformation.ChannelInformationBuilder broadcasterName(String broadcasterName)

Twitch User Display Name of this channel owner

Returns:

this.

broadcasterLanguage

public ChannelInformation.ChannelInformationBuilder broadcasterLanguage(String broadcasterLanguage)

Language of the channel

A language value is either the ISO 639-1 two-letter code for a supported stream language or “other”

Returns:

this.

gameId

public ChannelInformation.ChannelInformationBuilder gameId(String gameId)

Current game ID being played on the channel

Returns:

this.

gameName

public ChannelInformation.ChannelInformationBuilder gameName(String gameName)

Current game name being played on the channel

Returns:

this.

title

public ChannelInformation.ChannelInformationBuilder title(String title)

Title of the stream

Returns:

this.

delay

public ChannelInformation.ChannelInformationBuilder delay(@Nullable
 @Nullable Integer delay)

Stream delay in seconds.

Stream delay is a Twitch Partner feature; trying to set this value for other account types will return a 400 error.

Note: this can only be returned if using the broadcaster's user access toke

Returns:

this.

tags

public ChannelInformation.ChannelInformationBuilder tags(List<String> tags)

A list of channel-defined tags to apply to the channel.

A channel may specify a maximum of 10 tags. Each tag is limited to a maximum of 25 characters and may not be an empty string or contain spaces or special characters. Tags are case-insensitive. For readability, consider using camelCasing or PascalCasing.

For TwitchHelix.updateChannelInformation(String, String, ChannelInformation), setting this to an empty list should result in all tags being removed from the channel.

Returns:

this.

contentClassificationLabel

public ChannelInformation.ChannelInformationBuilder contentClassificationLabel(ContentClassificationState contentClassificationLabel)

contentClassificationLabels

public ChannelInformation.ChannelInformationBuilder contentClassificationLabels(Collection<? extends ContentClassificationState> contentClassificationLabels)

clearContentClassificationLabels

public ChannelInformation.ChannelInformationBuilder clearContentClassificationLabels()

isBrandedContent

public ChannelInformation.ChannelInformationBuilder isBrandedContent(Boolean isBrandedContent)

Whether the channel has branded content.

Returns:

this.

build

public ChannelInformation build()

toString

public String toString()

Overrides:

toString in class Object