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

ModerationResource

Twitch Helix Moderation API resource.

Provides methods for managing bans, blocked terms, AutoMod settings, moderators, VIPs, shield mode, and suspicious users.

Functions

addBlockedTerm

suspend fun addBlockedTerm(broadcasterId: String, moderatorId: String, text: String): BlockedTerm

Twitch API: Add Blocked Term

addModerator

suspend fun addModerator(broadcasterId: String, userId: String)

Twitch API: Add Channel Moderator

addSuspiciousStatus

suspend fun addSuspiciousStatus(broadcasterId: String, moderatorId: String, userId: String, status: String): SuspiciousUserStatus

Twitch API: Add Suspicious Status to Chat User

addVip

suspend fun addVip(broadcasterId: String, userId: String)

Twitch API: Add Channel VIP

ban

suspend fun ban(broadcasterId: String, moderatorId: String, userId: String, reason: String = "", duration: Int? = null)

Twitch API: Ban User

checkAutoModStatus

suspend fun checkAutoModStatus(broadcasterId: String, messages: List<AutoModCheckMessage>): List<AutoModCheckResult>

Twitch API: Check AutoMod Status

deleteMessage

suspend fun deleteMessage(broadcasterId: String, moderatorId: String, messageId: String? = null)

Twitch API: Delete Chat Messages

getAllBanned

fun getAllBanned(broadcasterId: String, userIds: List<String> = emptyList()): Flow<BannedUser>

Twitch API: Get Banned Users

getAllBlockedTerms

fun getAllBlockedTerms(broadcasterId: String, moderatorId: String): Flow<BlockedTerm>

Twitch API: Get Blocked Terms

getAllModeratedChannels

fun getAllModeratedChannels(userId: String): Flow<ModeratedChannel>

Twitch API: Get Moderated Channels

getAllModerators

fun getAllModerators(broadcasterId: String, userIds: List<String> = emptyList()): Flow<ChannelRoleUser>

Twitch API: Get Moderators

getAllUnbanRequests

fun getAllUnbanRequests(broadcasterId: String, moderatorId: String, status: UnbanRequestStatus = UnbanRequestStatus.PENDING): Flow<UnbanRequestResponse>

Twitch API: Get Unban Requests

getAllVIPs

fun getAllVIPs(broadcasterId: String, userIds: List<String> = emptyList()): Flow<ChannelRoleUser>

Twitch API: Get VIPs

getAutoModSettings

suspend fun getAutoModSettings(broadcasterId: String, moderatorId: String): AutoModSettings

Twitch API: Get AutoMod Settings

getBanned

suspend fun getBanned(broadcasterId: String, userIds: List<String> = emptyList(), cursor: String? = null, pageSize: Int? = null): Page<BannedUser>

Twitch API: Get Banned Users

getBlockedTerms

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

Twitch API: Get Blocked Terms

getModeratedChannels

suspend fun getModeratedChannels(userId: String, cursor: String? = null, pageSize: Int? = null): Page<ModeratedChannel>

Twitch API: Get Moderated Channels

getModerators

suspend fun getModerators(broadcasterId: String, userIds: List<String> = emptyList(), cursor: String? = null, pageSize: Int? = null): Page<ChannelRoleUser>

Twitch API: Get Moderators

getShieldMode

suspend fun getShieldMode(broadcasterId: String, moderatorId: String): ShieldModeStatus

Twitch API: Get Shield Mode Status

getUnbanRequests

suspend fun getUnbanRequests(broadcasterId: String, moderatorId: String, status: UnbanRequestStatus = UnbanRequestStatus.PENDING, userId: String? = null, cursor: String? = null, pageSize: Int? = null): Page<UnbanRequestResponse>

Twitch API: Get Unban Requests

getVIPs

suspend fun getVIPs(broadcasterId: String, userIds: List<String> = emptyList(), cursor: String? = null, pageSize: Int? = null): Page<ChannelRoleUser>

Twitch API: Get VIPs

manageHeldAutoModMessage

suspend fun manageHeldAutoModMessage(userId: String, msgId: String, action: AutoModAction)

Twitch API: Manage Held AutoMod Messages

removeBlockedTerm

suspend fun removeBlockedTerm(broadcasterId: String, moderatorId: String, id: String)

Twitch API: Remove Blocked Term

removeModerator

suspend fun removeModerator(broadcasterId: String, userId: String)

Twitch API: Remove Channel Moderator

removeSuspiciousStatus

suspend fun removeSuspiciousStatus(broadcasterId: String, moderatorId: String, userId: String): SuspiciousUserStatus

Twitch API: Remove Suspicious Status From Chat User

removeVip

suspend fun removeVip(broadcasterId: String, userId: String)

Twitch API: Remove Channel VIP

resolveUnbanRequest

suspend fun resolveUnbanRequest(broadcasterId: String, moderatorId: String, unbanRequestId: String, status: UnbanRequestStatus, resolutionText: String? = null): UnbanRequestResponse

Twitch API: Resolve Unban Requests

sendShoutout

suspend fun sendShoutout(fromId: String, toId: String, moderatorId: String)

Twitch API: Send a Shoutout

unban

suspend fun unban(broadcasterId: String, moderatorId: String, userId: String)

Twitch API: Unban User

updateAutoModSettings

suspend fun updateAutoModSettings(broadcasterId: String, moderatorId: String, request: UpdateAutoModSettingsRequest): AutoModSettings

Twitch API: Update AutoMod Settings

updateShieldMode

suspend fun updateShieldMode(broadcasterId: String, moderatorId: String, isActive: Boolean): ShieldModeStatus

Twitch API: Update Shield Mode Status

warn

suspend fun warn(broadcasterId: String, moderatorId: String, userId: String, reason: String)

Twitch API: Warn Chat User

ModerationResource

See also

Functions