eventsub/io.github.captnblubber.twitchkt.eventsub.model/ChannelBan

ChannelBan

data class ChannelBan(val subscriptionType: String, val messageId: String, val timestamp: Instant, val userId: String, val userLogin: String, val userName: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val moderatorUserId: String, val moderatorUserLogin: String, val moderatorUserName: String, val reason: String, val bannedAt: Instant, val endsAt: Instant?, val isPermanent: Boolean) : TwitchEvent

Twitch EventSub: channel.ban

Constructors

constructor(subscriptionType: String, messageId: String, timestamp: Instant, userId: String, userLogin: String, userName: String, broadcasterUserId: String, broadcasterUserLogin: String, broadcasterUserName: String, moderatorUserId: String, moderatorUserLogin: String, moderatorUserName: String, reason: String, bannedAt: Instant, endsAt: Instant?, isPermanent: Boolean)

Properties

val bannedAt: Instant

RFC3339 timestamp of when the ban was issued.

broadcasterUserId

val broadcasterUserId: String

the broadcaster's user ID.

broadcasterUserLogin

val broadcasterUserLogin: String

the broadcaster's login.

broadcasterUserName

val broadcasterUserName: String

the broadcaster's display name.

val endsAt: Instant?

RFC3339 timestamp of when the timeout ends; null for permanent bans.

val isPermanent: Boolean

whether the ban is permanent.

open override val messageId: String

Unique ID for this EventSub message.

moderatorUserId

val moderatorUserId: String

the user ID of the moderator who issued the ban.

moderatorUserLogin

val moderatorUserLogin: String

the login of the moderator who issued the ban.

moderatorUserName

val moderatorUserName: String

the display name of the moderator who issued the ban.

val reason: String

the reason given for the ban.

subscriptionType

open override val subscriptionType: String

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

open override val timestamp: Instant

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

val userId: String

the user ID of the user who was banned.

val userLogin: String

the login of the user who was banned.

val userName: String

the display name of the user who was banned.