twitch_integration

Documentation

Index

• type OnClearChatMessage
• type OnClearMessage
• type OnConnect
• type OnGlobalUserStateMessage
• type OnNamesMessage
• type OnNoticeMessage
• type OnPingMessage
• type OnPingSent
• type OnPongMessage
• type OnPrivateMessage
• type OnReconnectMessage
• type OnRoomStateMessage
• type OnUnsetMessage
• type OnUserJoinMessage
• type OnUserNoticeMessage
• type OnUserPartMessage
• type OnUserStateMessage
• type OnWhisperMessage
• type Service
  • func (s *Service) Config() (*config_file_manager.Config, error)
  • func (s *Service) ConfigFileName() string
  • func (s *Service) DefaultConfig() (cfg config_file_manager.Config)
  • func (s *Service) DependenciesResolved() bool
  • func (s *Service) Init(mesh servicemesh.Mesh)
  • func (s *Service) Logger() *slog.Logger
  • func (s *Service) Name() string
  • func (s *Service) Ready() bool
  • func (s *Service) ResolveDependencies(services []servicemesh.Service)
  • func (s *Service) SetLogger(logger *slog.Logger)
• type UsesEntireTwitchIntegration

Types

type OnClearChatMessage

type OnClearChatMessage interface {
	OnTwitchClearChatMessage(message twitch.ClearChatMessage)
}

OnClearChatMessage is an interface that represents a handler for the OnClearChatMessage event, which is triggered when a clear chat message is received from Twitch.

type OnClearMessage

type OnClearMessage interface {
	OnTwitchClearMessage(message twitch.ClearMessage)
}

OnClearMessage is an interface that represents a handler for the OnClearMessage event, which is triggered when a clear message is received from Twitch.

type OnConnect

type OnConnect interface {
	OnTwitchConnect()
}

OnConnect is an interface that represents a handler for the OnConnect event, which is triggered when the service connects to Twitch.

type OnGlobalUserStateMessage

type OnGlobalUserStateMessage interface {
	OnTwitchGlobalUserStateMessage(message twitch.GlobalUserStateMessage)
}

OnGlobalUserStateMessage is an interface that represents a handler for the OnGlobalUserStateMessage event, which is triggered when a global user state message is received from Twitch.

type OnNamesMessage

type OnNamesMessage interface {
	OnTwitchNamesMessage(message twitch.NamesMessage)
}

OnNamesMessage is an interface that represents a handler for the OnNamesMessage event, which is triggered when a names message is received from Twitch.

type OnNoticeMessage

type OnNoticeMessage interface {
	OnTwitchNoticeMessage(message twitch.NoticeMessage)
}

OnNoticeMessage is an interface that represents a handler for the OnNoticeMessage event, which is triggered when a notice message is received from Twitch.

type OnPingMessage

type OnPingMessage interface {
	OnTwitchPingMessage(message twitch.PingMessage)
}

OnPingMessage is an interface that represents a handler for the OnPingMessage event, which is triggered when a ping message is received from Twitch.

type OnPingSent

type OnPingSent interface {
	OnTwitchPingSent()
}

OnPingSent is an interface that represents a handler for the OnPingSent event, which is triggered when a ping is sent to Twitch.

type OnPongMessage

type OnPongMessage interface {
	OnTwitchPongMessage(message twitch.PongMessage)
}

OnPongMessage is an interface that represents a handler for the OnPongMessage event, which is triggered when a pong message is received from Twitch.

type OnPrivateMessage

type OnPrivateMessage interface {
	OnTwitchPrivateMessage(message twitch.PrivateMessage)
}

OnPrivateMessage is an interface that represents a handler for the OnPrivateMessage event, which is triggered when a private message is received from Twitch.

type OnReconnectMessage

type OnReconnectMessage interface {
	OnTwitchReconnectMessage(message twitch.ReconnectMessage)
}

