Class representing interactions with the Twitch PubSub Implements the ITwitchPubSub More...

Inheritance diagram for TwitchLib.PubSub.TwitchPubSub:

Public Member Functions
	TwitchPubSub (ILogger< TwitchPubSub > logger=null)
	Constructor for a client that interface's with Twitch's PubSub system. More...

void	SendTopics (string oauth=null, bool unlisten=false)
	Sends the topics. More...

void	ListenToFollows (string channelId)
	Sends a request to listenOn follows coming into a specified channel. More...

void	ListenToChatModeratorActions (string userId, string channelId)
	Sends a request to listenOn timeouts and bans in a specific channel More...

void	ListenToUserModerationNotifications (string myTwitchId, string channelTwitchId)

void	ListenToAutomodQueue (string userTwitchId, string channelTwitchId)
	Sends a request to listen to Automod queued messages in a specific channel More...

void	ListenToChannelExtensionBroadcast (string channelId, string extensionId)
	Sends a request to ListenOn EBS broadcasts sent to a specific extension on a specific channel. More...

void	ListenToBitsEvents (string channelTwitchId)
	Sends request to listenOn bits events in specific channel More...

void	ListenToBitsEventsV2 (string channelTwitchId)
	Sends request to listen to bits events in specific channel More...

void	ListenToVideoPlayback (string channelTwitchId)
	Sends request to listenOn video playback events in specific channel More...

void	ListenToWhispers (string channelTwitchId)
	Sends request to listen to whispers from specific channel. More...

void	ListenToRewards (string channelTwitchId)
	Sends request to listen to rewards from specific channel. More...

void	ListenToChannelPoints (string channelTwitchId)
	Sends request to listen to channel points actions from specific channel. More...

void	ListenToLeaderboards (string channelTwitchId)
	Sends request to listen to leaderboards from specific channel. More...

void	ListenToRaid (string channelTwitchId)
	Sends request to listen to raids 'from' specific channel More...

void	ListenToSubscriptions (string channelId)
	Sends request to listen to channel subscriptions. More...

void	ListenToPredictions (string channelTwitchId)
	Sends request to listen to channel predictions. More...

void	Connect ()
	Method to connect to Twitch's PubSub service. You MUST listen toOnConnected event and listen to a Topic within 15 seconds of connecting (or be disconnected) More...

void	Disconnect ()
	What do you think it does? :) More...

void	TestMessageParser (string testJsonString)
	This method will send passed json text to the message parser in order to allow forOn-demand parser testing. More...

void	Connect ()
	Connects this instance. More...

void	Disconnect ()
	Disconnects this instance. More...

void	ListenToBitsEvents (string channelTwitchId)
	Listens to bits events. More...

void	ListenToChannelExtensionBroadcast (string channelId, string extensionId)
	Listens to extension channel broadcast messages. More...

void	ListenToChatModeratorActions (string myTwitchId, string channelTwitchId)
	Listens to chat moderator actions. More...

void	ListenToFollows (string channelId)
	Listens to follows. More...

void	ListenToSubscriptions (string channelId)
	Listens to subscriptions. More...

void	ListenToVideoPlayback (string channelName)
	Listens to video playback. More...

void	ListenToWhispers (string channelTwitchId)
	Listens to whispers. More...

void	ListenToRewards (string channelTwitchId)
	Listens to rewards More...

void	ListenToChannelPoints (string channelTwitchId)
	Listens to channel points. More...

void	ListenToLeaderboards (string channelTwitchId)
	Listens to leaderboards More...

void	ListenToRaid (string channelTwitchId)
	Listens to raids More...

void	ListenToPredictions (string channelTwitchId)
	Listens to predictions More...

void	SendTopics (string oauth=null, bool unlisten=false)
	Sends the topics. More...

void	TestMessageParser (string testJsonString)
	Tests the message parser. More...

Events
EventHandler	OnPubSubServiceConnected
	Fires when PubSub Service is connected. More...

EventHandler< OnPubSubServiceErrorArgs >	OnPubSubServiceError
	Fires when PubSub Service has an error. More...

EventHandler	OnPubSubServiceClosed
	Fires when PubSub Service is closed. More...

