helix/io.github.captnblubber.twitchkt.helix.resource/ChatResource

ChatResource

Twitch Helix Chat API resource.

Provides methods for managing chat messages, emotes, badges, settings, colors, announcements, shared chat sessions, and user emotes.

Functions

getAllChatters

fun getAllChatters(broadcasterId: String, moderatorId: String, pageSize: Int = 1000): Flow<Chatter>

Returns a paginated Flow of all users in the broadcaster's chat room. Automatically follows pagination cursors until all chatters have been fetched.

getAllUserEmotes

fun getAllUserEmotes(userId: String, broadcasterId: String? = null): Flow<UserEmote>

Twitch API: Get User Emotes

getChannelBadges

suspend fun getChannelBadges(broadcasterId: String): List<ChatBadge>

Twitch API: Get Channel Chat Badges

getChannelEmotes

suspend fun getChannelEmotes(broadcasterId: String): List<ChannelEmote>

Twitch API: Get Channel Emotes

getChatters

suspend fun getChatters(broadcasterId: String, moderatorId: String, cursor: String? = null, pageSize: Int? = null): Page<Chatter>

Twitch API: Get Chatters

getEmoteSets

suspend fun getEmoteSets(emoteSetIds: List<String>): List<ChannelEmote>

Twitch API: Get Emote Sets

getGlobalBadges

suspend fun getGlobalBadges(): List<ChatBadge>

Twitch API: Get Global Chat Badges

getGlobalEmotes

suspend fun getGlobalEmotes(): List<ChannelEmote>

Twitch API: Get Global Emotes

getSettings

suspend fun getSettings(broadcasterId: String, moderatorId: String? = null): ChatSettings

Twitch API: Get Chat Settings

getSharedChatSession

suspend fun getSharedChatSession(broadcasterId: String): SharedChatSession

Twitch API: Get Shared Chat Session

getUserColor

suspend fun getUserColor(userIds: List<String>): List<ChatColorEntry>

Twitch API: Get User Chat Color

getUserEmotes

suspend fun getUserEmotes(userId: String, cursor: String? = null, broadcasterId: String? = null): Page<UserEmote>

Twitch API: Get User Emotes

sendAnnouncement

suspend fun sendAnnouncement(broadcasterId: String, moderatorId: String, message: String, color: AnnouncementColor = AnnouncementColor.PRIMARY, sourceOnly: Boolean? = null)

Twitch API: Send Chat Announcement

sendMessage

suspend fun sendMessage(request: SendChatMessageRequest): SendMessageResponse

Twitch API: Send Chat Message

updateSettings

suspend fun updateSettings(broadcasterId: String, moderatorId: String, slowMode: Boolean? = null, slowModeWaitTime: Int? = null, followerMode: Boolean? = null, followerModeDuration: Int? = null, subscriberMode: Boolean? = null, emoteMode: Boolean? = null, uniqueChatMode: Boolean? = null, nonModeratorChatDelay: Boolean? = null, nonModeratorChatDelayDuration: Int? = null): ChatSettings

Twitch API: Update Chat Settings

updateUserColor

suspend fun updateUserColor(userId: String, color: String)

Twitch API: Update User Chat Color

ChatResource

See also

Functions