TwurpleAuthenticationGetting dataExamplesFAQMigration

BanEvent

An event representing a user getting banned from a channel.

Overview

Properties

broadcasterId

Type: string

The ID of the broadcaster.

broadcasterName

Type: string

The name of the broadcaster.

duration

Type: number | null

The duration of the ban, or null if it's permanent.

messageObject

Type: ClearChat

The full object that contains all the message information.

userId

Type: string

The ID of the user who was banned.

userName

Type: string

The name of the user who was banned.

Methods

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser

getUser()

async

Gets more information about the user who was banned.

Return type: HelixUser

unban()

async

Remove the ban.

Return type: void