EventHandler< OnListenResponseArgs >	OnListenResponse
	Fires when PubSub receives any response. More...

EventHandler< OnTimeoutArgs >	OnTimeout
	Fires when PubSub receives notice a viewer gets a timeout. More...

EventHandler< OnBanArgs >	OnBan
	Fires when PubSub receives notice a viewer gets banned. More...

EventHandler< OnMessageDeletedArgs >	OnMessageDeleted
	Fires when PubSub receives notice a message was deleted. More...

EventHandler< OnUnbanArgs >	OnUnban
	Fires when PubSub receives notice a viewer gets unbanned. More...

EventHandler< OnUntimeoutArgs >	OnUntimeout
	Fires when PubSub receives notice a viewer gets a timeout removed. More...

EventHandler< OnHostArgs >	OnHost
	Fires when PubSub receives notice that the channel being listened to is hosting another channel. More...

EventHandler< OnSubscribersOnlyArgs >	OnSubscribersOnly
	Fires when PubSub receives notice that Sub-Only Mode gets turned on. More...

EventHandler< OnSubscribersOnlyOffArgs >	OnSubscribersOnlyOff
	Fires when PubSub receives notice that Sub-Only Mode gets turned off. More...

EventHandler< OnClearArgs >	OnClear
	Fires when PubSub receives notice that chat gets cleared. More...

EventHandler< OnEmoteOnlyArgs >	OnEmoteOnly
	Fires when PubSub receives notice that Emote-Only Mode gets turned on. More...

EventHandler< OnEmoteOnlyOffArgs >	OnEmoteOnlyOff
	Fires when PubSub receives notice that Emote-Only Mode gets turned off. More...

EventHandler< OnR9kBetaArgs >	OnR9kBeta
	Fires when PubSub receives notice that the chat option R9kBeta gets turned on. More...

EventHandler< OnR9kBetaOffArgs >	OnR9kBetaOff
	Fires when PubSub receives notice that the chat option R9kBeta gets turned off. More...

EventHandler< OnBitsReceivedArgs >	OnBitsReceived
	Fires when PubSub receives notice of a bit donation. More...

EventHandler< OnBitsReceivedV2Args >	OnBitsReceivedV2
	Fires when PubSub receives a bits message. More...

EventHandler< OnStreamUpArgs >	OnStreamUp
	Fires when PubSub receives notice that the stream of the channel being listened to goes online. More...

EventHandler< OnStreamDownArgs >	OnStreamDown
	Fires when PubSub receives notice that the stream of the channel being listened to goes offline. More...

EventHandler< OnViewCountArgs >	OnViewCount
	Fires when PubSub receives notice view count has changed. More...

EventHandler< OnWhisperArgs >	OnWhisper
	Fires when PubSub receives a whisper. More...

EventHandler< OnChannelSubscriptionArgs >	OnChannelSubscription
	Fires when PubSub receives notice when the channel being listened to gets a subscription. More...

EventHandler< OnChannelExtensionBroadcastArgs >	OnChannelExtensionBroadcast
	Fires when PubSub receives a message sent to the specified extension on the specified channel. More...

EventHandler< OnFollowArgs >	OnFollow
	Fires when PubSub receives notice when a user follows the designated channel. More...

EventHandler< OnCustomRewardCreatedArgs >	OnCustomRewardCreated
	Fires when PubSub receives notice when a custom reward has been created on the specified channel. /summary> More...

EventHandler< OnCustomRewardUpdatedArgs >	OnCustomRewardUpdated
	Fires when PubSub receives notice when a custom reward has been changed on the specified channel. /summary> More...

EventHandler< OnCustomRewardDeletedArgs >	OnCustomRewardDeleted
	Fires when PubSub receives notice when a reward has been deleted on the specified channel. More...

EventHandler< OnRewardRedeemedArgs >	OnRewardRedeemed
	Fires when PubSub receives notice when a reward has been redeemed on the specified channel. More...

EventHandler< OnChannelPointsRewardRedeemedArgs >	OnChannelPointsRewardRedeemed
	Fires when PubSub receives a message indicating a channel points reward was redeemed. More...

