Merge pull request #42 from AoshiW/props-and-typos-and-comments

new props, fixed typos, fixed default value for (non)nullable props, XML comments

Author: AoshiW

TwitchLib.EventSub.Core/Extensions/AsyncEventHandlerExtensions.cs

@@ -5,12 +5,12 @@ namespace TwitchLib.EventSub.Core.Extensions;
 
 public static class AsyncEventHandlerExtensions
 {
-    public static Task InvokeAsync<TEventArgs>(this AsyncEventHandler<TEventArgs> asyncEventHandler, object sender, TEventArgs args)
+    public static Task InvokeAsync<TEventArgs>(this AsyncEventHandler<TEventArgs>? asyncEventHandler, object sender, TEventArgs args)
     {
         return asyncEventHandler != null ? asyncEventHandler(sender, args) : Task.CompletedTask;
     }
 
-    public static Task InvokeAsync(this AsyncEventHandler asyncEventHandler, object sender, EventArgs args)
+    public static Task InvokeAsync(this AsyncEventHandler? asyncEventHandler, object sender, EventArgs args)
     {
         return asyncEventHandler != null ? asyncEventHandler(sender, args) : Task.CompletedTask;
     }

TwitchLib.EventSub.Core/Models/Chat/ChatCheer.cs

@@ -1,7 +1,9 @@
-namespace TwitchLib.EventSub.Core.Models.Chat
+namespace TwitchLib.EventSub.Core.Models.Chat;
+
+public sealed class ChatCheer
 {
-    public sealed class ChatCheer
-    {
-        public int Bits { get; set; }
-    }
+    /// <summary>
+    /// The amount of Bits the user cheered.
+    /// </summary>
+    public int Bits { get; set; }
 }

TwitchLib.EventSub.Core/Models/Chat/ChatReply.cs

@@ -1,15 +1,41 @@
-namespace TwitchLib.EventSub.Core.Models.Chat
+namespace TwitchLib.EventSub.Core.Models.Chat;
+
+public sealed class ChatReply
 {
-    public sealed class ChatReply
-    {
-        public string ParentMessageId { get; set; } = string.Empty;
-        public string ParentMessageBody { get; set; } = string.Empty;
-        public string ParentUserId { get; set; } = string.Empty;
-        public string ParentUserName { get; set; } = string.Empty;
-        public string ParentUserLogin { get; set; } = string.Empty;
-        public string ThreadMessageId { get; set; } = string.Empty;
-        public string ThreadUserId { get; set; } = string.Empty;
-        public string ThreadUserName { get; set; } = string.Empty;
-        public string ThreadUserLogin { get; set; } = string.Empty;
-    }
+    /// <summary>
+    /// An ID that uniquely identifies the parent message that this message is replying to.
+    /// </summary>
+    public string ParentMessageId { get; set; } = string.Empty;
+    /// <summary>
+    /// The message body of the parent message.
+    /// </summary>
+    public string ParentMessageBody { get; set; } = string.Empty;
+    /// <summary>
+    /// User ID of the sender of the parent message.
+    /// </summary>
+    public string ParentUserId { get; set; } = string.Empty;
+    /// <summary>
+    /// User name of the sender of the parent message.
+    /// </summary>
+    public string ParentUserName { get; set; } = string.Empty;
+    /// <summary>
+    /// User login of the sender of the parent message.
+    /// </summary>
+    public string ParentUserLogin { get; set; } = string.Empty;
+    /// <summary>
+    /// An ID that identifies the parent message of the reply thread.
+    /// </summary>
+    public string ThreadMessageId { get; set; } = string.Empty;
+    /// <summary>
+    /// User ID of the sender of the thread’s parent message.
+    /// </summary>
+    public string ThreadUserId { get; set; } = string.Empty;
+    /// <summary>
+    /// User name of the sender of the thread’s parent message.
+    /// </summary>
+    public string ThreadUserName { get; set; } = string.Empty;
+    /// <summary>
+    /// User login of the sender of the thread’s parent message.
+    /// </summary>
+    public string ThreadUserLogin { get; set; } = string.Empty;
 }

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelChatMessage.cs

@@ -4,6 +4,11 @@
 
 namespace TwitchLib.EventSub.Core.SubscriptionTypes.Channel
 {
+    /// <summary>
+    /// Channel Chat Message subscription type model
+    /// <para>Description:</para>
+    /// <para>Any user sends a message to a channel’s chat room.</para>
+    /// </summary>
     public sealed class ChannelChatMessage
     {
         /// <summary>
@@ -61,39 +66,47 @@ public sealed class ChannelChatMessage
         /// </summary>
         public ChatCheer? Cheer { get; set; }
 
-        /// <summary>Metadata if this message is a reply.</summary>
+        /// <summary>
+        /// Metadata if this message is a reply.
+        /// </summary>
         public ChatReply? Reply { get; set; }
 
         /// <summary>
         /// Optional. The ID of a channel points custom reward that was redeemed.
         /// </summary>
-        public string? ChannelPointsCustomRewardId { get; set; } = string.Empty;
+        public string? ChannelPointsCustomRewardId { get; set; }
 
         /// <summary>
         /// Optional. The broadcaster user ID of the channel the message was sent from.
         /// </summary>
-        public string? SourceBroadcasterUserId { get; set; } = string.Empty;
+        public string? SourceBroadcasterUserId { get; set; }
 
         /// <summary>
         /// Optional. The user name of the broadcaster of the channel the message was sent from.
         /// </summary>
-        public string? SourceBroadcasterUserName {  get; set; } = string.Empty;
+        public string? SourceBroadcasterUserName {  get; set; }
 
         /// <summary>
         /// Optional. The login of the broadcaster of the channel the message was sent from. 
         /// </summary>
-        public string? SourceBroadcasterUserLogin {  get; set; } = string.Empty;
+        public string? SourceBroadcasterUserLogin {  get; set; }
 
         /// <summary>
         /// Optional. The UUID that identifies the source message from the channel the message was sent from.
         /// </summary>
-        public string? SourceMessageId {  get; set; } = string.Empty;
+        public string? SourceMessageId {  get; set; }
 
         /// <summary>
         /// Optional. The list of chat badges for the chatter in the channel the message was sent from. 
         /// </summary>
-        public ChatBadge[]? SourceBadges { get; set; } = [];
+        public ChatBadge[]? SourceBadges { get; set; }
 
+        /// <summary>
+        /// Optional. Determines if a message delivered during a shared chat session is only sent to the source channel.
+        /// Has no effect if the message is not sent during a shared chat session.
+        /// </summary>
+        public bool? IsSourceOnly { get; set; }
+      
         /// <summary>
         /// Returns true if viewer is a subscriber
         /// </summary>

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelGuestStarGuestUpdate.cs

@@ -12,15 +12,15 @@ public sealed class ChannelGuestStarGuestUpdate : ChannelGuestStarBase
     /// <summary>
     /// User ID of the host channel.
     /// </summary>
-    public string HostUserId { get; set; }
+    public string HostUserId { get; set; } = string.Empty;
     /// <summary>
     /// The host display name.
     /// </summary>
-    public string HostUserName { get; set; }
+    public string HostUserName { get; set; } = string.Empty;
     /// <summary>
     /// The host login.
     /// </summary>
-    public string HostUserLogin { get; set; }
+    public string HostUserLogin { get; set; } = string.Empty;
     /// <summary>
     /// The current state of the user after the update has taken place. Can be one of the following:
     /// <para>

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelGuestStarSessionEnd.cs

@@ -21,13 +21,13 @@ public sealed class ChannelGuestStarSessionEnd : ChannelGuestStarSessionBase
     /// <summary>
     /// User ID of the host channel.
     /// </summary>
-    public string HostUserId { get; set; }
+    public string HostUserId { get; set; } = string.Empty;
     /// <summary>
     /// The host display name.
     /// </summary>
-    public string HostUserName { get; set; }
+    public string HostUserName { get; set; } = string.Empty;
     /// <summary>
     /// The host login.
     /// </summary>
-    public string HostUserLogin { get; set; }
-}
+    public string HostUserLogin { get; set; } = string.Empty;
+}

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelShoutoutReceive.cs

@@ -1,4 +1,5 @@
-using TwitchLib.EventSub.Core.Models.Shoutouts;
+using System;
+using TwitchLib.EventSub.Core.Models.Shoutouts;
 
 namespace TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
 
@@ -12,13 +13,28 @@ public sealed class ChannelShoutoutReceive : ShoutoutBase
     /// <summary>
     /// An ID that identifies the broadcaster that received the Shoutout.
     /// </summary>
+    [Obsolete("This property is a typo, please use: FromBroadcasterUserId")]
     public string ToBroadcasterUserId { get; set; } = string.Empty;
     /// <summary>
     /// The receiving broadcaster’s display name.
     /// </summary>
+    [Obsolete("This property is a typo, please use: FromBroadcasterUserName")]
     public string ToBroadcasterUserName { get; set; } = string.Empty;
     /// <summary>
     /// The receiving broadcaster’s login name.
     /// </summary>
+    [Obsolete("This property is a typo, please use: FromBroadcasterUserLogin")]
     public string ToBroadcasterUserLogin { get; set; } = string.Empty;
+    /// <summary>
+    /// An ID that identifies the broadcaster that sent the Shoutout.
+    /// </summary>
+    public string FromBroadcasterUserId { get; set; } = string.Empty;
+    /// <summary>
+    /// The broadcaster’s display name.
+    /// </summary>
+    public string FromBroadcasterUserName { get; set; } = string.Empty;
+    /// <summary>
+    /// The broadcaster’s login name.
+    /// </summary>
+    public string FromBroadcasterUserLogin { get; set; } = string.Empty;
 }

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelSuspiciousUserMessage.cs

