twitch

Sep 16, 2024

Changes in this version

type Client

+ func (c *Client) CreateStreamMarker(ctx context.Context, description string) (marker StreamMarkerInfo, err error)

+ func (c *Client) GetVideos(ctx context.Context, opts GetVideoOpts) (videos []Video, err error)

+ type GetVideoOpts struct

+ After string

+ Before string

+ First int64

+ GameID string

+ ID string

+ Language string

+ Period GetVideoOptsPeriod

+ Sort GetVideoOptsSort

+ Type GetVideoOptsType

+ UserID string

+ type GetVideoOptsPeriod string

+ const GetVideoOptsPeriodAll

+ const GetVideoOptsPeriodDay

+ const GetVideoOptsPeriodMonth

+ const GetVideoOptsPeriodWeek

+ type GetVideoOptsSort string

+ const GetVideoOptsSortTime

+ const GetVideoOptsSortTrending

+ const GetVideoOptsSortViews

+ type GetVideoOptsType string

+ const GetVideoOptsTypeAll

+ const GetVideoOptsTypeArchive

+ const GetVideoOptsTypeHighlight

+ const GetVideoOptsTypeUpload

+ type StreamMarkerInfo struct

+ CreatedAt time.Time

+ Description string

+ ID string

+ PositionSeconds int64

+ type Video struct

+ CreatedAt time.Time

+ Description string

+ Duration string

+ ID string

+ Language string

+ MutedSegments []struct{ ... }

+ PublishedAt time.Time

+ StreamID *string

+ ThumbnailURL string

+ Title string

+ Type string

+ URL string

+ UserID string

+ UserLogin string

+ UserName string

+ ViewCount int64

+ Viewable string

Apr 13, 2024

Changes in this version

+ const EventSubEventTypeChannelSuspiciousUserMessage

+ const EventSubEventTypeChannelSuspiciousUserUpdate

+ const ScopeModeratorReadSuspiciousUsers

+ type EventSubEventSuspiciousUserMessage struct

+ BanEvasionEvaluation string

+ BroadcasterUserID string

+ BroadcasterUserLogin string

+ BroadcasterUserName string

+ LowTrustStatus string

+ Message struct{ ... }

+ SharedBanChannelIDs []string

+ Types []string

+ UserID string

+ UserLogin string

+ UserName string

+ type EventSubEventSuspiciousUserUpdated struct

+ BroadcasterUserID string

+ BroadcasterUserLogin string

+ BroadcasterUserName string

+ LowTrustStatus string

+ ModeratorUserID string

+ ModeratorUserLogin string

+ ModeratorUserName string

+ UserID string

+ UserLogin string

+ UserName string

Apr 2, 2024

Changes in this version

type EventSubEventAdBreakBegin

+ StartedAt time.Time

Mar 5, 2024

Changes in this version

+ const EventSubEventTypeChannelHypetrainBegin

+ const EventSubEventTypeChannelHypetrainEnd

+ const EventSubEventTypeChannelHypetrainProgress

+ const ScopeChannelReadHypetrain

+ type EventSubEventHypetrain struct

+ BroadcasterUserID string

+ BroadcasterUserLogin string

+ BroadcasterUserName string

+ CooldownEndsAt *time.Time

+ EndedAt *time.Time

+ ExpiresAt *time.Time

+ Goal int64

+ ID string

+ LastContribution ...

+ Level int64

+ Progress int64

+ StartedAt time.Time

+ TopContributions []struct{ ... }

+ Total int64

Dec 14, 2023

Changes in this version

type EventSubEventAdBreakBegin

+ RequesterUserLogin string

+ RequesterUserName string

type EventSubSocketClientOpt

+ func WithMustSubscribe(event, version string, condition EventSubCondition, ...) EventSubSocketClientOpt

+ func WithRetryBackgroundSubscribe(event, version string, condition EventSubCondition, ...) EventSubSocketClientOpt

Dec 7, 2023

Changes in this version

+ type ChannelStreamScheduleSegment struct

+ CanceledUntil *time.Time

+ Category struct{ ... }

+ EndTime time.Time

+ ID string

+ IsRecurring bool

+ StartTime time.Time

+ Title string

type Client

+ func (c *Client) GetTokenInfo(ctx context.Context) (user string, scopes []string, expiresAt time.Time, err error)

Oct 28, 2023

Changes in this version

+ const EventSubEventTypeChannelAdBreakBegin

+ const ScopeChannelBot

+ const ScopeChannelManageAds

+ const ScopeChannelReadAds

+ const ScopeUserBot

+ const ScopeUserReadChat

type Client