EventHandler< OnLeaderboardEventArgs >	OnLeaderboardSubs
	Fires when PubSub receives notice when the leaderboard changes for subs. More...

EventHandler< OnLeaderboardEventArgs >	OnLeaderboardBits
	Fires when PubSub receives notice when the leaderboard changes for Bits. More...

EventHandler< OnRaidUpdateArgs >	OnRaidUpdate
	Fires when PubSub receives notice when a channel prepares a raid More...

EventHandler< OnRaidUpdateV2Args >	OnRaidUpdateV2
	Fires when PubSub receives notice when a channel prepares a raid More...

EventHandler< OnRaidGoArgs >	OnRaidGo
	Fires when PubSub receives notice when a channel starts the raid More...

EventHandler< OnLogArgs >	OnLog
	Fires when PubSub receives any data from Twitch More...

EventHandler< OnCommercialArgs >	OnCommercial
	Fires when PubSub receives notice that the stream is playing a commercial. More...

EventHandler< OnPredictionArgs >	OnPrediction
	Fires when PubSub receives notice that a prediction has started or updated. More...

EventHandler< OnAutomodCaughtMessageArgs >	OnAutomodCaughtMessage
	Fires when Automod updates a held message. More...

EventHandler< OnAutomodCaughtUserMessage >	OnAutomodCaughtUserMessage
	Fires when a moderation event hits a user More...

Events inherited from TwitchLib.PubSub.Interfaces.ITwitchPubSub
EventHandler< OnBanArgs >	OnBan
	Occurs when [on ban]. More...

EventHandler< OnBitsReceivedArgs >	OnBitsReceived
	Occurs when [on bits received]. More...

EventHandler< OnChannelExtensionBroadcastArgs >	OnChannelExtensionBroadcast
	Occurs when [on channel extension broadcast]. More...

EventHandler< OnChannelSubscriptionArgs >	OnChannelSubscription
	Occurs when [on channel subscription]. More...

EventHandler< OnClearArgs >	OnClear
	Occurs when [on clear]. More...

EventHandler< OnEmoteOnlyArgs >	OnEmoteOnly
	Occurs when [on emote only]. More...

EventHandler< OnEmoteOnlyOffArgs >	OnEmoteOnlyOff
	Occurs when [on emote only off]. More...

EventHandler< OnFollowArgs >	OnFollow
	Occurs when [on follow]. More...

EventHandler< OnHostArgs >	OnHost
	Occurs when [on host]. More...

EventHandler< OnMessageDeletedArgs >	OnMessageDeleted
	Occurs when [on message deleted]. More...

EventHandler< OnListenResponseArgs >	OnListenResponse
	Occurs when [on listen response]. More...

EventHandler	OnPubSubServiceClosed
	Occurs when [on pub sub service closed]. More...

EventHandler	OnPubSubServiceConnected
	Occurs when [on pub sub service connected]. More...

EventHandler< OnPubSubServiceErrorArgs >	OnPubSubServiceError
	Occurs when [on pub sub service error]. More...

EventHandler< OnR9kBetaArgs >	OnR9kBeta
	Occurs when [on R9K beta]. More...

EventHandler< OnR9kBetaOffArgs >	OnR9kBetaOff
	Occurs when [on R9K beta off]. More...

EventHandler< OnStreamDownArgs >	OnStreamDown
	Occurs when [on stream down]. More...

EventHandler< OnStreamUpArgs >	OnStreamUp
	Occurs when [on stream up]. More...

EventHandler< OnSubscribersOnlyArgs >	OnSubscribersOnly
	Occurs when [on subscribers only]. More...

EventHandler< OnSubscribersOnlyOffArgs >	OnSubscribersOnlyOff
	Occurs when [on subscribers only off]. More...

EventHandler< OnTimeoutArgs >	OnTimeout
	Occurs when [on timeout]. More...

EventHandler< OnUnbanArgs >	OnUnban
	Occurs when [on unban]. More...

EventHandler< OnUntimeoutArgs >	OnUntimeout
	Occurs when [on untimeout]. More...

EventHandler< OnViewCountArgs >	OnViewCount
	Occurs when [on view count]. More...

EventHandler< OnWhisperArgs >	OnWhisper
	Occurs when [on whisper]. More...