@@ -2,6 +2,11 @@
 
 namespace TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
 
+/// <summary>
+/// Channel Suspicious User Message subscription type model
+/// <para>Description:</para>
+/// <para>A notification when a chat message has been sent from a suspicious user.</para>
+/// </summary>
 public sealed class ChannelSuspiciousUserMessage : ChannelSuspiciousUserBase
 {
     /// <summary>

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelSuspiciousUserUpdate.cs

@@ -2,6 +2,11 @@
 
 namespace TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
 
+/// <summary>
+/// Channel Suspicious User Message subscription type model
+/// <para>Description:</para>
+/// <para>A notification when a suspicious user has been updated.</para>
+/// </summary>
 public sealed class ChannelSuspiciousUserUpdate : ChannelSuspiciousUserBase
 {
     /// <summary>

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelUpdate.cs

@@ -1,4 +1,6 @@
-namespace TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
+using System;
+
+namespace TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
 
 /// <summary>
 /// Channel Update subscription type model
@@ -38,5 +40,11 @@ public sealed class ChannelUpdate
     /// <summary>
     /// A boolean identifying whether the channel is flagged as mature.
     /// </summary>
+    [Obsolete("Removed 2023‑06‑29, please use: ContentClassificationLabels")]
     public bool IsMature { get; set; }
+    /// <summary>
+    /// Array of content classification label IDs currently applied on the Channel.
+    /// To retrieve a list of all possible IDs, use the <see href="https://dev.twitch.tv/docs/api/reference/#get-content-classification-labels">Get Content Classification Labels</see> API endpoint.
+    /// </summary>
+    public string[] ContentClassificationLabels { get; set; } = [];
 }

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelWarningSend.cs

@@ -46,9 +46,9 @@ public sealed class ChannelWarningSend
     /// <summary>
     /// Optional. The reason given for the warning.
     /// </summary>
-    public string Reason { get; set; } = string.Empty;
+    public string? Reason { get; set; }
     /// <summary>
     /// Optional. The chat rules cited for the warning.
     /// </summary>
-    public string[] ChatRulesCited { get; set; } = [string.Empty];
-}
+    public string[]? ChatRulesCited { get; set; }
+}