Nullable anotation Part2 (+1 small "bux" fix) (TwitchLib#252)

* nullable anotation Part 2 (focused on `Twitch.LibClient`) * fix potential problem when connecting to a channel when `Capabilities.Tags`is set to `false` * fix `tmiSent`dafault value in `HandleClearMsg` --------- Co-authored-by: AoshiW <[email protected]>
AoshiW · Oct 30, 2023 · 70dead0 · 70dead0
1 parent e014d80
commit 70dead0
Show file tree

Hide file tree

Showing 49 changed files with 857 additions and 474 deletions.
diff --git a/TwitchLib.Client.Models/Internal/MsgIds.cs b/TwitchLib.Client.Models/Internal/MsgIds.cs
@@ -11,10 +11,13 @@ public static class MsgIds
         public const string AlreadyR9KOn = "already_r9k_on";
         public const string AlreadySubsOff = "already_subs_off";
         public const string AlreadySubsOn = "already_subs_on";
+        public const string AnonGiftPaidUpgrade = "anongiftpaidupgrade";
         public const string Announcement = "announcement";
         public const string BadUnbanNoBan = "bad_unban_no_ban";
         public const string BanSuccess = "ban_success";
+        public const string BitsBadgeTier = "bitsbadgetier";
         public const string ColorChanged = "color_changed";
+        public const string CommunityPayForward = "communitypayforward";
         public const string EmoteOnlyOff = "emote_only_off";
         public const string EmoteOnlyOn = "emote_only_on";
         public const string HighlightedMessage = "highlighted-message";
@@ -40,8 +43,10 @@ public static class MsgIds
         public const string RaidErrorSelf = "raid_error_self";
         public const string RaidNoticeMature = "raid_notice_mature";
         public const string ReSubscription = "resub";
+        public const string Ritual = "ritual";
         public const string R9KOff = "r9k_off";
         public const string R9KOn = "r9k_on";
+        public const string StandardPayForward = "standardpayforward";
         public const string SubGift = "subgift";
         public const string CommunitySubscription = "submysterygift";
         public const string ContinuedGiftedSubscription = "giftpaidupgrade";
@@ -50,6 +55,7 @@ public static class MsgIds
         public const string SubsOn = "subs_on";
         public const string TimeoutSuccess = "timeout_success";
         public const string UnbanSuccess = "unban_success";
+        public const string Unraid = "unraid";
         public const string UnrecognizedCmd = "unrecognized_cmd";
         public const string UserIntro = "user-intro";
         public const string VIPsSuccess = "vips_success";

diff --git a/TwitchLib.Client.Test/TwitchClientEventTests.cs b/TwitchLib.Client.Test/TwitchClientEventTests.cs
@@ -40,7 +40,7 @@ public async Task ClientCanJoinChannels()
             client.OnConnected += async (sender, e) =>
             {
                 await client.JoinChannelAsync(TWITCH_CHANNEL);
-                await ReceivedRoomState();
+                await ReceivedJoin(TWITCH_CHANNEL);
             };
 
             await MyAssert.RaisesAsync<OnJoinedChannelArgs>(
@@ -120,7 +120,7 @@ await MyAssert.RaisesAsync<OnJoinedChannelArgs>(
                       await client.ConnectAsync();
                       await ReceivedTwitchConnected();
                       await client.JoinChannelAsync(TWITCH_CHANNEL);
-                      await ReceivedRoomState();
+                      await ReceivedJoin(TWITCH_CHANNEL);
                   });
         }
 
@@ -215,6 +215,11 @@ private async Task ReceivedRoomState()
         {
             await _mockClient.ReceiveMessage($"@broadcaster-lang=;r9k=0;slow=0;subs-only=0 :tmi.twitch.tv ROOMSTATE #{TWITCH_CHANNEL}");
         }
+
+        private async Task ReceivedJoin(string channel)
+        {
+            await _mockClient.ReceiveMessage($":{TWITCH_BOT_USERNAME}!{TWITCH_BOT_USERNAME}@{TWITCH_BOT_USERNAME}.tmi.twitch.tv JOIN #{channel}");
+        }
         #endregion
     } 
 }
