ChannelModerate

data class ChannelModerate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val moderatorUserId: String, val moderatorUserLogin: String, val moderatorUserName: String, val action: String, val followers: ModFollowers? = null, val slow: ModSlow? = null, val vip: ModTargetUser? = null, val unvip: ModTargetUser? = null, val mod: ModTargetUser? = null, val unmod: ModTargetUser? = null, val ban: ModBan? = null, val unban: ModTargetUser? = null, val timeout: ModTimeout? = null, val untimeout: ModTargetUser? = null, val raid: ModRaid? = null, val unraid: ModTargetUser? = null, val delete: ModDelete? = null, val automodTerms: ModAutomodTerms? = null, val unmute: ModTargetUser? = null, val warn: ModWarn? = null, val shared: JsonObject? = null) : TwitchEvent

Twitch EventSub: channel.moderate

A moderation action was performed in a channel. The action field discriminates the type and the corresponding detail object (e.g. ban, timeout, unban) will be non-null.

Constructors

Link copied to clipboard
constructor(subscriptionType: String, messageId: String, timestamp: Instant, broadcasterUserId: String, broadcasterUserLogin: String, broadcasterUserName: String, moderatorUserId: String, moderatorUserLogin: String, moderatorUserName: String, action: String, followers: ModFollowers? = null, slow: ModSlow? = null, vip: ModTargetUser? = null, unvip: ModTargetUser? = null, mod: ModTargetUser? = null, unmod: ModTargetUser? = null, ban: ModBan? = null, unban: ModTargetUser? = null, timeout: ModTimeout? = null, untimeout: ModTargetUser? = null, raid: ModRaid? = null, unraid: ModTargetUser? = null, delete: ModDelete? = null, automodTerms: ModAutomodTerms? = null, unmute: ModTargetUser? = null, warn: ModWarn? = null, shared: JsonObject? = null)

Properties

Link copied to clipboard

the moderation action that was performed (e.g. ban, timeout, delete, clear).

Link copied to clipboard

details if action is add_blocked_term or delete_blocked_term.

Link copied to clipboard
val ban: ModBan?

details if action is ban.

Link copied to clipboard

the broadcaster's user ID.

Link copied to clipboard

the broadcaster's login.

Link copied to clipboard

the broadcaster's display name.

Link copied to clipboard

details if action is delete.

Link copied to clipboard

details if action is followers.

Link copied to clipboard
open override val messageId: String

Unique ID for this EventSub message.

Link copied to clipboard

details if action is mod or unmod.

Link copied to clipboard

the user ID of the moderator who performed the action.

Link copied to clipboard

the login of the moderator who performed the action.

Link copied to clipboard

the display name of the moderator who performed the action.

Link copied to clipboard

details if action is raid.

Link copied to clipboard
val shared: JsonObject?

details if action is applicable to shared chat.

Link copied to clipboard

details if action is slow.

Link copied to clipboard
open override val subscriptionType: String

The EventSub subscription type string (e.g. channel.follow).

Link copied to clipboard

details if action is timeout.

Link copied to clipboard
open override val timestamp: Instant

The Instant when the EventSub notification was sent, parsed from ISO-8601.

Link copied to clipboard

details if action is unban.

Link copied to clipboard

details if action is unmod.

Link copied to clipboard

details if action is approve_unban_request or deny_unban_request.

Link copied to clipboard

details if action is unraid.

Link copied to clipboard

details if action is untimeout.

Link copied to clipboard

details if action is unvip.

Link copied to clipboard

details if action is vip or unvip.

Link copied to clipboard

details if action is warn.