EventHandler< OnCustomRewardCreatedArgs >	OnCustomRewardCreated
	Occurs when [on reward created] /summary> More...

EventHandler< OnCustomRewardUpdatedArgs >	OnCustomRewardUpdated
	Occurs when [on reward updated] /summary> More...

EventHandler< OnCustomRewardDeletedArgs >	OnCustomRewardDeleted
	Occurs when [on reward deleted] More...

EventHandler< OnRewardRedeemedArgs >	OnRewardRedeemed
	Occurs when [on reward redeemed] More...

EventHandler< OnChannelPointsRewardRedeemedArgs >	OnChannelPointsRewardRedeemed
	Occurs when [on reward redeemed] More...

EventHandler< OnLeaderboardEventArgs >	OnLeaderboardSubs
	Occurs when [on leaderboard subs]. More...

EventHandler< OnLeaderboardEventArgs >	OnLeaderboardBits
	Occurs when [on leaderboard bits]. More...

EventHandler< OnRaidUpdateArgs >	OnRaidUpdate
	Occurs when [on raid update] More...

EventHandler< OnRaidUpdateV2Args >	OnRaidUpdateV2
	Occurs when [on raid update v2] More...

EventHandler< OnRaidGoArgs >	OnRaidGo
	Occurs when [on raid go] More...

EventHandler< OnLogArgs >	OnLog
	Occurs when [on log]. More...

EventHandler< OnCommercialArgs >	OnCommercial
	Occurs when [on commercial]. More...

EventHandler< OnPredictionArgs >	OnPrediction
	Occurs when [on prediction]. More...

Detailed Description

Class representing interactions with the Twitch PubSub Implements the ITwitchPubSub

See also: ITwitchPubSub

Constructor & Destructor Documentation

◆ TwitchPubSub()

TwitchLib.PubSub.TwitchPubSub.TwitchPubSub ( ILogger< TwitchPubSub > logger = null )

Constructor for a client that interface's with Twitch's PubSub system.

Parameters

logger Optional ILogger param to enable logging

Member Function Documentation

◆ Connect()

void TwitchLib.PubSub.TwitchPubSub.Connect ( )

Method to connect to Twitch's PubSub service. You MUST listen toOnConnected event and listen to a Topic within 15 seconds of connecting (or be disconnected)

Connects this instance.

Implements TwitchLib.PubSub.Interfaces.ITwitchPubSub.

◆ Disconnect()

void TwitchLib.PubSub.TwitchPubSub.Disconnect ( )

What do you think it does? :)

Disconnects this instance.

Implements TwitchLib.PubSub.Interfaces.ITwitchPubSub.

◆ ListenToAutomodQueue()

void TwitchLib.PubSub.TwitchPubSub.ListenToAutomodQueue	(	string	userTwitchId,
		string	channelTwitchId
	)

Sends a request to listen to Automod queued messages in a specific channel

Parameters

userTwitchId	A moderator's twitch account's ID
channelTwitchId	Channel ID who has previous parameter's moderator

◆ ListenToBitsEvents()

void TwitchLib.PubSub.TwitchPubSub.ListenToBitsEvents ( string channelTwitchId )

Sends request to listenOn bits events in specific channel

Listens to bits events.

Parameters

channelTwitchId The channel twitch identifier.

Parameters

channelTwitchId Channel Id of channel to listen to bits on (can be fetched from TwitchApi)

Implements TwitchLib.PubSub.Interfaces.ITwitchPubSub.

◆ ListenToBitsEventsV2()

void TwitchLib.PubSub.TwitchPubSub.ListenToBitsEventsV2 ( string channelTwitchId )

Sends request to listen to bits events in specific channel

Parameters

channelTwitchId Channel Id of channel to listen to bits on (can be fetched from TwitchApi)

◆ ListenToChannelExtensionBroadcast()

void TwitchLib.PubSub.TwitchPubSub.ListenToChannelExtensionBroadcast	(	string	channelId,
		string	extensionId
	)

Sends a request to ListenOn EBS broadcasts sent to a specific extension on a specific channel.

Listens to extension channel broadcast messages.

Parameters

