TwitchLib.PubSub.Interfaces.ITwitchPubSub Interface Reference

Interface ITwitchPubSub More...

Inheritance diagram for TwitchLib.PubSub.Interfaces.ITwitchPubSub:

Public Member Functions
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< 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

Interface ITwitchPubSub

Member Function Documentation

Connect()

void TwitchLib.PubSub.Interfaces.ITwitchPubSub.Connect

(

)

Connects this instance.

Implemented in TwitchLib.PubSub.TwitchPubSub.

Disconnect()

void TwitchLib.PubSub.Interfaces.ITwitchPubSub.Disconnect

(

)

Disconnects this instance.

Implemented in TwitchLib.PubSub.TwitchPubSub.

ListenToBitsEvents()

void TwitchLib.PubSub.Interfaces.ITwitchPubSub.ListenToBitsEvents

(

string

channelTwitchId

)

Listens to bits events.

Parameters

channelTwitchId

The channel twitch identifier.

Implemented in TwitchLib.PubSub.TwitchPubSub.

ListenToChannelExtensionBroadcast()

void TwitchLib.PubSub.Interfaces.ITwitchPubSub.ListenToChannelExtensionBroadcast	(	string	channelId,
		string	extensionId
	)

Listens to extension channel broadcast messages.

Parameters

channelId	The channel twitch identifier.
extensionId	The extension identifier.

Implemented in TwitchLib.PubSub.TwitchPubSub.

ListenToChannelPoints()

void TwitchLib.PubSub.Interfaces.ITwitchPubSub.ListenToChannelPoints

(

string

channelTwitchId

)

Listens to channel points.

Parameters

channelTwitchId

The channel twitch identifier.

Implemented in TwitchLib.PubSub.TwitchPubSub.

ListenToChatModeratorActions()

void TwitchLib.PubSub.Interfaces.ITwitchPubSub.ListenToChatModeratorActions	(	string	myTwitchId,
		string	channelTwitchId
	)

Listens to chat moderator actions.

Parameters

myTwitchId	My twitch identifier.
channelTwitchId	The channel twitch identifier.

Implemented in TwitchLib.PubSub.TwitchPubSub.

ListenToFollows()

void TwitchLib.PubSub.Interfaces.ITwitchPubSub.ListenToFollows

(

string

channelId

)

Listens to follows.

Parameters

channelId

The channel twitch identifier.

Implemented in TwitchLib.PubSub.TwitchPubSub.

ListenToLeaderboards()

void TwitchLib.PubSub.Interfaces.ITwitchPubSub.ListenToLeaderboards

(

string

channelTwitchId

)

Listens to leaderboards

Parameters

channelTwitchId

The channel twitch identifier.

Implemented in TwitchLib.PubSub.TwitchPubSub.

ListenToPredictions()

void TwitchLib.PubSub.Interfaces.ITwitchPubSub.ListenToPredictions

(

string

channelTwitchId

)

Listens to predictions

Parameters

channelTwitchId

The channel twitch identifier.

Implemented in TwitchLib.PubSub.TwitchPubSub.

ListenToRaid()

void TwitchLib.PubSub.Interfaces.ITwitchPubSub.ListenToRaid

(

string

channelTwitchId

)

Listens to raids

Parameters

channelTwitchId

The channel twitch identifier.

Implemented in TwitchLib.PubSub.TwitchPubSub.

ListenToRewards()

void TwitchLib.PubSub.Interfaces.ITwitchPubSub.ListenToRewards

(

string

channelTwitchId

)

Listens to rewards

Parameters

channelTwitchId

The channel twitch identifier.

Implemented in TwitchLib.PubSub.TwitchPubSub.

ListenToSubscriptions()

void TwitchLib.PubSub.Interfaces.ITwitchPubSub.ListenToSubscriptions

(

string

channelId

)

Listens to subscriptions.

Parameters

channelId

The channel identifier.

Implemented in TwitchLib.PubSub.TwitchPubSub.

ListenToVideoPlayback()

void TwitchLib.PubSub.Interfaces.ITwitchPubSub.ListenToVideoPlayback

(

string

channelName

)

Listens to video playback.

Parameters

channelName

Name of the channel.

Implemented in TwitchLib.PubSub.TwitchPubSub.

ListenToWhispers()

void TwitchLib.PubSub.Interfaces.ITwitchPubSub.ListenToWhispers

(

string

channelTwitchId

)

Listens to whispers.

Parameters

channelTwitchId

The channel twitch identifier.

Implemented in TwitchLib.PubSub.TwitchPubSub.

SendTopics()

void TwitchLib.PubSub.Interfaces.ITwitchPubSub.SendTopics	(	string	oauth = null,
		bool	unlisten = false
	)

Sends the topics.

Parameters

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

Implemented in TwitchLib.PubSub.TwitchPubSub.

TestMessageParser()

void TwitchLib.PubSub.Interfaces.ITwitchPubSub.TestMessageParser

(

string

testJsonString

)

Tests the message parser.