+ func (c *Client) GetTwitchAppAccessToken() (string, error)

+ type EventSubEventAdBreakBegin struct

+ BroadcasterUserID string

+ BroadcasterUserLogin string

+ BroadcasterUserName string

+ Duration int64

+ IsAutomatic bool

+ RequesterUserID string

+ Timestamp time.Time

Sep 21, 2023

Changes in this version

+ const ScopeUserManageWhispers

type Client

+ func (c *Client) GetUsernameForID(ctx context.Context, id string) (string, error)

Aug 22, 2023

Changes in this version

+ const ScopeClipsEdit

type Client

+ func (c *Client) CreateClip(ctx context.Context, channel string, addDelay bool) (ccr CreateClipResponse, err error)

+ type CreateClipResponse struct

+ EditURL string

+ ID string

Aug 4, 2023

Changes in this version

+ var ErrAnyHTTPError = newHTTPError(0, nil, nil)

+ var ErrNoStreamsFound = errors.New("no streams found")

+ func ValidateStatus(opts ClientRequestOpts, resp *http.Response) error

+ type ChannelStreamSchedule struct

+ BroadcasterID string

+ BroadcasterLogin string

+ BroadcasterName string

+ Segments []struct{ ... }

+ Vacation struct{ ... }

type Client

+ func (c *Client) GetChannelStreamSchedule(ctx context.Context, channel string) (*ChannelStreamSchedule, error)

type ClientRequestOpts

+ ValidateFunc func(ClientRequestOpts, *http.Response) error

+ type ErrorResponse struct

+ Error string

+ Message string

+ Status int

+ type HTTPError struct

+ Body []byte

+ Code int

+ Err error

+ func (h HTTPError) Error() string

+ func (h HTTPError) Is(target error) bool

+ func (h HTTPError) Unwrap() error

Jul 15, 2023

Changes in this version

+ type AuthType uint8

+ const AuthTypeAppAccessToken

+ const AuthTypeBearerToken

+ const AuthTypeUnauthorized

type Client

+ func (c *Client) Request(opts ClientRequestOpts) error

+ type ClientRequestOpts struct

+ AuthType AuthType

+ Body io.Reader

+ Context context.Context

+ Method string

+ NoRetry bool

+ NoValidateToken bool

+ OKStatus int

+ Out interface{}

+ URL string

type EventSubEventChannelUpdate

+ ContentClassificationLabels []string

May 27, 2023

Changes in this version

+ const EventSubEventTypeChannelPollBegin

+ const EventSubEventTypeChannelPollEnd

+ const EventSubEventTypeChannelPollProgress

+ const ScopeChannelReadPolls

type Client

+ func (c *Client) GetLatestPoll(ctx context.Context, username string) (*PollInfo, error)

+ type EventSubEventPoll struct

+ BroadcasterUserID string

+ BroadcasterUserLogin string

+ BroadcasterUserName string

+ ChannelPointsVoting struct{ ... }

+ Choices []struct{ ... }

+ EndedAt time.Time

+ EndsAt time.Time

+ ID string

+ StartedAt time.Time

+ Status string

+ Title string

+ type PollInfo struct

+ BroadcasterID string

+ BroadcasterLogin string

+ BroadcasterName string

+ ChannelPointsPerVote int

+ ChannelPointsVotingEnabled bool

+ Choices []struct{ ... }

+ Duration int

+ EndedAt *time.Time

+ ID string

+ StartedAt time.Time

+ Status string

+ Title string

May 21, 2023

Changes in this version

+ type EventSubSocketClient struct

+ func NewEventSubSocketClient(opts ...EventSubSocketClientOpt) (*EventSubSocketClient, error)

+ func (e *EventSubSocketClient) Close()

+ func (e *EventSubSocketClient) Run() error

+ type EventSubSocketClientOpt func(*EventSubSocketClient)

+ func WithLogger(logger *logrus.Entry) EventSubSocketClientOpt

+ func WithSocketURL(url string) EventSubSocketClientOpt

+ func WithSubscription(event, version string, condition EventSubCondition, ...) EventSubSocketClientOpt

+ func WithTwitchClient(c *Client) EventSubSocketClientOpt

May 11, 2023

Changes in this version

+ const ScopeChannelReadSubscriptions

type Client

+ func (c *Client) GetBroadcasterSubscriptionCount(ctx context.Context, broadcasterName string) (subCount, subPoints int64, err error)

Apr 14, 2023

Changes in this version

type Client

+ func (c *Client) GetClipByID(ctx context.Context, clipID string) (ClipInfo, error)

+ type ClipInfo struct

+ BroadcasterID string