channelId	The channel twitch identifier.
extensionId	The extension identifier.

Parameters

channelId	Id of the channel that the extension lives on.
extensionId	The extension identifier.

Implements TwitchLib.PubSub.Interfaces.ITwitchPubSub.

◆ ListenToChannelPoints()

void TwitchLib.PubSub.TwitchPubSub.ListenToChannelPoints ( string channelTwitchId )

Sends request to listen to channel points actions from specific channel.

Listens to channel points.

Parameters

channelTwitchId The channel twitch identifier.

Parameters

channelTwitchId Channel to listen to rewards on.

Implements TwitchLib.PubSub.Interfaces.ITwitchPubSub.

◆ ListenToChatModeratorActions()

void TwitchLib.PubSub.TwitchPubSub.ListenToChatModeratorActions	(	string	userId,
		string	channelId
	)

Sends a request to listenOn timeouts and bans in a specific channel

Listens to chat moderator actions.

Parameters

myTwitchId	My twitch identifier.
channelTwitchId	The channel twitch identifier.

Parameters

userId	A moderator's twitch account's ID (can be fetched from TwitchApi)
channelId	Channel ID who has previous parameter's moderator (can be fetched from TwitchApi)

Implements TwitchLib.PubSub.Interfaces.ITwitchPubSub.

◆ ListenToFollows()

void TwitchLib.PubSub.TwitchPubSub.ListenToFollows ( string channelId )

Sends a request to listenOn follows coming into a specified channel.

Listens to follows.

Parameters

channelId The channel twitch identifier.

Parameters

channelId The channel identifier.

Implements TwitchLib.PubSub.Interfaces.ITwitchPubSub.

◆ ListenToLeaderboards()

void TwitchLib.PubSub.TwitchPubSub.ListenToLeaderboards ( string channelTwitchId )

Sends request to listen to leaderboards from specific channel.

Listens to leaderboards

Parameters

channelTwitchId The channel twitch identifier.

Parameters

channelTwitchId Channel to listen to leaderboards on.

Implements TwitchLib.PubSub.Interfaces.ITwitchPubSub.

◆ ListenToPredictions()

void TwitchLib.PubSub.TwitchPubSub.ListenToPredictions ( string channelTwitchId )

Sends request to listen to channel predictions.

Listens to predictions

Parameters

channelTwitchId The channel twitch identifier.

Parameters

channelTwitchId

Implements TwitchLib.PubSub.Interfaces.ITwitchPubSub.

◆ ListenToRaid()

void TwitchLib.PubSub.TwitchPubSub.ListenToRaid ( string channelTwitchId )

Sends request to listen to raids 'from' specific channel

Listens to raids

Parameters

channelTwitchId The channel twitch identifier.

Parameters

channelTwitchId Channel to listen to raids get prepared on.

Implements TwitchLib.PubSub.Interfaces.ITwitchPubSub.

◆ ListenToRewards()

void TwitchLib.PubSub.TwitchPubSub.ListenToRewards ( string channelTwitchId )

Sends request to listen to rewards from specific channel.

Listens to rewards

Parameters

channelTwitchId The channel twitch identifier.

Parameters

channelTwitchId Channel to listen to rewards on.

Implements TwitchLib.PubSub.Interfaces.ITwitchPubSub.

◆ ListenToSubscriptions()

void TwitchLib.PubSub.TwitchPubSub.ListenToSubscriptions ( string channelId )

Sends request to listen to channel subscriptions.

Listens to subscriptions.

Parameters

channelId The channel identifier.

Parameters

channelId Id of the channel to listen to.

Implements TwitchLib.PubSub.Interfaces.ITwitchPubSub.

◆ ListenToUserModerationNotifications()

void TwitchLib.PubSub.TwitchPubSub.ListenToUserModerationNotifications	(	string	myTwitchId,
		string	channelTwitchId
	)

◆ ListenToVideoPlayback()

void TwitchLib.PubSub.TwitchPubSub.ListenToVideoPlayback ( string channelTwitchId )

Sends request to listenOn video playback events in specific channel

Listens to video playback.

Parameters

channelName Name of the channel.

Parameters

channelTwitchId Id of channel to listen to playback events in.

