twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks
Welcome

HelixBanEvent

An event that indicates the change of a ban status, i.e. banning or unbanning a user.

Overview

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster from whose chat the user was banned/unbanned.

broadcasterId

Type: string

The id of the broadcaster from whose chat the user was banned/unbanned.

broadcasterName

Type: string

The name of the broadcaster from whose chat the user was banned/unbanned.

eventDate

Type: Date

The date of the ban event.

eventId

Type: string

The unique ID of the ban event.

eventType

Type: HelixBanEventType

The type of the ban event.

eventVersion

Type: string

The version of the ban event.

expiryDate

Type: Date | null

The date when the ban will expire; null for permanent bans.

userDisplayName

Type: string

The display name of the banned user.

userId

Type: string

The ID of the banned user.

userName

Type: string

The name of the banned user.

Methods

getBroadcaster()

async

Retrieves more information about the broadcaster.

Return type: HelixUser | null

getUser()

async

Retrieves more information about the user.

Return type: HelixUser | null