SearchedChannel

@Serializable
data class SearchedChannel(val broadcasterLanguage: String, val broadcasterLogin: String, val displayName: String, val gameId: String, val gameName: String, val id: String, val isLive: Boolean, val title: String, val startedAt: Instant? = null, val thumbnailUrl: String, val tags: List<String>? = null)

Represents a channel result from the Twitch Helix Search API.

See also

Constructors

Link copied to clipboard
constructor(broadcasterLanguage: String, broadcasterLogin: String, displayName: String, gameId: String, gameName: String, id: String, isLive: Boolean, title: String, startedAt: Instant? = null, thumbnailUrl: String, tags: List<String>? = null)

Properties

Link copied to clipboard
@SerialName(value = "broadcaster_language")
val broadcasterLanguage: String

the ISO 639-1 two-letter language code of the language used by the broadcaster. For example, en for English. If the broadcaster uses a language not in the list of supported stream languages, the value is other.

Link copied to clipboard
@SerialName(value = "broadcaster_login")
val broadcasterLogin: String

the broadcaster's login name.

Link copied to clipboard
@SerialName(value = "display_name")
val displayName: String

the broadcaster's display name.

Link copied to clipboard
@SerialName(value = "game_id")
val gameId: String

the ID of the game that the broadcaster is playing or last played.

Link copied to clipboard
@SerialName(value = "game_name")
val gameName: String

the name of the game that the broadcaster is playing or last played.

Link copied to clipboard
val id: String

an ID that uniquely identifies the channel (this is the broadcaster's ID).

Link copied to clipboard
@SerialName(value = "is_live")
val isLive: Boolean

a Boolean value that determines whether the broadcaster is streaming live. Is true if the broadcaster is streaming live; otherwise, false.

Link copied to clipboard
@SerialName(value = "started_at")
val startedAt: Instant?

the UTC date and time of when the broadcaster started streaming. The string is empty if the broadcaster is not streaming live.

Link copied to clipboard

the tags applied to the channel.

Link copied to clipboard
@SerialName(value = "thumbnail_url")
val thumbnailUrl: String

a URL to a thumbnail of the broadcaster's profile image.

Link copied to clipboard

the stream's title. Is an empty string if the broadcaster didn't set it.