+ BroadcasterName string

+ CreatedAt time.Time

+ CreatorID string

+ CreatorName string

+ Duration float64

+ EmbedURL string

+ GameID string

+ ID string

+ Language string

+ ThumbnailURL string

+ Title string

+ URL string

+ VideoID string

+ ViewCount int64

+ VodOffset int64

Mar 31, 2023

Changes in this version

+ const EventSubEventTypeChannelShoutoutCreate

type Client

+ func (c *Client) RunCommercial(ctx context.Context, channel string, duration int64) error

+ type EventSubEventShoutoutCreated struct

+ BroadcasterUserID string

+ BroadcasterUserLogin string

+ BroadcasterUserName string

+ CooldownEndsAt time.Time

+ ModeratorUserID string

+ ModeratorUserLogin string

+ ModeratorUserName string

+ StartedAt time.Time

+ TargetCooldownEndsAt time.Time

+ ToBroadcasterUserID string

+ ToBroadcasterUserLogin string

+ ToBroadcasterUserName string

+ ViewerCount int64

Mar 6, 2023

Changes in this version

+ const EventSubEventTypeChannelShoutoutReceive

+ const ScopeModeratorReadShoutouts

type EventSubCondition

+ ModeratorUserID string

+ type EventSubEventShoutoutReceived struct

+ BroadcasterUserID string

+ BroadcasterUserLogin string

+ BroadcasterUserName string

+ FromBroadcasterUserID string

+ FromBroadcasterUserLogin string

+ FromBroadcasterUserName string

+ StartedAt time.Time

+ ViewerCount int64

Feb 8, 2023

Changes in this version

+ const EventSubTopicVersion1

+ const EventSubTopicVersion2

+ const EventSubTopicVersionBeta

+ const ScopeModeratorManageShieldMode

+ const ScopeModeratorReadFollowers

type Client

+ func (c *Client) UpdateShieldMode(ctx context.Context, channel string, enable bool) error

Jan 27, 2023

Changes in this version

+ const ScopeModeratorManageShoutouts

type Client

+ func (c *Client) SendShoutout(channel, user string) error

Jan 7, 2023

Changes in this version

+ var ErrUserDoesNotFollow = errors.New("no follow-relation found")

Dec 22, 2022

Changes in this version

type Client

+ func (c *Client) AddChannelVIP(ctx context.Context, broadcasterName, userName string) error

+ func (c *Client) RemoveChannelVIP(ctx context.Context, broadcasterName, userName string) error

Nov 2, 2022

Changes in this version

+ const BadgeBroadcaster

+ const BadgeFounder

+ const BadgeModerator

+ const BadgeSubscriber

+ const BadgeVIP

+ const EventSubEventTypeChannelFollow

+ const EventSubEventTypeChannelPointCustomRewardRedemptionAdd

+ const EventSubEventTypeChannelRaid

+ const EventSubEventTypeChannelUpdate

+ const EventSubEventTypeStreamOffline

+ const EventSubEventTypeStreamOnline

+ const EventSubEventTypeUserAuthorizationRevoke

+ const ScopeChannelEditCommercial

+ const ScopeChannelManageBroadcast

+ const ScopeChannelManageModerators

+ const ScopeChannelManagePolls

+ const ScopeChannelManagePredictions

+ const ScopeChannelManageRaids

+ const ScopeChannelManageRedemptions

+ const ScopeChannelManageVIPS

+ const ScopeChannelManageWhispers

+ const ScopeChannelReadRedemptions

+ const ScopeChatEdit

+ const ScopeChatRead

+ const ScopeModeratorManageAnnoucements

+ const ScopeModeratorManageBannedUsers

+ const ScopeModeratorManageChatMessages

+ const ScopeModeratorManageChatSettings

+ const ScopeUserManageChatColor

+ const ScopeV5ChannelEditor

+ const ScopeWhisperRead

+ var KnownBadges = []string

+ type APICache struct

+ func (t *APICache) Get(key []string) interface{}

+ func (t *APICache) Set(key []string, valid time.Duration, data interface{})

+ type BadgeCollection map[string]*int

+ func ParseBadgeLevels(m *irc.Message) BadgeCollection

+ func (b BadgeCollection) Add(badge string, level int)

+ func (b BadgeCollection) Get(badge string) int

+ func (b BadgeCollection) Has(badge string) bool

+ type Category struct

+ BoxArtURL string

+ ID string

+ Name string

+ type Client struct

+ func New(clientID, clientSecret, accessToken, refreshToken string) *Client

+ func (c *Client) APICache() *APICache

+ func (c *Client) BanUser(channel, username string, duration time.Duration, reason string) error