Implements TwitchLib.PubSub.Interfaces.ITwitchPubSub.

◆ ListenToWhispers()

void TwitchLib.PubSub.TwitchPubSub.ListenToWhispers ( string channelTwitchId )

Sends request to listen to whispers from specific channel.

Listens to whispers.

Parameters

channelTwitchId The channel twitch identifier.

Parameters

channelTwitchId Channel to listen to whispers on.

Implements TwitchLib.PubSub.Interfaces.ITwitchPubSub.

◆ SendTopics()

void TwitchLib.PubSub.TwitchPubSub.SendTopics	(	string	oauth = `null`,
		bool	unlisten = `false`
	)

Sends the topics.

Parameters

oauth	The oauth.
unlisten	if set to `true` [unlisten].

Parameters

oauth	The oauth.
unlisten	if set to `true` [unlisten].

Implements TwitchLib.PubSub.Interfaces.ITwitchPubSub.

◆ TestMessageParser()

void TwitchLib.PubSub.TwitchPubSub.TestMessageParser ( string testJsonString )

This method will send passed json text to the message parser in order to allow forOn-demand parser testing.

Tests the message parser.

Parameters

testJsonString The test json string.

Parameters

testJsonString The test json string.

Implements TwitchLib.PubSub.Interfaces.ITwitchPubSub.

Event Documentation

◆ OnAutomodCaughtMessage

EventHandler<OnAutomodCaughtMessageArgs> TwitchLib.PubSub.TwitchPubSub.OnAutomodCaughtMessage

Fires when Automod updates a held message.

◆ OnAutomodCaughtUserMessage

EventHandler<OnAutomodCaughtUserMessage> TwitchLib.PubSub.TwitchPubSub.OnAutomodCaughtUserMessage

Fires when a moderation event hits a user

◆ OnBan

EventHandler<OnBanArgs> TwitchLib.PubSub.TwitchPubSub.OnBan

Fires when PubSub receives notice a viewer gets banned.

◆ OnBitsReceived

EventHandler<OnBitsReceivedArgs> TwitchLib.PubSub.TwitchPubSub.OnBitsReceived

Fires when PubSub receives notice of a bit donation.

◆ OnBitsReceivedV2

EventHandler<OnBitsReceivedV2Args> TwitchLib.PubSub.TwitchPubSub.OnBitsReceivedV2

Fires when PubSub receives a bits message.

◆ OnChannelExtensionBroadcast

EventHandler<OnChannelExtensionBroadcastArgs> TwitchLib.PubSub.TwitchPubSub.OnChannelExtensionBroadcast

Fires when PubSub receives a message sent to the specified extension on the specified channel.

◆ OnChannelPointsRewardRedeemed

EventHandler<OnChannelPointsRewardRedeemedArgs> TwitchLib.PubSub.TwitchPubSub.OnChannelPointsRewardRedeemed

Fires when PubSub receives a message indicating a channel points reward was redeemed.

◆ OnChannelSubscription

EventHandler<OnChannelSubscriptionArgs> TwitchLib.PubSub.TwitchPubSub.OnChannelSubscription

Fires when PubSub receives notice when the channel being listened to gets a subscription.

◆ OnClear

EventHandler<OnClearArgs> TwitchLib.PubSub.TwitchPubSub.OnClear

Fires when PubSub receives notice that chat gets cleared.

◆ OnCommercial

EventHandler<OnCommercialArgs> TwitchLib.PubSub.TwitchPubSub.OnCommercial

Fires when PubSub receives notice that the stream is playing a commercial.

◆ OnCustomRewardCreated

EventHandler<OnCustomRewardCreatedArgs> TwitchLib.PubSub.TwitchPubSub.OnCustomRewardCreated

Fires when PubSub receives notice when a custom reward has been created on the specified channel. /summary>

◆ OnCustomRewardDeleted

EventHandler<OnCustomRewardDeletedArgs> TwitchLib.PubSub.TwitchPubSub.OnCustomRewardDeleted

Fires when PubSub receives notice when a reward has been deleted on the specified channel.

◆ OnCustomRewardUpdated

EventHandler<OnCustomRewardUpdatedArgs> TwitchLib.PubSub.TwitchPubSub.OnCustomRewardUpdated