Parameters

testJsonString

The test json string.

Implemented in TwitchLib.PubSub.TwitchPubSub.

Event Documentation

OnBan

EventHandler<OnBanArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnBan

Occurs when [on ban].

OnBitsReceived

EventHandler<OnBitsReceivedArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnBitsReceived

Occurs when [on bits received].

OnChannelExtensionBroadcast

EventHandler<OnChannelExtensionBroadcastArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnChannelExtensionBroadcast

Occurs when [on channel extension broadcast].

OnChannelPointsRewardRedeemed

EventHandler<OnChannelPointsRewardRedeemedArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnChannelPointsRewardRedeemed

Occurs when [on reward redeemed]

OnChannelSubscription

EventHandler<OnChannelSubscriptionArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnChannelSubscription

Occurs when [on channel subscription].

OnClear

EventHandler<OnClearArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnClear

Occurs when [on clear].

OnCommercial

EventHandler<OnCommercialArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnCommercial

Occurs when [on commercial].

OnCustomRewardCreated

EventHandler<OnCustomRewardCreatedArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnCustomRewardCreated

Occurs when [on reward created] /summary>

OnCustomRewardDeleted

EventHandler<OnCustomRewardDeletedArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnCustomRewardDeleted

Occurs when [on reward deleted]

OnCustomRewardUpdated

EventHandler<OnCustomRewardUpdatedArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnCustomRewardUpdated

Occurs when [on reward updated] /summary>

OnEmoteOnly

EventHandler<OnEmoteOnlyArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnEmoteOnly

Occurs when [on emote only].

OnEmoteOnlyOff

EventHandler<OnEmoteOnlyOffArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnEmoteOnlyOff

Occurs when [on emote only off].

OnFollow

EventHandler<OnFollowArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnFollow

Occurs when [on follow].

OnHost

EventHandler<OnHostArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnHost

Occurs when [on host].

OnLeaderboardBits

EventHandler<OnLeaderboardEventArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnLeaderboardBits

Occurs when [on leaderboard bits].

OnLeaderboardSubs

EventHandler<OnLeaderboardEventArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnLeaderboardSubs

Occurs when [on leaderboard subs].

OnListenResponse

EventHandler<OnListenResponseArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnListenResponse

Occurs when [on listen response].

OnLog

EventHandler<OnLogArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnLog

Occurs when [on log].

OnMessageDeleted

EventHandler<OnMessageDeletedArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnMessageDeleted

Occurs when [on message deleted].

OnPrediction

EventHandler<OnPredictionArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnPrediction

Occurs when [on prediction].

OnPubSubServiceClosed

EventHandler TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnPubSubServiceClosed

Occurs when [on pub sub service closed].

OnPubSubServiceConnected

EventHandler TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnPubSubServiceConnected

Occurs when [on pub sub service connected].

OnPubSubServiceError

EventHandler<OnPubSubServiceErrorArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnPubSubServiceError

Occurs when [on pub sub service error].

OnR9kBeta

EventHandler<OnR9kBetaArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnR9kBeta

Occurs when [on R9K beta].

OnR9kBetaOff

EventHandler<OnR9kBetaOffArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnR9kBetaOff

Occurs when [on R9K beta off].

OnRaidGo

EventHandler<OnRaidGoArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnRaidGo

Occurs when [on raid go]

OnRaidUpdate

EventHandler<OnRaidUpdateArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnRaidUpdate

Occurs when [on raid update]

OnRaidUpdateV2

EventHandler<OnRaidUpdateV2Args> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnRaidUpdateV2

Occurs when [on raid update v2]

OnRewardRedeemed

EventHandler<OnRewardRedeemedArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnRewardRedeemed

Occurs when [on reward redeemed]

OnStreamDown

EventHandler<OnStreamDownArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnStreamDown

Occurs when [on stream down].

OnStreamUp

EventHandler<OnStreamUpArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnStreamUp

Occurs when [on stream up].

OnSubscribersOnly

EventHandler<OnSubscribersOnlyArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnSubscribersOnly

Occurs when [on subscribers only].

OnSubscribersOnlyOff

EventHandler<OnSubscribersOnlyOffArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnSubscribersOnlyOff

Occurs when [on subscribers only off].

OnTimeout

EventHandler<OnTimeoutArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnTimeout

Occurs when [on timeout].

OnUnban

EventHandler<OnUnbanArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnUnban

Occurs when [on unban].

OnUntimeout

EventHandler<OnUntimeoutArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnUntimeout

Occurs when [on untimeout].

OnViewCount

EventHandler<OnViewCountArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnViewCount

Occurs when [on view count].

OnWhisper

EventHandler<OnWhisperArgs> TwitchLib.PubSub.Interfaces.ITwitchPubSub.OnWhisper

Occurs when [on whisper].

---

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

• TwitchLib.PubSub/TwitchLib.PubSub/Interfaces/ITwitchPubSub.cs