nullable anotation for the .Models project except models for `UserN…

…ocice` events and `MessageEmote.cs` (#246)
TwitchLib · Sep 16, 2023 · 56f89f5 · 56f89f5
1 parent d6d26ef
commit 56f89f5
Show file tree

Hide file tree

Showing 57 changed files with 353 additions and 312 deletions.
diff --git a/TwitchLib.Client.Models/Announcement.cs b/TwitchLib.Client.Models/Announcement.cs
@@ -1,4 +1,6 @@
-using TwitchLib.Client.Enums;
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+using TwitchLib.Client.Enums;
 using TwitchLib.Client.Models.Interfaces;
 using TwitchLib.Client.Models.Internal;
 
@@ -73,6 +75,11 @@ public class Announcement : IHexColorProperty
         /// <summary>Property representing the message of the announcement.</summary>
         public string Message { get; }
 
+        /// <summary>
+        /// Contains undocumented tags.
+        /// </summary>
+        public Dictionary<string, string>? UndocumentedTags { get; }
+
         /// SAMPLE: @badge-info=;badges=broadcaster/1,ambassador/1;color=#033700;display-name=BarryCarlyon;emotes=;flags=;id=55d90904-e515-47d0-ac1d-879f7f1d7b01;login=barrycarlyon;mod=0;msg-id=announcement;msg-param-color=PRIMARY;room-id=15185913;subscriber=0;system-msg=;tmi-sent-ts=1648758023469;user-id=15185913;user-type= :tmi.twitch.tv USERNOTICE #barrycarlyon :test announcment main
         /// <summary>Announcement object constructor.</summary>
         /// <param name="ircMessage">The IRC message from Twitch to be processed.</param>
@@ -152,6 +159,9 @@ public Announcement(IrcMessage ircMessage)
                     case Tags.UserType:
                         UserType = TagHelper.ToUserType(tag.Value);
                         break;
+                    default:
+                        (UndocumentedTags = new()).Add(tag.Key, tag.Value);
+                        break;
                 }
             }
         }

