eventsub_framework

package module

Go to main page

Versions in this module

v1

v1.3.2

Mar 14, 2024

Changes in this version

type SubHandler

+ HandleChannelUnbanRequestCreate func(h *esb.ResponseHeaders, event *esb.ChannelUnbanRequestCreate)

+ HandleChannelUnbanRequestResolve func(h *esb.ResponseHeaders, event *esb.ChannelUnbanRequestResolve)

v1.3.1

Jan 26, 2024

Changes in this version

type SubHandler

+ HandleChannelChatMessage func(h *esb.ResponseHeaders, event *esb.EventChannelChatMessage)

v1.3.0

Jan 7, 2024

Changes in this version

type SubHandler

+ HandleChannelChatClear func(h *esb.ResponseHeaders, event *esb.EventChannelChatClear)

+ HandleChannelChatClearUserMessages func(h *esb.ResponseHeaders, event *esb.EventChannelChatClearUserMessages)

+ HandleChannelChatMessageDelete func(h *esb.ResponseHeaders, event *esb.EventChannelChatMessageDelete)

+ HandleChannelChatNotification func(h *esb.ResponseHeaders, event *esb.EventChannelChatNotification)

v1.2.4

Nov 27, 2023

v1.2.3

Mar 28, 2023

v1.2.2

Mar 23, 2023

v1.1.1

Mar 18, 2023

v1.1.0

Mar 11, 2023

Changes in this version

type SubRequest

+ Version string

v1.0.4

Mar 9, 2023

Changes in this version

type Credentials

+ func NewStaticCredentials(clientID string, appToken string) Credentials

v1.0.3

Mar 6, 2023

v1.0.2

Jan 17, 2023

Changes in this version

type Status

+ const StatusModeratorRemoved

+ const StatusVersionRemoved

type SubClient

+ func NewSubClientHTTP(credentials Credentials, client *http.Client) *SubClient

v1.0.1

Nov 7, 2021

v1.0.0

Oct 25, 2021

Changes in this version

+ const EventSubSubscriptionsEndpoint

+ func VerifyRequestSignature(req *http.Request, body, secret []byte) (bool, error)

+ type Credentials interface

+ AppToken func() (string, error)

+ ClientID func() (string, error)

+ type IDTracker interface

+ AddAndCheckIfDuplicate func(ctx context.Context, id string) (bool, error)

+ type MapTracker struct

+ func NewMapTracker() *MapTracker

+ func (m *MapTracker) AddAndCheckIfDuplicate(_ context.Context, id string) (bool, error)

+ type Status string

+ const StatusAny

+ const StatusAuthorizationRevoked

+ const StatusEnabled

+ const StatusFailuresExceeded

+ const StatusUserRemoved

+ const StatusVerificationFailed

+ const StatusVerificationPending

+ type SubClient struct

+ func NewSubClient(credentials Credentials) *SubClient

+ func (s *SubClient) GetSubscriptions(ctx context.Context, statusFilter Status) (*esb.RequestStatus, error)

+ func (s *SubClient) Subscribe(ctx context.Context, srq *SubRequest) (*esb.RequestStatus, error)

+ func (s *SubClient) Unsubscribe(ctx context.Context, subscriptionID string) error

+ type SubHandler struct

+ HandleChannelBan func(h *esb.ResponseHeaders, event *esb.EventChannelBan)

+ HandleChannelCheer func(h *esb.ResponseHeaders, event *esb.EventChannelCheer)

+ HandleChannelFollow func(h *esb.ResponseHeaders, event *esb.EventChannelFollow)

+ HandleChannelModeratorAdd func(h *esb.ResponseHeaders, event *esb.EventChannelModeratorAdd)

+ HandleChannelModeratorRemove func(h *esb.ResponseHeaders, event *esb.EventChannelModeratorRemove)

+ HandleChannelPointsRewardAdd func(h *esb.ResponseHeaders, event *esb.EventChannelPointsRewardAdd)

+ HandleChannelPointsRewardRedemptionAdd func(h *esb.ResponseHeaders, event *esb.EventChannelPointsRewardRedemptionAdd)

+ HandleChannelPointsRewardRedemptionUpdate func(h *esb.ResponseHeaders, event *esb.EventChannelPointsRewardRedemptionUpdate)