diff --git a/TwitchLib.Client/Events/NoticeEventArgs.cs b/TwitchLib.Client/Events/NoticeEventArgs.cs
@@ -15,7 +15,9 @@ public class NoticeEventArgs
     /// </summary>
     public string Channel { get; }
 
-
+    /// <summary>
+    /// Initializes a new instance of the <see cref="NoticeEventArgs"/> class.
+    /// </summary>
     public NoticeEventArgs(string channel, string message)
     {
         Message = message;

diff --git a/TwitchLib.Client/Events/OnAnnouncementArgs.cs b/TwitchLib.Client/Events/OnAnnouncementArgs.cs
@@ -14,10 +14,19 @@ public class OnAnnouncementArgs : EventArgs
         /// <summary>
         /// Property representing the announcement send with the USERNOTICE
         /// </summary>
-        public Announcement Announcement;
+        public Announcement Announcement { get; }
         /// <summary>
         /// Property representing channel bot is connected to.
         /// </summary>
-        public string Channel;
+        public string Channel { get; }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OnAnnouncementArgs"/> class.
+        /// </summary>
+        public OnAnnouncementArgs(string channel, Announcement announcement)
+        {
+            Channel = channel;
+            Announcement = announcement;
+        }
     }
 }
diff --git a/TwitchLib.Client/Events/OnAnonGiftPaidUpgradeArgs.cs b/TwitchLib.Client/Events/OnAnonGiftPaidUpgradeArgs.cs
@@ -0,0 +1,32 @@
+using TwitchLib.Client.Models;
+using TwitchLib.Client.Models.Internal;
+
+namespace TwitchLib.Client.Events;
+
+public class OnAnonGiftPaidUpgradeArgs : EventArgs
+{
+    /// <summary>
+    /// The channel
+    /// </summary>
+    public string Channel { get; }
+
+    /// <summary>
+    /// The AnonGiftPaidUpgrade
+    /// </summary>
+    public AnonGiftPaidUpgrade AnonGiftPaidUpgrade { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="OnBitsBadgeTierArgs"/> class.
+    /// </summary>
+    public OnAnonGiftPaidUpgradeArgs(string channel, AnonGiftPaidUpgrade anonGiftPaidUpgrade)
+    {
+        Channel = channel;
+        AnonGiftPaidUpgrade = anonGiftPaidUpgrade;
+    }
+
+    internal OnAnonGiftPaidUpgradeArgs(IrcMessage ircMessage)
+    {
+        Channel = ircMessage.Channel;
+        AnonGiftPaidUpgrade = new(ircMessage);
+    }
+}
diff --git a/TwitchLib.Client/Events/OnBitsBadgeTierArgs.cs b/TwitchLib.Client/Events/OnBitsBadgeTierArgs.cs
@@ -0,0 +1,32 @@
+using TwitchLib.Client.Models;
+using TwitchLib.Client.Models.Internal;
+
+namespace TwitchLib.Client.Events;
+
+public class OnBitsBadgeTierArgs : EventArgs
+{
+    /// <summary>
+    /// The channel
+    /// </summary>
+    public string Channel { get; }
+
+    /// <summary>
+    /// The BitsBadgeTier
+    /// </summary>
+    public BitsBadgeTier BitsBadgeTier { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="OnBitsBadgeTierArgs"/> class.
+    /// </summary>
+    public OnBitsBadgeTierArgs(string channel, BitsBadgeTier bitsBadgeTier)
+    {
+        Channel = channel;
+        BitsBadgeTier = bitsBadgeTier;
+    }
+
+    internal OnBitsBadgeTierArgs(IrcMessage ircMessage)
+    {
+        Channel = ircMessage.Channel;
+        BitsBadgeTier = new(ircMessage);
+    }
+}
diff --git a/TwitchLib.Client/Events/OnChannelStateChangedArgs.cs b/TwitchLib.Client/Events/OnChannelStateChangedArgs.cs
@@ -1,5 +1,4 @@
-using System;
-using TwitchLib.Client.Models;
+using TwitchLib.Client.Models;
 
 namespace TwitchLib.Client.Events
 {
@@ -14,10 +13,19 @@ public class OnChannelStateChangedArgs : EventArgs
         /// <summary>
         /// Property representing the current channel state.
         /// </summary>
-        public ChannelState ChannelState;
+        public ChannelState ChannelState { get; }
         /// <summary>
         /// Property representing the channel received state from.
         /// </summary>
-        public string Channel;
+        public string Channel { get; }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OnChannelStateChangedArgs"/> class.
+        /// </summary>
+        public OnChannelStateChangedArgs(string channel, ChannelState channelState)
+        {
+            Channel = channel;
+            ChannelState = channelState;
+        }
     }
 }
diff --git a/TwitchLib.Client/Events/OnChatClearedArgs.cs b/TwitchLib.Client/Events/OnChatClearedArgs.cs
@@ -1,6 +1,4 @@
-using System;
-
-namespace TwitchLib.Client.Events
+namespace TwitchLib.Client.Events
 {
     /// <summary>
     /// Args representing a cleared chat event.
@@ -14,5 +12,13 @@ public class OnChatClearedArgs : EventArgs
         /// Channel that had chat cleared event.
         /// </summary>
         public string Channel;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OnChatClearedArgs"/> class.
+        /// </summary>
+        public OnChatClearedArgs(string channel)
+        {
+            Channel = channel;
+        }
     }
 }
