TwitchLib 3.5.3
|
Interface ITwitchClient More...
Public Member Functions | |
void | Initialize (ConnectionCredentials credentials, string channel=null, char chatCommandIdentifier='!', char whisperCommandIdentifier='!', bool autoReListenOnExceptions=true) |
Initializes the specified credentials. More... | |
void | Initialize (ConnectionCredentials credentials, List< string > channels, char chatCommandIdentifier='!', char whisperCommandIdentifier='!', bool autoReListenOnExceptions=true) |
Initializes the specified credentials. More... | |
void | SetConnectionCredentials (ConnectionCredentials credentials) |
Sets the connection credentials. More... | |
void | AddChatCommandIdentifier (char identifier) |
Adds the chat command identifier. More... | |
void | AddWhisperCommandIdentifier (char identifier) |
Adds the whisper command identifier. More... | |
void | RemoveChatCommandIdentifier (char identifier) |
Removes the chat command identifier. More... | |
void | RemoveWhisperCommandIdentifier (char identifier) |
Removes the whisper command identifier. More... | |
bool | Connect () |
Connects this instance. More... | |
void | Disconnect () |
Disconnects this instance. More... | |
void | Reconnect () |
Reconnects this instance. More... | |
JoinedChannel | GetJoinedChannel (string channel) |
Gets the joined channel. More... | |
void | JoinChannel (string channel, bool overrideCheck=false) |
Joins the channel. More... | |
void | LeaveChannel (JoinedChannel channel) |
Leaves the channel. More... | |
void | LeaveChannel (string channel) |
Leaves the channel. More... | |
void | OnReadLineTest (string rawIrc) |
Called when [read line test]. More... | |
void | SendMessage (JoinedChannel channel, string message, bool dryRun=false) |
Sends the message. More... | |
void | SendMessage (string channel, string message, bool dryRun=false) |
Sends the message. More... | |
void | SendReply (JoinedChannel channel, string replyToId, string message, bool dryRun=false) |
Sends a formatted Twitch chat message reply. More... | |
void | SendReply (string channel, string replyToId, string message, bool dryRun=false) |
SendReply wrapper that accepts channel in string form. More... | |
void | SendQueuedItem (string message) |
Sends the queued item. More... | |
void | SendRaw (string message) |
Sends the raw. More... | |
void | SendWhisper (string receiver, string message, bool dryRun=false) |
Sends the whisper. More... | |
Properties | |
bool | AutoReListenOnException [get, set] |
Gets or sets a value indicating whether [automatic re listen on exception]. More... | |
MessageEmoteCollection | ChannelEmotes [get] |
Gets the channel emotes. More... | |
ConnectionCredentials | ConnectionCredentials [get] |
Gets the connection credentials. More... | |
bool | DisableAutoPong [get, set] |
Gets or sets a value indicating whether [disable automatic pong]. More... | |
bool | IsConnected [get] |
Gets a value indicating whether this instance is connected. More... | |
bool | IsInitialized [get] |
Gets a value indicating whether this instance is initialized. More... | |
IReadOnlyList< JoinedChannel > | JoinedChannels [get] |
Gets the joined channels. More... | |
WhisperMessage | PreviousWhisper [get] |
Gets the previous whisper. More... | |
string | TwitchUsername [get] |
Gets the twitch username. More... | |
bool | WillReplaceEmotes [get, set] |
Gets or sets a value indicating whether [will replace emotes]. More... | |
Events | |
EventHandler< OnChannelStateChangedArgs > | OnChannelStateChanged |
Occurs when [on channel state changed]. More... | |
EventHandler< OnChatClearedArgs > | OnChatCleared |
Occurs when [on chat cleared]. More... | |
EventHandler< OnChatColorChangedArgs > | OnChatColorChanged |
Occurs when [on chat color changed]. More... | |
EventHandler< OnChatCommandReceivedArgs > | OnChatCommandReceived |
Occurs when [on chat command received]. More... | |
EventHandler< OnConnectedArgs > | OnConnected |
Occurs when [on connected]. More... | |
EventHandler< OnConnectionErrorArgs > | OnConnectionError |
Occurs when [on connection error]. More... | |
EventHandler< OnDisconnectedEventArgs > | OnDisconnected |
Occurs when [on disconnected]. More... | |
EventHandler< OnExistingUsersDetectedArgs > | OnExistingUsersDetected |
Occurs when [on existing users detected]. More... | |
EventHandler< OnGiftedSubscriptionArgs > | OnGiftedSubscription |
Occurs when [on gifted subscription]. More... | |
EventHandler< OnIncorrectLoginArgs > | OnIncorrectLogin |
Occurs when [on incorrect login]. More... | |
EventHandler< OnJoinedChannelArgs > | OnJoinedChannel |
Occurs when [on joined channel]. More... | |
EventHandler< OnLeftChannelArgs > | OnLeftChannel |
Occurs when [on left channel]. More... | |
EventHandler< OnLogArgs > | OnLog |
Occurs when [on log]. More... | |
EventHandler< OnMessageReceivedArgs > | OnMessageReceived |
Occurs when [on message received]. More... | |
EventHandler< OnMessageSentArgs > | OnMessageSent |
Occurs when [on message sent]. More... | |
EventHandler< OnModeratorJoinedArgs > | OnModeratorJoined |
Occurs when [on moderator joined]. More... | |
EventHandler< OnModeratorLeftArgs > | OnModeratorLeft |
Occurs when [on moderator left]. More... | |
EventHandler< OnModeratorsReceivedArgs > | OnModeratorsReceived |
Occurs when [on moderators received]. More... | |
EventHandler< OnNewSubscriberArgs > | OnNewSubscriber |
Occurs when [on new subscriber]. More... | |
EventHandler< OnRaidNotificationArgs > | OnRaidNotification |
Occurs when [on raid notification]. More... | |
EventHandler< OnReSubscriberArgs > | OnReSubscriber |
Occurs when [on re subscriber]. More... | |
EventHandler< OnSendReceiveDataArgs > | OnSendReceiveData |
Occurs when [on send receive data]. More... | |
EventHandler< OnUserBannedArgs > | OnUserBanned |
Occurs when [on user banned]. More... | |
EventHandler< OnUserJoinedArgs > | OnUserJoined |
Occurs when [on user joined]. More... | |
EventHandler< OnUserLeftArgs > | OnUserLeft |
Occurs when [on user left]. More... | |
EventHandler< OnUserStateChangedArgs > | OnUserStateChanged |
Occurs when [on user state changed]. More... | |
EventHandler< OnUserTimedoutArgs > | OnUserTimedout |
Occurs when [on user timedout]. More... | |
EventHandler< OnWhisperCommandReceivedArgs > | OnWhisperCommandReceived |
Occurs when [on whisper command received]. More... | |
EventHandler< OnWhisperReceivedArgs > | OnWhisperReceived |
Occurs when [on whisper received]. More... | |
EventHandler< OnWhisperSentArgs > | OnWhisperSent |
Occurs when [on whisper sent]. More... | |
EventHandler< OnMessageThrottledEventArgs > | OnMessageThrottled |
Occurs when [on message throttled]. More... | |
EventHandler< OnWhisperThrottledEventArgs > | OnWhisperThrottled |
Occurs when [on whisper throttled]. More... | |
EventHandler< OnErrorEventArgs > | OnError |
Occurs when [on error]. More... | |
EventHandler< OnReconnectedEventArgs > | OnReconnected |
Occurs when [on reconnected]. More... | |
EventHandler< OnVIPsReceivedArgs > | OnVIPsReceived |
Occurs when [on vip received]. More... | |
EventHandler< OnCommunitySubscriptionArgs > | OnCommunitySubscription |
Occurs when [on community subscription announcement received]. More... | |
EventHandler< OnMessageClearedArgs > | OnMessageCleared |
Occurs when [on message deleted]. More... | |
EventHandler< OnRequiresVerifiedEmailArgs > | OnRequiresVerifiedEmail |
Occurs when chatting in a channel that requires a verified email without a verified email attached to the account. More... | |
EventHandler< OnRequiresVerifiedPhoneNumberArgs > | OnRequiresVerifiedPhoneNumber |
Occurs when chatting in a channel that requires a verified phone number without a verified phone number attached to the account. More... | |
EventHandler< OnBannedEmailAliasArgs > | OnBannedEmailAlias |
Occurs when chatting in a channel that the user is banned in bcs of an already banned alias with the same Email More... | |
EventHandler< OnUserIntroArgs > | OnUserIntro |
Fires when the client receives a PRIVMSG tagged as an user-intro More... | |
EventHandler< OnAnnouncementArgs > | OnAnnouncement |
Fires when the client receives a USERNOTICE tagged as an announcement More... | |
Interface ITwitchClient
void TwitchLib.Client.Interfaces.ITwitchClient.AddChatCommandIdentifier | ( | char | identifier | ) |
Adds the chat command identifier.
identifier | The identifier. |
Implemented in TwitchLib.Client.TwitchClient.
void TwitchLib.Client.Interfaces.ITwitchClient.AddWhisperCommandIdentifier | ( | char | identifier | ) |
Adds the whisper command identifier.
identifier | The identifier. |
Implemented in TwitchLib.Client.TwitchClient.
bool TwitchLib.Client.Interfaces.ITwitchClient.Connect | ( | ) |
Connects this instance.
Implemented in TwitchLib.Client.TwitchClient.
void TwitchLib.Client.Interfaces.ITwitchClient.Disconnect | ( | ) |
Disconnects this instance.
Implemented in TwitchLib.Client.TwitchClient.
JoinedChannel TwitchLib.Client.Interfaces.ITwitchClient.GetJoinedChannel | ( | string | channel | ) |
Gets the joined channel.
channel | The channel. |
Implemented in TwitchLib.Client.TwitchClient.
void TwitchLib.Client.Interfaces.ITwitchClient.Initialize | ( | ConnectionCredentials | credentials, |
List< string > | channels, | ||
char | chatCommandIdentifier = '!' , |
||
char | whisperCommandIdentifier = '!' , |
||
bool | autoReListenOnExceptions = true |
||
) |
Initializes the specified credentials.
credentials | The credentials. |
channels | The channels to join once connected. |
chatCommandIdentifier | The chat command identifier. |
whisperCommandIdentifier | The whisper command identifier. |
autoReListenOnExceptions | if set to true [automatic re listen on exceptions]. |
Implemented in TwitchLib.Client.TwitchClient.
void TwitchLib.Client.Interfaces.ITwitchClient.Initialize | ( | ConnectionCredentials | credentials, |
string | channel = null , |
||
char | chatCommandIdentifier = '!' , |
||
char | whisperCommandIdentifier = '!' , |
||
bool | autoReListenOnExceptions = true |
||
) |
Initializes the specified credentials.
credentials | The credentials. |
channel | The channel. |
chatCommandIdentifier | The chat command identifier. |
whisperCommandIdentifier | The whisper command identifier. |
autoReListenOnExceptions | if set to true [automatic re listen on exceptions]. |
Implemented in TwitchLib.Client.TwitchClient.
void TwitchLib.Client.Interfaces.ITwitchClient.JoinChannel | ( | string | channel, |
bool | overrideCheck = false |
||
) |
Joins the channel.
channel | The channel. |
overrideCheck | if set to true [override check]. |
Implemented in TwitchLib.Client.TwitchClient.
void TwitchLib.Client.Interfaces.ITwitchClient.LeaveChannel | ( | JoinedChannel | channel | ) |
void TwitchLib.Client.Interfaces.ITwitchClient.LeaveChannel | ( | string | channel | ) |
void TwitchLib.Client.Interfaces.ITwitchClient.OnReadLineTest | ( | string | rawIrc | ) |
Called when [read line test].
rawIrc | The raw irc. |
Implemented in TwitchLib.Client.TwitchClient.
void TwitchLib.Client.Interfaces.ITwitchClient.Reconnect | ( | ) |
Reconnects this instance.
Implemented in TwitchLib.Client.TwitchClient.
void TwitchLib.Client.Interfaces.ITwitchClient.RemoveChatCommandIdentifier | ( | char | identifier | ) |
Removes the chat command identifier.
identifier | The identifier. |
Implemented in TwitchLib.Client.TwitchClient.
void TwitchLib.Client.Interfaces.ITwitchClient.RemoveWhisperCommandIdentifier | ( | char | identifier | ) |
Removes the whisper command identifier.
identifier | The identifier. |
Implemented in TwitchLib.Client.TwitchClient.
void TwitchLib.Client.Interfaces.ITwitchClient.SendMessage | ( | JoinedChannel | channel, |
string | message, | ||
bool | dryRun = false |
||
) |
Sends the message.
channel | The channel. |
message | The message. |
dryRun | if set to true [dry run]. |
Implemented in TwitchLib.Client.TwitchClient.
void TwitchLib.Client.Interfaces.ITwitchClient.SendMessage | ( | string | channel, |
string | message, | ||
bool | dryRun = false |
||
) |
Sends the message.
channel | The channel. |
message | The message. |
dryRun | if set to true [dry run]. |
Implemented in TwitchLib.Client.TwitchClient.
void TwitchLib.Client.Interfaces.ITwitchClient.SendQueuedItem | ( | string | message | ) |
void TwitchLib.Client.Interfaces.ITwitchClient.SendRaw | ( | string | message | ) |
void TwitchLib.Client.Interfaces.ITwitchClient.SendReply | ( | JoinedChannel | channel, |
string | replyToId, | ||
string | message, | ||
bool | dryRun = false |
||
) |
Sends a formatted Twitch chat message reply.
channel | Channel to send Twitch chat reply to |
replyToId | The message id that is being replied to |
message | Reply contents |
dryRun | if set to true [dry run] |
Implemented in TwitchLib.Client.TwitchClient.
void TwitchLib.Client.Interfaces.ITwitchClient.SendReply | ( | string | channel, |
string | replyToId, | ||
string | message, | ||
bool | dryRun = false |
||
) |
SendReply wrapper that accepts channel in string form.
channel | Channel to send Twitch chat reply to |
replyToId | The message id that is being replied to |
message | Reply contents |
dryRun | if set to true [dry run] |
Implemented in TwitchLib.Client.TwitchClient.
void TwitchLib.Client.Interfaces.ITwitchClient.SendWhisper | ( | string | receiver, |
string | message, | ||
bool | dryRun = false |
||
) |
Sends the whisper.
receiver | The receiver. |
message | The message. |
dryRun | if set to true [dry run]. |
Implemented in TwitchLib.Client.TwitchClient.
void TwitchLib.Client.Interfaces.ITwitchClient.SetConnectionCredentials | ( | ConnectionCredentials | credentials | ) |
Sets the connection credentials.
credentials | The credentials. |
Implemented in TwitchLib.Client.TwitchClient.
|
getset |
Gets or sets a value indicating whether [automatic re listen on exception].
true
if [automatic re listen on exception]; otherwise, false
.
Implemented in TwitchLib.Client.TwitchClient.
|
get |
|
get |
Gets the connection credentials.
The connection credentials.
Implemented in TwitchLib.Client.TwitchClient.
|
getset |
Gets or sets a value indicating whether [disable automatic pong].
true
if [disable automatic pong]; otherwise, false
.
Implemented in TwitchLib.Client.TwitchClient.
|
get |
Gets a value indicating whether this instance is connected.
true
if this instance is connected; otherwise, false
.
Implemented in TwitchLib.Client.TwitchClient.
|
get |
Gets a value indicating whether this instance is initialized.
true
if this instance is initialized; otherwise, false
.
Implemented in TwitchLib.Client.TwitchClient.
|
get |
|
get |
|
get |
|
getset |
Gets or sets a value indicating whether [will replace emotes].
true
if [will replace emotes]; otherwise, false
.
Implemented in TwitchLib.Client.TwitchClient.
EventHandler<OnAnnouncementArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnAnnouncement |
Fires when the client receives a USERNOTICE tagged as an announcement
EventHandler<OnBannedEmailAliasArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnBannedEmailAlias |
Occurs when chatting in a channel that the user is banned in bcs of an already banned alias with the same Email
EventHandler<OnChannelStateChangedArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnChannelStateChanged |
Occurs when [on channel state changed].
EventHandler<OnChatClearedArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnChatCleared |
Occurs when [on chat cleared].
EventHandler<OnChatColorChangedArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnChatColorChanged |
Occurs when [on chat color changed].
EventHandler<OnChatCommandReceivedArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnChatCommandReceived |
Occurs when [on chat command received].
EventHandler<OnCommunitySubscriptionArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnCommunitySubscription |
Occurs when [on community subscription announcement received].
EventHandler<OnConnectedArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnConnected |
Occurs when [on connected].
EventHandler<OnConnectionErrorArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnConnectionError |
Occurs when [on connection error].
EventHandler<OnDisconnectedEventArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnDisconnected |
Occurs when [on disconnected].
EventHandler<OnErrorEventArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnError |
Occurs when [on error].
EventHandler<OnExistingUsersDetectedArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnExistingUsersDetected |
Occurs when [on existing users detected].
EventHandler<OnGiftedSubscriptionArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnGiftedSubscription |
Occurs when [on gifted subscription].
EventHandler<OnIncorrectLoginArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnIncorrectLogin |
Occurs when [on incorrect login].
EventHandler<OnJoinedChannelArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnJoinedChannel |
Occurs when [on joined channel].
EventHandler<OnLeftChannelArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnLeftChannel |
Occurs when [on left channel].
EventHandler<OnLogArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnLog |
Occurs when [on log].
EventHandler<OnMessageClearedArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnMessageCleared |
Occurs when [on message deleted].
EventHandler<OnMessageReceivedArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnMessageReceived |
Occurs when [on message received].
EventHandler<OnMessageSentArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnMessageSent |
Occurs when [on message sent].
EventHandler<OnMessageThrottledEventArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnMessageThrottled |
Occurs when [on message throttled].
EventHandler<OnModeratorJoinedArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnModeratorJoined |
Occurs when [on moderator joined].
EventHandler<OnModeratorLeftArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnModeratorLeft |
Occurs when [on moderator left].
EventHandler<OnModeratorsReceivedArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnModeratorsReceived |
Occurs when [on moderators received].
EventHandler<OnNewSubscriberArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnNewSubscriber |
Occurs when [on new subscriber].
EventHandler<OnRaidNotificationArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnRaidNotification |
Occurs when [on raid notification].
EventHandler<OnReconnectedEventArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnReconnected |
Occurs when [on reconnected].
EventHandler<OnRequiresVerifiedEmailArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnRequiresVerifiedEmail |
Occurs when chatting in a channel that requires a verified email without a verified email attached to the account.
EventHandler<OnRequiresVerifiedPhoneNumberArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnRequiresVerifiedPhoneNumber |
Occurs when chatting in a channel that requires a verified phone number without a verified phone number attached to the account.
EventHandler<OnReSubscriberArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnReSubscriber |
Occurs when [on re subscriber].
EventHandler<OnSendReceiveDataArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnSendReceiveData |
Occurs when [on send receive data].
EventHandler<OnUserBannedArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnUserBanned |
Occurs when [on user banned].
EventHandler<OnUserIntroArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnUserIntro |
Fires when the client receives a PRIVMSG tagged as an user-intro
EventHandler<OnUserJoinedArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnUserJoined |
Occurs when [on user joined].
EventHandler<OnUserLeftArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnUserLeft |
Occurs when [on user left].
EventHandler<OnUserStateChangedArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnUserStateChanged |
Occurs when [on user state changed].
EventHandler<OnUserTimedoutArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnUserTimedout |
Occurs when [on user timedout].
EventHandler<OnVIPsReceivedArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnVIPsReceived |
Occurs when [on vip received].
EventHandler<OnWhisperCommandReceivedArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnWhisperCommandReceived |
Occurs when [on whisper command received].
EventHandler<OnWhisperReceivedArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnWhisperReceived |
Occurs when [on whisper received].
EventHandler<OnWhisperSentArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnWhisperSent |
Occurs when [on whisper sent].
EventHandler<OnWhisperThrottledEventArgs> TwitchLib.Client.Interfaces.ITwitchClient.OnWhisperThrottled |
Occurs when [on whisper throttled].