+ HandleChannelPointsRewardRemove func(h *esb.ResponseHeaders, event *esb.EventChannelPointsRewardRemove)

+ HandleChannelPointsRewardUpdate func(h *esb.ResponseHeaders, event *esb.EventChannelPointsRewardUpdate)

+ HandleChannelPollBegin func(h *esb.ResponseHeaders, event *esb.EventChannelPollBegin)

+ HandleChannelPollEnd func(h *esb.ResponseHeaders, event *esb.EventChannelPollEnd)

+ HandleChannelPollProgress func(h *esb.ResponseHeaders, event *esb.EventChannelPollProgress)

+ HandleChannelPredictionBegin func(h *esb.ResponseHeaders, event *esb.EventChannelPredictionBegin)

+ HandleChannelPredictionEnd func(h *esb.ResponseHeaders, event *esb.EventChannelPredictionEnd)

+ HandleChannelPredictionLock func(h *esb.ResponseHeaders, event *esb.EventChannelPredictionLock)

+ HandleChannelPredictionProgress func(h *esb.ResponseHeaders, event *esb.EventChannelPredictionProgress)

+ HandleChannelRaid func(h *esb.ResponseHeaders, event *esb.EventChannelRaid)

+ HandleChannelSubscribe func(h *esb.ResponseHeaders, event *esb.EventChannelSubscribe)

+ HandleChannelSubscriptionEnd func(h *esb.ResponseHeaders, event *esb.EventChannelSubscriptionEnd)

+ HandleChannelSubscriptionGift func(h *esb.ResponseHeaders, event *esb.EventChannelSubscriptionGift)

+ HandleChannelSubscriptionMessage func(h *esb.ResponseHeaders, event *esb.EventChannelSubscriptionMessage)

+ HandleChannelUnban func(h *esb.ResponseHeaders, event *esb.EventChannelUnban)

+ HandleChannelUpdate func(h *esb.ResponseHeaders, event *esb.EventChannelUpdate)

+ HandleDropEntitlementGrant func(h *esb.ResponseHeaders, event *esb.EventDropEntitlementGrant)

+ HandleExtensionBitsTransactionCreate func(h *esb.ResponseHeaders, event *esb.EventBitsTransactionCreate)

+ HandleGoalBegin func(h *esb.ResponseHeaders, event *esb.EventGoals)

+ HandleGoalEnd func(h *esb.ResponseHeaders, event *esb.EventGoals)

+ HandleGoalProgress func(h *esb.ResponseHeaders, event *esb.EventGoals)

+ HandleHypeTrainBegin func(h *esb.ResponseHeaders, event *esb.EventHypeTrainBegin)

+ HandleHypeTrainEnd func(h *esb.ResponseHeaders, event *esb.EventHypeTrainEnd)

+ HandleHypeTrainProgress func(h *esb.ResponseHeaders, event *esb.EventHypeTrainProgress)

+ HandleStreamOffline func(h *esb.ResponseHeaders, event *esb.EventStreamOffline)

+ HandleStreamOnline func(h *esb.ResponseHeaders, event *esb.EventStreamOnline)

+ HandleUserAuthorizationGrant func(h *esb.ResponseHeaders, event *esb.EventUserAuthorizationGrant)

+ HandleUserAuthorizationRevoke func(h *esb.ResponseHeaders, event *esb.EventUserAuthorizationRevoke)

+ HandleUserUpdate func(h *esb.ResponseHeaders, event *esb.EventUserUpdate)

+ IDTracker IDTracker

+ OnDuplicateNotification func(h *esb.ResponseHeaders)

+ VerifyChallenge func(h *esb.ResponseHeaders, chal *esb.SubscriptionChallenge) bool

+ func NewSubHandler(doSignatureVerification bool, secret []byte) *SubHandler

+ func (s *SubHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type SubRequest struct

+ Callback string

+ Condition interface{}

+ Secret string

+ Type string

+ type TwitchError struct

+ ErrorText string

+ Message string

+ Status int

+ func (t *TwitchError) Error() string

Other modules containing this package

github.com/dnsge/twitch-eventsub-framework/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL