Documentation
¶
Overview ¶
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Index ¶
- Constants
- Variables
- type APIPagination
- type APIResponse
- type AdBreakBeginEventSubEvent
- type AdBreakBeginEventSubResponse
- type AuthorizationRevokeEvent
- type AuthorizationRevokeEventSubResponse
- type BanEventSubEvent
- type BanEventSubResponse
- type BitsLeaderboardDateRange
- type ChannelUpdateEventSubEvent
- type ChannelUpdateEventSubResponse
- type CharityEventSubEvent
- type CharityEventSubEventAmount
- type CharityEventSubResponse
- type CheerEventSubEvent
- type CheerEventSubResponse
- type ContentClassificationLabel
- type ContributionData
- type DropsEntitlementEventSubEvent
- type DropsEntitlementEventSubEventData
- type DropsEntitlementEventSubResponse
- type EventsubCondition
- type EventsubResponse
- type EventsubSubscription
- type EventsubSubscriptionVerification
- type EventsubTransport
- type ExtensionAPIResponse
- type FollowEventSubEvent
- type FollowEventSubResponse
- type GiftEventSubEvent
- type GiftEventSubResponse
- type GoalEventSubEvent
- type GoalEventSubResponse
- type HypeTrainEventSubEvent
- type HypeTrainEventSubResponse
- type ModeratorChangeEventData
- type ModeratorChangeEventSubEvent
- type ModeratorChangeEventSubResponse
- type PollEventSubEvent
- type PollEventSubEventChoice
- type PollEventSubEventGoodVoting
- type PollEventSubResponse
- type PredictionEventSubEvent
- type PredictionEventSubEventOutcomes
- type PredictionEventSubEventTopPredictors
- type PredictionEventSubResponse
- type RaidEvent
- type RaidEventSubResponse
- type RedemptionEventSubEvent
- type RedemptionEventSubResponse
- type RedemptionReward
- type RewardEventSubEvent
- type RewardEventSubResponse
- type RewardGlobalCooldown
- type RewardImage
- type RewardMax
- type ShieldModeEventSubEvent
- type ShieldModeEventSubResponse
- type ShoutoutCreateEventSubEvent
- type ShoutoutCreateEventSubResponse
- type ShoutoutReceivedEventSubEvent
- type ShoutoutReceivedEventSubResponse
- type StreamDownEventSubEvent
- type StreamDownEventSubResponse
- type StreamUpEventSubEvent
- type StreamUpEventSubResponse
- type SubEventSubEvent
- type SubEventSubResponse
- type SubscribeMessageEventSubEvent
- type SubscribeMessageEventSubMessage
- type SubscribeMessageEventSubMessageEmote
- type SubscribeMessageEventSubResponse
- type TransactionCost
- type TransactionEventSubEvent
- type TransactionEventSubProduct
- type TransactionEventSubResponse
- type TransactionProduct
- type UnbanEventSubEvent
- type UnbanRequestCreateEventSubEvent
- type UnbanRequestCreateEventSubResponse
- type UnbanRequestResolveEventSubEvent
- type UserUpdateEventSubEvent
- type UserUpdateEventSubResponse
Constants ¶
const TransportWebSocket = "websocket"
const TransportWebhook = "webhook"
Variables ¶
var CCL_MAP = map[string]ContentClassificationLabel{ "DrugsIntoxication": { Description: "Excessive tobacco glorification or promotion, any marijuana consumption/use, legal drug and alcohol induced intoxication, discussions of illegal drugs.", ID: "DrugsIntoxication", Name: "Drugs, Intoxication, or Excessive Tobacco Use", RestrictedGaming: false, }, "Gambling": { Description: "Participating in online or in-person gambling, poker or fantasy sports, that involve the exchange of real money.", ID: "Gambling", Name: "Gambling", RestrictedGaming: false, }, "MatureGame": { Description: "Games that are rated Mature or less suitable for a younger audience.", ID: "MatureGame", Name: "Mature-rated game", RestrictedGaming: true, }, "ProfanityVulgarity": { Description: "Prolonged, and repeated use of obscenities, profanities, and vulgarities, especially as a regular part of speech.", ID: "ProfanityVulgarity", Name: "Significant Profanity or Vulgarity", RestrictedGaming: false, }, "SexualThemes": { Description: "Content that focuses on sexualized physical attributes and activities, sexual topics, or experiences.", ID: "SexualThemes", Name: "Sexual Themes", RestrictedGaming: false, }, "ViolentGraphic": { Description: "Simulations and/or depictions of realistic violence, gore, extreme injury, or death.", ID: "ViolentGraphic", Name: "Violent and Graphic Depictions", RestrictedGaming: false, }, }
Functions ¶
This section is empty.
Types ¶
type APIPagination ¶ added in v1.1.2
type APIPagination struct {
Cursor string `json:"cursor,omitempty"`
}
type APIResponse ¶
type APIResponse struct {
Data any `json:"data,omitempty"`
Pagination *APIPagination `json:"pagination,omitempty"`
Error string `json:"error,omitempty"`
Status int `json:"status,omitempty"`
Message string `json:"message,omitempty"`
Template string `json:"template,omitempty"`
Total *int `json:"total,omitempty"`
DateRange *BitsLeaderboardDateRange `json:"date_range,omitempty"`
Points int `json:"points,omitempty"`
}
type AdBreakBeginEventSubEvent ¶ added in v1.1.23
type AdBreakBeginEventSubEvent struct {
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
RequesterUserID string `json:"requester_user_id"`
RequesterUserLogin string `json:"requester_user_login"`
RequesterUserName string `json:"requester_user_name"`
Duration int `json:"duration_seconds"`
IsAutomatic bool `json:"is_automatic"`
StartedAt string `json:"started_at"`
}
type AdBreakBeginEventSubResponse ¶ added in v1.1.23
type AdBreakBeginEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event AdBreakBeginEventSubEvent `json:"event"`
}
type AuthorizationRevokeEvent ¶ added in v1.1.2
type AuthorizationRevokeEventSubResponse ¶ added in v1.1.2
type AuthorizationRevokeEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event *AuthorizationRevokeEvent `json:"event,omitempty"`
}
type BanEventSubEvent ¶ added in v1.1.2
type BanEventSubEvent struct {
UserID string `json:"user_id"`
UserLogin string `json:"user_login"`
UserName string `json:"user_name"`
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
ModeratorUserId string `json:"moderator_user_id"`
ModeratorUserLogin string `json:"moderator_user_login"`
ModeratorUserName string `json:"moderator_user_name"`
Reason string `json:"reason"`
BannedAt string `json:"banned_at"`
EndsAt *string `json:"ends_at"`
IsPermanent bool `json:"is_permanent"`
}
type BanEventSubResponse ¶ added in v1.1.2
type BanEventSubResponse struct {
Subscription EventsubSubscription `json:"ban"`
Event BanEventSubEvent `json:"event"`
}
type BitsLeaderboardDateRange ¶ added in v1.1.2
type ChannelUpdateEventSubEvent ¶ added in v1.1.2
type ChannelUpdateEventSubEvent struct {
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
StreamTitle string `json:"title"`
StreamLanguage string `json:"language"`
StreamCategoryID string `json:"category_id"`
StreamCategoryName string `json:"category_name"`
// v1
IsMature *bool `json:"is_mature,omitempty"`
// v2
ContentClassificationLabels []string `json:"content_classification_labels,omitempty"`
}
type ChannelUpdateEventSubResponse ¶ added in v1.1.2
type ChannelUpdateEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event ChannelUpdateEventSubEvent `json:"event"`
}
type CharityEventSubEvent ¶ added in v1.1.13
type CharityEventSubEvent struct {
CampaignID *string `json:"campaign_id,omitempty"` // Specific to channel.charity_campaign.donate
ID string `json:"id,omitempty"` // Used by everything else under channel.charity_campaign.*
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserName string `json:"broadcaster_user_name"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
UserID *string `json:"user_id,omitempty"`
UserName *string `json:"user_name,omitempty"`
UserLogin *string `json:"user_login,omitempty"`
CharityName string `json:"charity_name"`
CharityDescription string `json:"charity_description,omitempty"`
CharityLogo string `json:"charity_logo"`
CharityWebsite string `json:"charity_website,omitempty"`
Amount *CharityEventSubEventAmount `json:"amount,omitempty"`
CurrentAmount *CharityEventSubEventAmount `json:"current_amount,omitempty"`
TargetAmount *CharityEventSubEventAmount `json:"target_amount,omitempty"`
StartedAt *string `json:"started_at,omitempty"`
StoppedAt *string `json:"stopped_at,omitempty"`
}
type CharityEventSubEventAmount ¶ added in v1.1.13
type CharityEventSubResponse ¶ added in v1.1.13
type CharityEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event CharityEventSubEvent `json:"event"`
}
type CheerEventSubEvent ¶
type CheerEventSubEvent struct {
UserID string `json:"user_id"`
UserLogin string `json:"user_login"`
UserName string `json:"user_name"`
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
IsAnonymous bool `json:"is_anonymous"`
Message string `json:"message"`
Bits int64 `json:"bits"`
}
type CheerEventSubResponse ¶
type CheerEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event CheerEventSubEvent `json:"event"`
}
type ContentClassificationLabel ¶ added in v1.1.20
type ContributionData ¶ added in v1.1.2
type DropsEntitlementEventSubEvent ¶ added in v1.1.2
type DropsEntitlementEventSubEvent struct {
ID string `json:"id"`
Data DropsEntitlementEventSubEventData `json:"data"`
}
type DropsEntitlementEventSubEventData ¶ added in v1.1.2
type DropsEntitlementEventSubEventData struct {
EntitlementID string `json:"entitlement_id"`
BenefitID string `json:"benefit_id"`
CampaignID string `json:"campaign_id"`
OrganizationID string `json:"organization_id"`
CreatedAt string `json:"created_at"`
UserID string `json:"user_id"`
UserName string `json:"user_name"`
UserLogin string `json:"user_login"`
CategoryID string `json:"category_id"`
CategoryName string `json:"category_name"`
}
type DropsEntitlementEventSubResponse ¶ added in v1.1.2
type DropsEntitlementEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Events []DropsEntitlementEventSubEvent `json:"events"`
}
type EventsubCondition ¶
type EventsubCondition struct {
BroadcasterUserID string `json:"broadcaster_user_id,omitempty"`
ToBroadcasterUserID string `json:"to_broadcaster_user_id,omitempty"`
UserID string `json:"user_id,omitempty"`
FromBroadcasterUserID string `json:"from_broadcaster_user_id,omitempty"`
ModeratorUserID string `json:"moderator_user_id,omitempty"`
ClientID string `json:"client_id,omitempty"`
ExtensionClientID string `json:"extension_client_id,omitempty"`
OrganizationID string `json:"organization_id,omitempty"`
CategoryID string `json:"category_id,omitempty"`
CampaignID string `json:"campaign_id,omitempty"`
}
type EventsubResponse ¶
type EventsubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event interface{} `json:"event,omitempty"`
}
type EventsubSubscription ¶
type EventsubSubscription struct {
ID string `json:"id"`
Status string `json:"status"`
Type string `json:"type"`
Version string `json:"version"`
Condition EventsubCondition `json:"condition"`
Transport EventsubTransport `json:"transport"`
CreatedAt string `json:"created_at"`
Cost int64 `json:"cost"`
}
type EventsubSubscriptionVerification ¶ added in v0.3.0
type EventsubSubscriptionVerification struct {
Challenge string `json:"challenge"`
Subscription EventsubSubscription `json:"subscription"`
}
type EventsubTransport ¶
type ExtensionAPIResponse ¶ added in v1.1.7
type FollowEventSubEvent ¶
type FollowEventSubEvent struct {
UserID string `json:"user_id"`
UserLogin string `json:"user_login"`
UserName string `json:"user_name"`
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
FollowedAt string `json:"followed_at"`
}
type FollowEventSubResponse ¶
type FollowEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event FollowEventSubEvent `json:"event"`
}
type GiftEventSubEvent ¶ added in v1.1.2
type GiftEventSubEvent struct {
UserID string `json:"user_id"`
UserLogin string `json:"user_login"`
UserName string `json:"user_name"`
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
Tier string `json:"tier"`
Total int `json:"total"`
IsAnonymous bool `json:"is_anonymous"`
CumulativeTotal *int `json:"cumulative_total"`
}
type GiftEventSubResponse ¶ added in v1.1.2
type GiftEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event GiftEventSubEvent `json:"event"`
}
type GoalEventSubEvent ¶ added in v1.1.2
type GoalEventSubEvent struct {
ID string `json:"id"`
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserName string `json:"broadcaster_user_name"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
Type string `json:"type"`
Description string `json:"description"`
IsAchieved *bool `json:"is_achieved,omitempty"`
CurrentAmount int64 `json:"current_amount"`
TargetAmount int64 `json:"target_amount"`
StartedAt string `json:"started_at"`
EndedAt *string `json:"ended_at,omitempty"`
}
type GoalEventSubResponse ¶ added in v1.1.2
type GoalEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event GoalEventSubEvent `json:"event"`
}
type HypeTrainEventSubEvent ¶ added in v1.1.2
type HypeTrainEventSubEvent struct {
ID string `json:"id"`
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
Level int64 `json:"level,omitempty"`
Total int64 `json:"total"`
Progress *int64 `json:"progress,omitempty"`
Goal int64 `json:"goal,omitempty"`
TopContributions []ContributionData `json:"top_contributions"`
LastContribution ContributionData `json:"last_contribution,omitempty"`
StartedAtTimestamp string `json:"started_at,omitempty"`
ExpiresAtTimestamp string `json:"expires_at,omitempty"`
EndedAtTimestamp string `json:"ended_at,omitempty"`
CooldownEndsAtTimestamp string `json:"cooldown_ends_at,omitempty"`
}
type HypeTrainEventSubResponse ¶ added in v1.1.2
type HypeTrainEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event HypeTrainEventSubEvent `json:"event"`
}
type ModeratorChangeEventData ¶ added in v1.1.2
type ModeratorChangeEventSubEvent ¶ added in v1.1.2
type ModeratorChangeEventSubEvent struct {
UserID string `json:"user_id"`
UserLogin string `json:"user_login"`
UserName string `json:"user_name"`
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
}
type ModeratorChangeEventSubResponse ¶ added in v1.1.2
type ModeratorChangeEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event ModeratorChangeEventSubEvent `json:"event"`
}
type PollEventSubEvent ¶ added in v1.1.2
type PollEventSubEvent struct {
ID string `json:"id"`
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
Title string `json:"title"`
Choices []PollEventSubEventChoice `json:"choices"`
BitsVoting PollEventSubEventGoodVoting `json:"bits_voting"`
ChannelPointsVoting PollEventSubEventGoodVoting `json:"channel_points_voting"`
Status string `json:"status,omitempty"`
StartedAt string `json:"started_at"`
EndsAt string `json:"ends_at,omitempty"`
EndedAt string `json:"ended_at,omitempty"`
}
type PollEventSubEventChoice ¶ added in v1.1.2
type PollEventSubEventGoodVoting ¶ added in v1.1.2
type PollEventSubResponse ¶ added in v1.1.2
type PollEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event PollEventSubEvent `json:"event"`
}
type PredictionEventSubEvent ¶ added in v1.1.2
type PredictionEventSubEvent struct {
ID string `json:"id"`
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
Title string `json:"title"`
WinningOutcomeID string `json:"winning_outcome_id,omitempty"`
Outcomes []PredictionEventSubEventOutcomes `json:"outcomes"`
StartedAt string `json:"started_at"`
LocksAt string `json:"locks_at,omitempty"`
LockedAt string `json:"locked_at,omitempty"`
EndedAt string `json:"ended_at,omitempty"`
Status string `json:"status,omitempty"`
}
type PredictionEventSubEventOutcomes ¶ added in v1.1.2
type PredictionEventSubEventOutcomes struct {
ID string `json:"id"`
Title string `json:"title"`
Color string `json:"color"`
Users *int `json:"users,omitempty"`
ChannelPoints *int `json:"channel_points,omitempty"`
TopPredictors *[]PredictionEventSubEventTopPredictors `json:"top_predictors,omitempty"`
}
type PredictionEventSubEventTopPredictors ¶ added in v1.1.2
type PredictionEventSubResponse ¶ added in v1.1.2
type PredictionEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event PredictionEventSubEvent `json:"event"`
}
type RaidEvent ¶ added in v1.1.2
type RaidEvent struct {
ToBroadcasterUserID string `json:"to_broadcaster_user_id"`
ToBroadcasterUserLogin string `json:"to_broadcaster_user_login"`
ToBroadcasterUserName string `json:"to_broadcaster_user_name"`
FromBroadcasterUserID string `json:"from_broadcaster_user_id"`
FromBroadcasterUserLogin string `json:"from_broadcaster_user_login"`
FromBroadcasterUserName string `json:"from_broadcaster_user_name"`
Viewers int64 `json:"viewers"`
}
type RaidEventSubResponse ¶ added in v1.1.2
type RaidEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event RaidEvent `json:"event"`
}
type RedemptionEventSubEvent ¶
type RedemptionEventSubEvent struct {
ID string `json:"id"`
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
UserID string `json:"user_id"`
UserLogin string `json:"user_login"`
UserName string `json:"user_name"`
UserInput string `json:"user_input"`
Status string `json:"status"`
Reward RedemptionReward `json:"reward"`
RedeemedAt string `json:"redeemed_at"`
}
type RedemptionEventSubResponse ¶
type RedemptionEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event RedemptionEventSubEvent `json:"event"`
}
type RedemptionReward ¶
type RewardEventSubEvent ¶
type RewardEventSubEvent struct {
ID string `json:"id"`
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
IsEnabled bool `json:"is_enabled"`
IsPaused bool `json:"is_paused"`
IsInStock bool `json:"is_in_stock"`
Title string `json:"title"`
Cost int64 `json:"cost"`
Prompt string `json:"prompt"`
IsUserInputRequired bool `json:"is_user_input_required"`
ShouldRedemptionsSkipRequestQueue bool `json:"should_redemptions_skip_request_queue"`
CooldownExpiresAt string `json:"cooldown_expires_at"`
RedemptionsRedeemedCurrentStream int64 `json:"redemptions_redeemed_current_stream"`
MaxPerStream RewardMax `json:"max_per_stream"`
MaxPerUserPerStream RewardMax `json:"max_per_user_per_stream"`
GlobalCooldown RewardGlobalCooldown `json:"global_cooldown"`
BackgroundColor string `json:"background_color"`
Image RewardImage `json:"image"`
DefaultImage RewardImage `json:"default_image"`
}
type RewardEventSubResponse ¶
type RewardEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event RewardEventSubEvent `json:"event"`
}
type RewardGlobalCooldown ¶
type RewardImage ¶
type ShieldModeEventSubEvent ¶ added in v1.1.15
type ShieldModeEventSubEvent struct {
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserName string `json:"broadcaster_user_name"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
ModeratorUserID string `json:"moderator_user_id"`
ModeratorUserName string `json:"moderator_user_name"`
ModeratorUserLogin string `json:"moderator_user_login"`
StartedAt string `json:"started_at,omitempty"`
EndedAt string `json:"ended_at,omitempty"`
}
type ShieldModeEventSubResponse ¶ added in v1.1.15
type ShieldModeEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event ShieldModeEventSubEvent `json:"event"`
}
type ShoutoutCreateEventSubEvent ¶ added in v1.1.15
type ShoutoutCreateEventSubEvent struct {
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserName string `json:"broadcaster_user_name"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
ToBroadcasterUserID string `json:"to_broadcaster_user_id"`
ToBroadcasterUserName string `json:"to_broadcaster_user_name"`
ToBroadcasterUserLogin string `json:"to_broadcaster_user_login"`
ModeratorUserID string `json:"moderator_user_id"`
ModeratorUserName string `json:"moderator_user_name"`
ModeratorUserLogin string `json:"moderator_user_login"`
ViewerCount int `json:"viewer_count"`
StartedAt string `json:"started_at"`
CooldownEndsAt string `json:"cooldown_ends_at"`
TargetCooldownEndsAt string `json:"target_cooldown_ends_at"`
}
type ShoutoutCreateEventSubResponse ¶ added in v1.1.15
type ShoutoutCreateEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event ShoutoutCreateEventSubEvent `json:"event"`
}
type ShoutoutReceivedEventSubEvent ¶ added in v1.1.15
type ShoutoutReceivedEventSubEvent struct {
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserName string `json:"broadcaster_user_name"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
FromBroadcasterUserID string `json:"from_broadcaster_user_id"`
FromBroadcasterUserName string `json:"from_broadcaster_user_name"`
FromBroadcasterUserLogin string `json:"from_broadcaster_user_login"`
ViewerCount int `json:"viewer_count"`
StartedAt string `json:"started_at"`
}
type ShoutoutReceivedEventSubResponse ¶ added in v1.1.15
type ShoutoutReceivedEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event ShoutoutReceivedEventSubEvent `json:"event"`
}
type StreamDownEventSubEvent ¶ added in v1.1.2
type StreamDownEventSubResponse ¶ added in v1.1.2
type StreamDownEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event StreamUpEventSubEvent `json:"event"`
}
type StreamUpEventSubEvent ¶ added in v1.1.2
type StreamUpEventSubResponse ¶ added in v1.1.2
type StreamUpEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event StreamUpEventSubEvent `json:"event"`
}
type SubEventSubEvent ¶
type SubEventSubEvent struct {
UserID string `json:"user_id"`
UserLogin string `json:"user_login"`
UserName string `json:"user_name"`
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
Tier string `json:"tier"`
IsGift bool `json:"is_gift"`
}
type SubEventSubResponse ¶
type SubEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event SubEventSubEvent `json:"event"`
}
type SubscribeMessageEventSubEvent ¶ added in v1.1.2
type SubscribeMessageEventSubEvent struct {
UserID string `json:"user_id"`
UserLogin string `json:"user_login"`
UserName string `json:"user_name"`
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
Tier string `json:"tier"`
Message SubscribeMessageEventSubMessage `json:"message"`
CumulativeMonths int `json:"cumulative_months"`
StreakMonths *int `json:"streak_months"`
DurationMonths int `json:"duration_months"`
}
type SubscribeMessageEventSubMessage ¶ added in v1.1.2
type SubscribeMessageEventSubMessage struct {
Text string `json:"text"`
Emotes []SubscribeMessageEventSubMessageEmote `json:"emotes"`
}
type SubscribeMessageEventSubMessageEmote ¶ added in v1.1.2
type SubscribeMessageEventSubResponse ¶ added in v1.1.2
type SubscribeMessageEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event SubscribeMessageEventSubEvent `json:"event"`
}
type TransactionCost ¶
type TransactionEventSubEvent ¶ added in v1.1.2
type TransactionEventSubEvent struct {
ID string `json:"id"`
ExtensionClientID string `json:"extension_client_id"`
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
UserName string `json:"user_name"`
UserLogin string `json:"user_login"`
UserID string `json:"user_id"`
Product TransactionEventSubProduct `json:"product"`
}
type TransactionEventSubProduct ¶ added in v1.1.2
type TransactionEventSubResponse ¶ added in v1.1.2
type TransactionEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event TransactionEventSubEvent `json:"event"`
}
type TransactionProduct ¶
type UnbanEventSubEvent ¶ added in v1.1.21
type UnbanEventSubEvent struct {
UserID string `json:"user_id"`
UserLogin string `json:"user_login"`
UserName string `json:"user_name"`
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
ModeratorUserId string `json:"moderator_user_id"`
ModeratorUserLogin string `json:"moderator_user_login"`
ModeratorUserName string `json:"moderator_user_name"`
}
type UnbanRequestCreateEventSubEvent ¶ added in v1.1.23
type UnbanRequestCreateEventSubEvent struct {
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
UserID string `json:"user_id"`
UserLogin string `json:"user_login"`
UserName string `json:"user_name"`
Text string `json:"text"`
CreatedAt string `json:"created_at"`
}
type UnbanRequestCreateEventSubResponse ¶ added in v1.1.23
type UnbanRequestCreateEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event TransactionEventSubEvent `json:"event"`
}
type UnbanRequestResolveEventSubEvent ¶ added in v1.1.23
type UnbanRequestResolveEventSubEvent struct {
ID string `json:"id"`
BroadcasterUserID string `json:"broadcaster_user_id"`
BroadcasterUserLogin string `json:"broadcaster_user_login"`
BroadcasterUserName string `json:"broadcaster_user_name"`
ModeratorUserID *string `json:"moderator_user_id"`
ModeratorUserLogin *string `json:"moderator_user_login"`
ModeratorUserName *string `json:"moderator_user_name"`
UserID string `json:"user_id"`
UserLogin string `json:"user_login"`
UserName string `json:"user_name"`
ResolutionText string `json:"resolution_text"`
Status string `json:"status"`
}
type UserUpdateEventSubEvent ¶ added in v1.1.6
type UserUpdateEventSubResponse ¶ added in v1.1.6
type UserUpdateEventSubResponse struct {
Subscription EventsubSubscription `json:"subscription"`
Event StreamUpEventSubEvent `json:"event"`
}
Source Files
¶
- ad_break.go
- api.go
- authorization_revoke.go
- ban.go
- ccl.go
- channel_update.go
- charity.go
- cheer.go
- drops.go
- eventsub.go
- follow.go
- goal.go
- hype_train.go
- moderator_change.go
- poll.go
- prediction.go
- raids.go
- redemption.go
- reward.go
- shield_mode.go
- shoutout.go
- streamdown.go
- streamup.go
- subs.go
- transactions.go
- transport.go
- unban_requests.go
- user_update.go