diff --git a/TwitchLib.Client/Events/OnChatColorChangedArgs.cs b/TwitchLib.Client/Events/OnChatColorChangedArgs.cs
@@ -1,6 +1,4 @@
-using System;
-
-namespace TwitchLib.Client.Events
+namespace TwitchLib.Client.Events
 {
     /// <summary>
     /// Args representing a successful chat color change request.
@@ -14,5 +12,13 @@ public class OnChatColorChangedArgs : EventArgs
         /// Property reprenting the channel the event was received in.
         /// </summary>
         public string Channel;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OnChatColorChangedArgs"/> class.
+        /// </summary>
+        public OnChatColorChangedArgs(string channel)
+        {
+            Channel = channel;
+        }
     }
 }
diff --git a/TwitchLib.Client/Events/OnCommunityPayForwardArgs.cs b/TwitchLib.Client/Events/OnCommunityPayForwardArgs.cs
@@ -0,0 +1,32 @@
+using TwitchLib.Client.Models;
+using TwitchLib.Client.Models.Internal;
+
+namespace TwitchLib.Client.Events;
+
+public class OnCommunityPayForwardArgs : EventArgs
+{
+    /// <summary>
+    /// The channel
+    /// </summary>
+    public string Channel { get; }
+
+    /// <summary>
+    /// The CommunityPayForward
+    /// </summary>
+    public CommunityPayForward CommunityPayForward { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="OnCommunityPayForwardArgs"/> class.
+    /// </summary>
+    public OnCommunityPayForwardArgs(string channel, CommunityPayForward communityPayForward)
+    {
+        Channel = channel;
+        CommunityPayForward = communityPayForward;
+    }
+
+    internal OnCommunityPayForwardArgs(IrcMessage ircMessage)
+    {
+        Channel = ircMessage.Channel;
+        CommunityPayForward = new(ircMessage);
+    }
+}
diff --git a/TwitchLib.Client/Events/OnCommunitySubscriptionArgs.cs b/TwitchLib.Client/Events/OnCommunitySubscriptionArgs.cs
@@ -14,10 +14,19 @@ public class OnCommunitySubscriptionArgs : EventArgs
         /// <summary>
         /// Property representing the information of the community subscription.
         /// </summary>
-        public CommunitySubscription GiftedSubscription;
+        public CommunitySubscription GiftedSubscription { get; }
         /// <summary>
         /// Property representing the Twitch channel this event fired from.
         /// </summary>
-        public string Channel;
+        public string Channel { get; }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OnCommunitySubscriptionArgs"/> class.
+        /// </summary>
+        public OnCommunitySubscriptionArgs(string channel, CommunitySubscription giftedSubscription)
+        {
+            Channel = channel;
+            GiftedSubscription = giftedSubscription;
+        }
     }
 }