Fires when PubSub receives notice when a custom reward has been changed on the specified channel. /summary>

◆ OnEmoteOnly

EventHandler<OnEmoteOnlyArgs> TwitchLib.PubSub.TwitchPubSub.OnEmoteOnly

Fires when PubSub receives notice that Emote-Only Mode gets turned on.

◆ OnEmoteOnlyOff

EventHandler<OnEmoteOnlyOffArgs> TwitchLib.PubSub.TwitchPubSub.OnEmoteOnlyOff

Fires when PubSub receives notice that Emote-Only Mode gets turned off.

◆ OnFollow

EventHandler<OnFollowArgs> TwitchLib.PubSub.TwitchPubSub.OnFollow

Fires when PubSub receives notice when a user follows the designated channel.

◆ OnHost

EventHandler<OnHostArgs> TwitchLib.PubSub.TwitchPubSub.OnHost

Fires when PubSub receives notice that the channel being listened to is hosting another channel.

◆ OnLeaderboardBits

EventHandler<OnLeaderboardEventArgs> TwitchLib.PubSub.TwitchPubSub.OnLeaderboardBits

Fires when PubSub receives notice when the leaderboard changes for Bits.

◆ OnLeaderboardSubs

EventHandler<OnLeaderboardEventArgs> TwitchLib.PubSub.TwitchPubSub.OnLeaderboardSubs

Fires when PubSub receives notice when the leaderboard changes for subs.

◆ OnListenResponse

EventHandler<OnListenResponseArgs> TwitchLib.PubSub.TwitchPubSub.OnListenResponse

Fires when PubSub receives any response.

◆ OnLog

EventHandler<OnLogArgs> TwitchLib.PubSub.TwitchPubSub.OnLog

Fires when PubSub receives any data from Twitch

◆ OnMessageDeleted

EventHandler<OnMessageDeletedArgs> TwitchLib.PubSub.TwitchPubSub.OnMessageDeleted

Fires when PubSub receives notice a message was deleted.

◆ OnPrediction

EventHandler<OnPredictionArgs> TwitchLib.PubSub.TwitchPubSub.OnPrediction

Fires when PubSub receives notice that a prediction has started or updated.

◆ OnPubSubServiceClosed

EventHandler TwitchLib.PubSub.TwitchPubSub.OnPubSubServiceClosed

Fires when PubSub Service is closed.

◆ OnPubSubServiceConnected

EventHandler TwitchLib.PubSub.TwitchPubSub.OnPubSubServiceConnected

Fires when PubSub Service is connected.

◆ OnPubSubServiceError

EventHandler<OnPubSubServiceErrorArgs> TwitchLib.PubSub.TwitchPubSub.OnPubSubServiceError

Fires when PubSub Service has an error.

◆ OnR9kBeta

EventHandler<OnR9kBetaArgs> TwitchLib.PubSub.TwitchPubSub.OnR9kBeta

Fires when PubSub receives notice that the chat option R9kBeta gets turned on.

◆ OnR9kBetaOff

EventHandler<OnR9kBetaOffArgs> TwitchLib.PubSub.TwitchPubSub.OnR9kBetaOff

Fires when PubSub receives notice that the chat option R9kBeta gets turned off.

◆ OnRaidGo

EventHandler<OnRaidGoArgs> TwitchLib.PubSub.TwitchPubSub.OnRaidGo

Fires when PubSub receives notice when a channel starts the raid

◆ OnRaidUpdate

EventHandler<OnRaidUpdateArgs> TwitchLib.PubSub.TwitchPubSub.OnRaidUpdate

Fires when PubSub receives notice when a channel prepares a raid

◆ OnRaidUpdateV2

EventHandler<OnRaidUpdateV2Args> TwitchLib.PubSub.TwitchPubSub.OnRaidUpdateV2

Fires when PubSub receives notice when a channel prepares a raid

◆ OnRewardRedeemed

EventHandler<OnRewardRedeemedArgs> TwitchLib.PubSub.TwitchPubSub.OnRewardRedeemed

Fires when PubSub receives notice when a reward has been redeemed on the specified channel.

◆ OnStreamDown

