Skip to content

ChannelInstance

ChannelInstance is a class returned from methods that fetch Kick channels. It encapsulates data about the channel and includes methods to assist with interacting with the specified channel.

Properties

data

Returns

GetChannelResponse

Methods

getChatroom()

Returns the chatroom object from the channel data.

Returns

ChannelChatroom


async connectToChatroom()

Connects to the channel's chatoom and listens for events

Returns

Promise<void>


async getLivestream()

Gets information for the current livestream running on this channel.

Returns

Promise<LivestreamInstance>


async getLeaderboard()

Gets information for gifting leaderboard.

Returns

Promise<GetLeaderboardsResponse>


async getPoll()

Gets information for current running poll.

Returns

Promise<GetPollsResponse>