+ func (c *Client) DeleteMessage(channel, messageID string) error

+ func (c *Client) GetAuthorizedUser() (userID string, userName string, err error)

+ func (c *Client) GetCurrentStreamInfo(username string) (*StreamInfo, error)

+ func (c *Client) GetDisplayNameForUser(username string) (string, error)

+ func (c *Client) GetFollowDate(from, to string) (time.Time, error)

+ func (c *Client) GetIDForUsername(username string) (string, error)

+ func (c *Client) GetRecentStreamInfo(username string) (string, string, error)

+ func (c *Client) GetToken() (string, error)

+ func (c *Client) GetUserInformation(user string) (*User, error)

+ func (c *Client) HasLiveStream(username string) (bool, error)

+ func (c *Client) ModifyChannelInformation(ctx context.Context, broadcasterName string, game, title *string) error

+ func (c *Client) RefreshToken() error

+ func (c *Client) SearchCategories(ctx context.Context, name string) ([]Category, error)

+ func (c *Client) SendChatAnnouncement(channel, color, message string) error

+ func (c *Client) SendWhisper(toUser, message string) error

+ func (c *Client) SetTokenUpdateHook(f func(string, string) error)

+ func (c *Client) UnbanUser(channel, username string) error

+ func (c *Client) UpdateToken(accessToken, refreshToken string)

+ func (c *Client) ValidateToken(ctx context.Context, force bool) error

+ type EventSubClient struct

+ func NewEventSubClient(twitchClient *Client, apiURL, secret, secretHandle string) (*EventSubClient, error)

+ func (e *EventSubClient) HandleEventsubPush(w http.ResponseWriter, r *http.Request)

+ func (e *EventSubClient) PreFetchSubscriptions(ctx context.Context) error

+ func (e *EventSubClient) RegisterEventSubHooks(event string, condition EventSubCondition, ...) (func(), error)

+ type EventSubCondition struct

+ BroadcasterUserID string

+ CampaignID string

+ CategoryID string

+ ClientID string

+ ExtensionClientID string

+ FromBroadcasterUserID string

+ OrganizationID string

+ RewardID string

+ ToBroadcasterUserID string

+ UserID string

+ func (e EventSubCondition) Hash() (string, error)

+ type EventSubEventChannelPointCustomRewardRedemptionAdd struct

+ BroadcasterUserID string

+ BroadcasterUserLogin string

+ BroadcasterUserName string

+ ID string

+ RedeemedAt time.Time

+ Reward struct{ ... }

+ Status string

+ UserID string

+ UserInput string

+ UserLogin string

+ UserName string

+ type EventSubEventChannelUpdate struct

+ BroadcasterUserID string

+ BroadcasterUserLogin string

+ BroadcasterUserName string

+ CategoryID string

+ CategoryName string

+ IsMature bool

+ Language string

+ Title string

+ type EventSubEventFollow struct

+ BroadcasterUserID string

+ BroadcasterUserLogin string

+ BroadcasterUserName string

+ FollowedAt time.Time

+ UserID string

+ UserLogin string

+ UserName string

+ type EventSubEventRaid struct

+ FromBroadcasterUserID string

+ FromBroadcasterUserLogin string

+ FromBroadcasterUserName string

+ ToBroadcasterUserID string

+ ToBroadcasterUserLogin string

+ ToBroadcasterUserName string

+ Viewers int64

+ type EventSubEventStreamOffline struct

+ BroadcasterUserID string

+ BroadcasterUserLogin string

+ BroadcasterUserName string

+ type EventSubEventStreamOnline struct

+ BroadcasterUserID string

+ BroadcasterUserLogin string

+ BroadcasterUserName string

+ ID string

+ StartedAt time.Time

+ Type string

+ type EventSubEventUserAuthorizationRevoke struct

+ ClientID string

+ UserID string

+ UserLogin string

+ UserName string

+ type OAuthTokenResponse struct

+ AccessToken string

+ ExpiresIn int

+ RefreshToken string

+ Scope []string

+ TokenType string

+ type OAuthTokenValidationResponse struct

+ ClientID string

+ ExpiresIn int

+ Login string

+ Scopes []string

+ UserID string

+ type StreamInfo struct

+ GameID string

+ GameName string

+ ID string

+ IsMature bool

+ Language string

+ StartedAt time.Time

+ TagIds []string

+ ThumbnailURL string

+ Title string

+ Type string

+ UserID string

+ UserLogin string

+ UserName string

+ ViewerCount int64

+ type User struct

+ DisplayName string

+ ID string

+ Login string

+ ProfileImageURL string