diff --git a/TwitchLib.Client/Events/OnConnectedEventArgs.cs b/TwitchLib.Client/Events/OnConnectedEventArgs.cs
@@ -9,5 +9,13 @@ public class OnConnectedEventArgs : EventArgs
     /// <summary>
     /// Property representing bot username.
     /// </summary>
-    public string BotUsername;
+    public string BotUsername { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="OnConnectedEventArgs"/> class.
+    /// </summary>
+    public OnConnectedEventArgs(string botUsername)
+    {
+        BotUsername = botUsername;
+    }
 }
diff --git a/TwitchLib.Client/Events/OnConnectionErrorArgs.cs b/TwitchLib.Client/Events/OnConnectionErrorArgs.cs
@@ -1,5 +1,4 @@
-using System;
-using TwitchLib.Client.Models;
+using TwitchLib.Client.Models;
 
 namespace TwitchLib.Client.Events
 {
@@ -14,10 +13,19 @@ public class OnConnectionErrorArgs : EventArgs
         /// <summary>
         /// The error
         /// </summary>
-        public ErrorEvent Error;
+        public ErrorEvent Error { get; }
         /// <summary>
         /// Username of the bot that suffered connection error.
         /// </summary>
-        public string BotUsername;
+        public string BotUsername { get; }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OnConnectionErrorArgs"/> class.
+        /// </summary>
+        public OnConnectionErrorArgs(string botUsername, ErrorEvent error)
+        {
+            BotUsername = botUsername;
+            Error = error;
+        }
     }
 }
diff --git a/TwitchLib.Client/Events/OnContinuedGiftedSubscriptionArgs.cs b/TwitchLib.Client/Events/OnContinuedGiftedSubscriptionArgs.cs
@@ -1,5 +1,4 @@
-using System;
-using TwitchLib.Client.Models;
+using TwitchLib.Client.Models;
 
 namespace TwitchLib.Client.Events
 {
@@ -13,10 +12,19 @@ public class OnContinuedGiftedSubscriptionArgs : EventArgs
         /// <summary>
         /// Property representing the information of the subscription that was originally gifted, and is now continued by the user.
         /// </summary>
-        public ContinuedGiftedSubscription ContinuedGiftedSubscription;
+        public ContinuedGiftedSubscription ContinuedGiftedSubscription { get; }
         /// <summary>
         /// Property representing the Twitch channel this event fired from.
         /// </summary>
-        public string Channel;
+        public string Channel { get; }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OnContinuedGiftedSubscriptionArgs"/> class.
+        /// </summary>
+        public OnContinuedGiftedSubscriptionArgs(string channel, ContinuedGiftedSubscription continuedGiftedSubscription)
+        {
+            Channel = channel;
+            ContinuedGiftedSubscription = continuedGiftedSubscription;
+        }
     }
 }
diff --git a/TwitchLib.Client/Events/OnDisconnectedArgs.cs b/TwitchLib.Client/Events/OnDisconnectedArgs.cs
@@ -1,6 +1,4 @@
-using System;
-
-namespace TwitchLib.Client.Events
+namespace TwitchLib.Client.Events
 {
     /// <summary>
     /// Args representing client disconnect event.
@@ -13,6 +11,14 @@ public class OnDisconnectedArgs : EventArgs
         /// <summary>
         /// Username of the bot that was disconnected.
         /// </summary>
-        public string BotUsername;
+        public string BotUsername { get; }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OnDisconnectedArgs"/> class.
+        /// </summary>
+        public OnDisconnectedArgs(string botUsername)
+        {
+            BotUsername = botUsername;
+        }
     }
 }