Twurple Authentication Getting data Examples FAQ Migration

Reference

api api-call auth auth-tmi chat common easy-bot ebs-helper eventsub-base eventsub-http eventsub-ws pubsub

Main classes

Classes

ApiReportedRequest ConfigError HelixAdSchedule HelixBan HelixBanUser HelixBitsLeaderboard HelixBitsLeaderboardEntry HelixBlockedTerm HelixChannel HelixChannelEditor HelixChannelEmote HelixChannelFollower HelixChannelReference HelixChannelSearchResult HelixCharityCampaign HelixCharityCampaignAmount HelixCharityCampaignDonation HelixChatBadgeSet HelixChatBadgeVersion HelixChatChatter HelixChatSettings HelixCheermoteList HelixClip HelixContentClassificationLabel HelixCustomReward HelixCustomRewardRedemption HelixDropsEntitlement HelixEmote HelixEmoteFromSet HelixEventSubConduit HelixEventSubConduitShard HelixEventSubSubscription HelixExtensionBitsProduct HelixExtensionTransaction HelixFollow HelixFollowedChannel HelixGame HelixGoal HelixGoalApi HelixHypeTrainContribution HelixHypeTrainEvent HelixInstalledExtension HelixInstalledExtensionList HelixModeratedChannel HelixModerator HelixPaginatedEventSubSubscriptionsRequest HelixPaginatedRequest HelixPaginatedRequestWithTotal HelixPaginatedScheduleSegmentRequest HelixPaginatedSubscriptionsRequest HelixPoll HelixPollChoice HelixPrediction HelixPredictionOutcome HelixPredictor HelixPrivilegedChatSettings HelixPrivilegedUser HelixRaid HelixSchedule HelixScheduleSegment HelixSentChatMessage HelixSharedChatSession HelixSharedChatSessionParticipant HelixShieldModeStatus HelixStream HelixStreamMarker HelixStreamMarkerWithVideo HelixSubscription HelixTeam HelixTeamWithUsers HelixUnbanRequest HelixUser HelixUserBlock HelixUserEmote HelixUserExtension HelixUserRelation HelixUserSubscription HelixVideo HelixWarning StreamNotLiveError

Interfaces

ApiConfig CheermoteDisplayInfo HelixBanFilter HelixBanUserRequest HelixBitsLeaderboardQuery HelixChannelSearchFilter HelixChannelUpdate HelixClipCreateParams HelixClipFilter HelixCreateCustomRewardData HelixCreatePollData HelixCreatePredictionData HelixCreateScheduleSegmentData HelixCustomRewardRedemptionFilter HelixDropsEntitlementFilter HelixDropsEntitlementPaginatedFilter HelixEventSubConduitShardsOptions HelixEventSubConduitTransportOptions HelixEventSubDropEntitlementGrantFilter HelixEventSubWebHookTransportOptions HelixEventSubWebSocketTransportOptions HelixExtensionBitsProductUpdatePayload HelixExtensionTransactionsFilter HelixExtensionTransactionsPaginatedFilter HelixForwardPagination HelixModeratorFilter HelixPaginatedChannelSearchFilter HelixPaginatedClipFilter HelixPaginatedCustomRewardRedemptionFilter HelixPaginatedEventSubSubscriptionsResult HelixPaginatedResult HelixPaginatedResultWithTotal HelixPaginatedScheduleFilter HelixPaginatedStreamFilter HelixPaginatedSubscriptionsResult HelixPaginatedVideoFilter HelixPagination HelixScheduleFilter HelixScheduleSettingsUpdate HelixSendChatAnnouncementParams HelixSendChatMessageParams HelixStreamFilter HelixUpdateChatSettingsParams HelixUpdateCustomRewardData HelixUpdateScheduleSegmentData HelixUserBlockAdditionalInfo HelixUserEmotesFilter HelixUserExtensionUpdatePayload HelixUserExtensionUpdatePayloadActiveSlot HelixUserExtensionUpdatePayloadInactiveSlot HelixUserUpdate HelixVideoFilter

HelixUnbanRequest

A request from a user to be unbanned from a channel.

Overview

Properties

Methods

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster whose channel is receiving the unban request.

broadcasterId

Type: string

The ID of the broadcaster whose channel is receiving the unban request.

broadcasterName

Type: string

The name of the broadcaster whose channel is receiving the unban request.

creationDate

Type: Date

The date of when the unban request was created.

id

Type: string

Unban request ID.

message

Type: string

Text message of the unban request from the requesting user.

moderatorDisplayName

Type: string | null

The display name of the moderator who resolved the unban request.

Can be null if the request is not resolved.

moderatorId

Type: string | null

The ID of the moderator who resolved the unban request.

Can be null if the request is not resolved.

moderatorName

Type: string | null

The name of the moderator who resolved the unban request.

Can be null if the request is not resolved.

resolutionDate

Type: Date | null

The date when the unban request was resolved, or null if it has not been resolved yet.

resolutionMessage

Type: string | null

The message written by the moderator who resolved the unban request, or null if it has not been resolved yet.

userDisplayName

Type: string

The display name of the user who requested to be unbanned.

userId

Type: string

The ID of the user who requested to be unbanned.

userName

Type: string

The name of the user who requested to be unbanned.

Methods

getBroadcaster()

Gets more information about the broadcaster.

Return type: HelixUser

getModerator()

Gets more information about the moderator.

Return type: HelixUser

getUser()

Gets more information about the user.

Return type: HelixUser