OnReconnectMessage is an interface that represents a handler for the OnReconnectMessage event, which is triggered when a reconnect message is received from Twitch.

type OnRoomStateMessage

type OnRoomStateMessage interface {
	OnTwitchRoomStateMessage(message twitch.RoomStateMessage)
}

OnRoomStateMessage is an interface that represents a handler for the OnRoomStateMessage event, which is triggered when a room state message is received from Twitch.

type OnUnsetMessage

type OnUnsetMessage interface {
	OnTwitchUnsetMessage(message twitch.RawMessage)
}

OnUnsetMessage is an interface that represents a handler for the OnUnsetMessage event, which is triggered when an unset message is received from Twitch.

type OnUserJoinMessage

type OnUserJoinMessage interface {
	OnTwitchUserJoinMessage(message twitch.UserJoinMessage)
}

OnUserJoinMessage is an interface that represents a handler for the OnUserJoinMessage event, which is triggered when a user join message is received from Twitch.

type OnUserNoticeMessage

type OnUserNoticeMessage interface {
	OnTwitchUserNoticeMessage(message twitch.UserNoticeMessage)
}

OnUserNoticeMessage is an interface that represents a handler for the OnUserNoticeMessage event, which is triggered when a user notice message is received from Twitch.

type OnUserPartMessage

type OnUserPartMessage interface {
	OnTwitchUserPartMessage(message twitch.UserPartMessage)
}

OnUserPartMessage is an interface that represents a handler for the OnUserPartMessage event, which is triggered when a user part message is received from Twitch.

type OnUserStateMessage

type OnUserStateMessage interface {
	OnTwitchUserStateMessage(message twitch.UserStateMessage)
}

OnUserStateMessage is an interface that represents a handler for the OnUserStateMessage event, which is triggered when a user state message is received from Twitch.

type OnWhisperMessage

type OnWhisperMessage interface {
	OnTwitchWhisperMessage(message twitch.WhisperMessage)
}

OnWhisperMessage is an interface that represents a handler for the OnWhisperMessage event, which is triggered when a whisper message is received from Twitch.

type Service

type Service struct {
	// contains filtered or unexported fields
}

func (*Service) Config

func (s *Service) Config() (*config_file_manager.Config, error)

func (*Service) ConfigFileName

func (s *Service) ConfigFileName() string

func (*Service) DefaultConfig

func (s *Service) DefaultConfig() (cfg config_file_manager.Config)

func (*Service) DependenciesResolved

func (s *Service) DependenciesResolved() bool

func (*Service) Init

func (s *Service) Init(mesh servicemesh.Mesh)

func (*Service) Logger

func (s *Service) Logger() *slog.Logger

func (*Service) Name

func (s *Service) Name() string

func (*Service) Ready

func (s *Service) Ready() bool

func (*Service) ResolveDependencies

func (s *Service) ResolveDependencies(services []servicemesh.Service)

func (*Service) SetLogger

func (s *Service) SetLogger(logger *slog.Logger)

type UsesEntireTwitchIntegration

type UsesEntireTwitchIntegration interface {
	OnConnect
	OnWhisperMessage
	OnPrivateMessage
	OnClearChatMessage
	OnClearMessage
	OnRoomStateMessage
	OnUserNoticeMessage
	OnUserStateMessage
	OnGlobalUserStateMessage
	OnNoticeMessage
	OnUserJoinMessage
	OnUserPartMessage
	OnReconnectMessage
	OnNamesMessage
	OnPingMessage
	OnPongMessage
	OnUnsetMessage
	OnPingSent
}

UsesEntireTwitchIntegration is an optional interface that represents a service capable of handling all Twitch integration events. By implementing this interface, the service can process events like connecting, whispers, private messages, chat clearing, room state, user notices, user state, global user state, notices, user joins/parts, reconnection, names list, pings, pongs, unset messages, and ping tracking. Implementing this interface provides comprehensive Twitch integration event coverage. Other services can implement individual handlers for specific events.