EventHandler<OnStreamDownArgs> TwitchLib.PubSub.TwitchPubSub.OnStreamDown

Fires when PubSub receives notice that the stream of the channel being listened to goes offline.

◆ OnStreamUp

EventHandler<OnStreamUpArgs> TwitchLib.PubSub.TwitchPubSub.OnStreamUp

Fires when PubSub receives notice that the stream of the channel being listened to goes online.

◆ OnSubscribersOnly

EventHandler<OnSubscribersOnlyArgs> TwitchLib.PubSub.TwitchPubSub.OnSubscribersOnly

Fires when PubSub receives notice that Sub-Only Mode gets turned on.

◆ OnSubscribersOnlyOff

EventHandler<OnSubscribersOnlyOffArgs> TwitchLib.PubSub.TwitchPubSub.OnSubscribersOnlyOff

Fires when PubSub receives notice that Sub-Only Mode gets turned off.

◆ OnTimeout

EventHandler<OnTimeoutArgs> TwitchLib.PubSub.TwitchPubSub.OnTimeout

Fires when PubSub receives notice a viewer gets a timeout.

◆ OnUnban

EventHandler<OnUnbanArgs> TwitchLib.PubSub.TwitchPubSub.OnUnban

Fires when PubSub receives notice a viewer gets unbanned.

◆ OnUntimeout

EventHandler<OnUntimeoutArgs> TwitchLib.PubSub.TwitchPubSub.OnUntimeout

Fires when PubSub receives notice a viewer gets a timeout removed.

◆ OnViewCount

EventHandler<OnViewCountArgs> TwitchLib.PubSub.TwitchPubSub.OnViewCount

Fires when PubSub receives notice view count has changed.

◆ OnWhisper

EventHandler<OnWhisperArgs> TwitchLib.PubSub.TwitchPubSub.OnWhisper

Fires when PubSub receives a whisper.

The documentation for this class was generated from the following file:

TwitchLib.PubSub/TwitchLib.PubSub/TwitchPubSub.cs

Public Member Functions

Events

Detailed Description

Constructor & Destructor Documentation

◆ TwitchPubSub()

Member Function Documentation

◆ Connect()

◆ Disconnect()

◆ ListenToAutomodQueue()

◆ ListenToBitsEvents()

◆ ListenToBitsEventsV2()

◆ ListenToChannelExtensionBroadcast()

◆ ListenToChannelPoints()

◆ ListenToChatModeratorActions()

◆ ListenToFollows()

◆ ListenToLeaderboards()

◆ ListenToPredictions()

◆ ListenToRaid()

◆ ListenToRewards()

◆ ListenToSubscriptions()

◆ ListenToUserModerationNotifications()

◆ ListenToVideoPlayback()

◆ ListenToWhispers()

◆ SendTopics()

◆ TestMessageParser()

Event Documentation

◆ OnAutomodCaughtMessage

◆ OnAutomodCaughtUserMessage

◆ OnBan

◆ OnBitsReceived

◆ OnBitsReceivedV2

◆ OnChannelExtensionBroadcast

◆ OnChannelPointsRewardRedeemed

◆ OnChannelSubscription

◆ OnClear

◆ OnCommercial

◆ OnCustomRewardCreated

◆ OnCustomRewardDeleted

◆ OnCustomRewardUpdated

◆ OnEmoteOnly

◆ OnEmoteOnlyOff

◆ OnFollow

◆ OnHost

◆ OnLeaderboardBits

◆ OnLeaderboardSubs

◆ OnListenResponse

◆ OnLog

◆ OnMessageDeleted

◆ OnPrediction

◆ OnPubSubServiceClosed

◆ OnPubSubServiceConnected

◆ OnPubSubServiceError

◆ OnR9kBeta

◆ OnR9kBetaOff

◆ OnRaidGo

◆ OnRaidUpdate

◆ OnRaidUpdateV2

◆ OnRewardRedeemed

◆ OnStreamDown

◆ OnStreamUp

◆ OnSubscribersOnly

◆ OnSubscribersOnlyOff

◆ OnTimeout

◆ OnUnban

◆ OnUntimeout

◆ OnViewCount

◆ OnWhisper