diff --git a/TwitchLib.Client.Models/Builders/ChannelStateBuilder.cs b/TwitchLib.Client.Models/Builders/ChannelStateBuilder.cs
@@ -1,4 +1,5 @@
-using System;
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 namespace TwitchLib.Client.Models.Builders
 {

diff --git a/TwitchLib.Client.Models/Builders/ChatMessageBuilder.cs b/TwitchLib.Client.Models/Builders/ChatMessageBuilder.cs
@@ -1,4 +1,7 @@
-using TwitchLib.Client.Enums;
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+using TwitchLib.Client.Enums;
 
 namespace TwitchLib.Client.Models.Builders
 {

diff --git a/TwitchLib.Client.Models/Builders/CheerBadgeBuilder.cs b/TwitchLib.Client.Models/Builders/CheerBadgeBuilder.cs
@@ -1,4 +1,7 @@
-namespace TwitchLib.Client.Models.Builders
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace TwitchLib.Client.Models.Builders
 {
     public sealed class CheerBadgeBuilder : IBuilder<CheerBadge>
     {

diff --git a/TwitchLib.Client.Models/Builders/CommunitySubscriptionBuilder.cs b/TwitchLib.Client.Models/Builders/CommunitySubscriptionBuilder.cs
@@ -1,4 +1,7 @@
-namespace TwitchLib.Client.Models.Builders
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace TwitchLib.Client.Models.Builders
 {
     public sealed class CommunitySubscriptionBuilder : IFromIrcMessageBuilder<CommunitySubscription>
     {

diff --git a/TwitchLib.Client.Models/Builders/ConnectionCredentialsBuilder.cs b/TwitchLib.Client.Models/Builders/ConnectionCredentialsBuilder.cs
@@ -1,4 +1,7 @@
-namespace TwitchLib.Client.Models.Builders
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace TwitchLib.Client.Models.Builders
 {
     public sealed class ConnectionCredentialsBuilder : IBuilder<ConnectionCredentials>
     {

diff --git a/TwitchLib.Client.Models/Builders/EmoteBuilder.cs b/TwitchLib.Client.Models/Builders/EmoteBuilder.cs
@@ -1,4 +1,5 @@
-using static TwitchLib.Client.Models.EmoteSet;
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 namespace TwitchLib.Client.Models.Builders
 {

diff --git a/TwitchLib.Client.Models/Builders/ErrorEventBuilder.cs b/TwitchLib.Client.Models/Builders/ErrorEventBuilder.cs
@@ -1,4 +1,7 @@
-namespace TwitchLib.Client.Models.Builders
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace TwitchLib.Client.Models.Builders
 {
     public sealed class ErrorEventBuilder : IBuilder<ErrorEvent>
     {
@@ -21,10 +24,7 @@ public static ErrorEventBuilder Create()
 
         public ErrorEvent Build()
         {
-            return new ErrorEvent
-            {
-                Message = _message
-            };
+            return new ErrorEvent(_message);
         }
     }
 }
diff --git a/TwitchLib.Client.Models/Builders/FromIrcMessageBuilderDataObject.cs b/TwitchLib.Client.Models/Builders/FromIrcMessageBuilderDataObject.cs
@@ -1,4 +1,7 @@
-using TwitchLib.Client.Models.Internal;
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+using TwitchLib.Client.Models.Internal;
 
 namespace TwitchLib.Client.Models.Builders
 {

diff --git a/TwitchLib.Client.Models/Builders/GiftedSubscriptionBuilder.cs b/TwitchLib.Client.Models/Builders/GiftedSubscriptionBuilder.cs
@@ -1,4 +1,7 @@
-using TwitchLib.Client.Enums;
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+using TwitchLib.Client.Enums;
 
 namespace TwitchLib.Client.Models.Builders
 {

diff --git a/TwitchLib.Client.Models/Builders/IBuilder.cs b/TwitchLib.Client.Models/Builders/IBuilder.cs
@@ -1,4 +1,7 @@
-namespace TwitchLib.Client.Models.Builders
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace TwitchLib.Client.Models.Builders
 {
     public interface IBuilder<T>
     {

diff --git a/TwitchLib.Client.Models/Builders/IFromIrcMessageBuilder.cs b/TwitchLib.Client.Models/Builders/IFromIrcMessageBuilder.cs
@@ -1,4 +1,7 @@
-namespace TwitchLib.Client.Models.Builders
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace TwitchLib.Client.Models.Builders
 {
     public interface IFromIrcMessageBuilder<T>
     {

diff --git a/TwitchLib.Client.Models/Builders/IrcMessageBuilder.cs b/TwitchLib.Client.Models/Builders/IrcMessageBuilder.cs
@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 using TwitchLib.Client.Enums.Internal;
 using TwitchLib.Client.Models.Internal;

diff --git a/TwitchLib.Client.Models/Builders/OutboundChatMessageBuilder.cs b/TwitchLib.Client.Models/Builders/OutboundChatMessageBuilder.cs
@@ -1,10 +1,12 @@
-namespace TwitchLib.Client.Models.Builders
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace TwitchLib.Client.Models.Builders
 {
     public sealed class OutboundChatMessageBuilder : IBuilder<OutboundChatMessage>
     {
         private string _channel;
         private string _message;
-        private string _userName;
 
         private OutboundChatMessageBuilder()
         {
@@ -27,20 +29,9 @@ public OutboundChatMessageBuilder WithMessage(string message)
             return this;
         }
 
-        public OutboundChatMessageBuilder WithUsername(string userName)
-        {
-            _userName = userName;
-            return this;
-        }
-
         public OutboundChatMessage Build()
         {
-            return new OutboundChatMessage
-            {
-                Channel = _channel,
-                Message = _message,
-                Username = _userName,
-            };
+            return new OutboundChatMessage(_channel, _message);
         }
     }
 }
diff --git a/TwitchLib.Client.Models/Builders/OutgoingMessageBuilder.cs b/TwitchLib.Client.Models/Builders/OutgoingMessageBuilder.cs
diff --git a/TwitchLib.Client.Models/Builders/RaidNotificationBuilder.cs b/TwitchLib.Client.Models/Builders/RaidNotificationBuilder.cs
@@ -1,4 +1,6 @@
-using System.Drawing;
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
 using TwitchLib.Client.Enums;
 
 namespace TwitchLib.Client.Models.Builders

diff --git a/TwitchLib.Client.Models/Builders/ReSubscriberBuilder.cs b/TwitchLib.Client.Models/Builders/ReSubscriberBuilder.cs
@@ -1,4 +1,7 @@
-namespace TwitchLib.Client.Models.Builders
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace TwitchLib.Client.Models.Builders
 {
     public sealed class ReSubscriberBuilder : SubscriberBaseBuilder, IBuilder<ReSubscriber>, IFromIrcMessageBuilder<ReSubscriber>
     {

diff --git a/TwitchLib.Client.Models/Builders/RitualNewChatterBuilder.cs b/TwitchLib.Client.Models/Builders/RitualNewChatterBuilder.cs
@@ -1,4 +1,7 @@
-namespace TwitchLib.Client.Models.Builders
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace TwitchLib.Client.Models.Builders
 {
     public sealed class RitualNewChatterBuilder : IFromIrcMessageBuilder<RitualNewChatter>
     {

diff --git a/TwitchLib.Client.Models/Builders/SentMessageBuilder.cs b/TwitchLib.Client.Models/Builders/SentMessageBuilder.cs
@@ -1,4 +1,7 @@
-using TwitchLib.Client.Enums;
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+using TwitchLib.Client.Enums;
 
 namespace TwitchLib.Client.Models.Builders
 {

diff --git a/TwitchLib.Client.Models/Builders/SubscriberBaseBuilder.cs b/TwitchLib.Client.Models/Builders/SubscriberBaseBuilder.cs
@@ -1,4 +1,6 @@
-using System.Drawing;
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
 using TwitchLib.Client.Enums;
 
 namespace TwitchLib.Client.Models.Builders

diff --git a/TwitchLib.Client.Models/Builders/SubscriberBuilder.cs b/TwitchLib.Client.Models/Builders/SubscriberBuilder.cs
@@ -1,4 +1,7 @@
-namespace TwitchLib.Client.Models.Builders
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace TwitchLib.Client.Models.Builders
 {
     public sealed class SubscriberBuilder : SubscriberBaseBuilder, IBuilder<Subscriber>, IFromIrcMessageBuilder<Subscriber>
     {

diff --git a/TwitchLib.Client.Models/Builders/TwitchLibMessageBuilder.cs b/TwitchLib.Client.Models/Builders/TwitchLibMessageBuilder.cs
@@ -1,4 +1,7 @@
-using TwitchLib.Client.Enums;
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+using TwitchLib.Client.Enums;
 
 namespace TwitchLib.Client.Models.Builders
 {

diff --git a/TwitchLib.Client.Models/Builders/UserBanBuilder.cs b/TwitchLib.Client.Models/Builders/UserBanBuilder.cs
@@ -1,4 +1,7 @@
-namespace TwitchLib.Client.Models.Builders
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace TwitchLib.Client.Models.Builders
 {
     public sealed class UserBanBuilder : IBuilder<UserBan>, IFromIrcMessageBuilder<UserBan>
     {

diff --git a/TwitchLib.Client.Models/Builders/UserStateBuilder.cs b/TwitchLib.Client.Models/Builders/UserStateBuilder.cs
@@ -1,4 +1,6 @@
-using System.Drawing;
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
 using TwitchLib.Client.Enums;
 
 namespace TwitchLib.Client.Models.Builders

diff --git a/TwitchLib.Client.Models/Builders/UserTimeoutBuilder.cs b/TwitchLib.Client.Models/Builders/UserTimeoutBuilder.cs
@@ -1,4 +1,7 @@
-namespace TwitchLib.Client.Models.Builders
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace TwitchLib.Client.Models.Builders
 {
     public sealed class UserTimeoutBuilder : IBuilder<UserTimeout>, IFromIrcMessageBuilder<UserTimeout>
     {

diff --git a/TwitchLib.Client.Models/Builders/WhisperMessageBuilder.cs b/TwitchLib.Client.Models/Builders/WhisperMessageBuilder.cs
@@ -1,4 +1,7 @@
-namespace TwitchLib.Client.Models.Builders
+#nullable disable
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace TwitchLib.Client.Models.Builders
 {
     public sealed class WhisperMessageBuilder : IBuilder<WhisperMessage>, IFromIrcMessageBuilder<WhisperMessage>
     {

diff --git a/TwitchLib.Client.Models/ChannelState.cs b/TwitchLib.Client.Models/ChannelState.cs
@@ -6,7 +6,7 @@ namespace TwitchLib.Client.Models
     public class ChannelState
     {
         /// <summary>Property representing the current broadcaster language.</summary>
-        public string BroadcasterLanguage { get; }
+        public string BroadcasterLanguage { get; } = default!;
 
         /// <summary>Property representing the current channel.</summary>
         public string Channel { get; }
@@ -27,14 +27,19 @@ public class ChannelState
         public bool? Rituals { get; }
 
         /// <summary>Twitch assigned room id</summary>
-        public string RoomId { get; }
+        public string RoomId { get; } = default!;
 
         /// <summary>Property representing whether Slow mode is being applied to chat or not. WILL BE NULL IF VALUE NOT PRESENT.</summary>
         public int? SlowMode { get; }
 
         /// <summary>Property representing whether Sub Mode is being applied to chat or not. WILL BE NULL IF VALUE NOT PRESENT.</summary>
         public bool? SubOnly { get; }
 
+        /// <summary>
+        /// Contains undocumented tags.
+        /// </summary>
+        public Dictionary<string, string>? UndocumentedTags { get; }
+
         /// <summary>ChannelState object constructor.</summary>
         public ChannelState(IrcMessage ircMessage)
         {
@@ -76,13 +81,16 @@ public ChannelState(IrcMessage ircMessage)
                         Mercury = TagHelper.ToBool(tagValue);
                         break;
                     default:
-                        Console.WriteLine("[TwitchLib][ChannelState] Unaccounted for: " + tag);
+                        (UndocumentedTags = new()).Add(tag.Key, tag.Value);
                         break;
                 }
             }
             Channel = ircMessage.Channel;
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ChannelState"/> class.
+        /// </summary>
         public ChannelState(
             bool r9k,
             bool rituals,