Add support for channel.chat.notification

Author: MrLawbreaker

TwitchLib.EventSub.Websockets/Core/EventArgs/Channel/ChannelChatNotificationArgs.cs

@@ -0,0 +1,8 @@
+using TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
+using TwitchLib.EventSub.Websockets.Core.Models;
+namespace TwitchLib.EventSub.Websockets.Core.EventArgs.Channel
+{
+    public class ChannelChatNotificationArgs : TwitchLibEventSubEventArgs<EventSubNotification<ChannelChatNotification>>
+    {
+    }
+}

TwitchLib.EventSub.Websockets/EventSubWebsocketClient.cs

@@ -81,6 +81,10 @@ public class EventSubWebsocketClient
         /// </summary>
         public event AsyncEventHandler<ChannelChatMessageDeleteArgs> ChannelChatMessageDelete;
         /// <summary>
+        /// Event that triggers on "channel.chat.notification" notifications
+        /// </summary>
+        public event AsyncEventHandler<ChannelChatNotificationArgs> ChannelChatNotification;
+        /// <summary>
         /// Event that triggers on "channel.cheer" notifications
         /// </summary>
         public event AsyncEventHandler<ChannelCheerArgs> ChannelCheer;
@@ -339,7 +343,7 @@ public class EventSubWebsocketClient
         /// <param name="serviceProvider">DI Container to resolve other dependencies dynamically</param>
         /// <param name="websocketClient">Underlying Websocket client to connect to connect to EventSub Websocket service</param>
         /// <exception cref="ArgumentNullException">Throws ArgumentNullException if a dependency is null</exception>
-        public EventSubWebsocketClient(ILogger<EventSubWebsocketClient> logger, IEnumerable<INotificationHandler> handlers, IServiceProvider serviceProvider, WebsocketClient websocketClient)
+        public EventSubWebsocketClient ( ILogger<EventSubWebsocketClient> logger, IEnumerable<INotificationHandler> handlers, IServiceProvider serviceProvider, WebsocketClient websocketClient )
         {
             _logger = logger ?? throw new ArgumentNullException(nameof(logger));
             _serviceProvider = serviceProvider ?? throw new ArgumentNullException(nameof(serviceProvider));
@@ -358,7 +362,7 @@ public EventSubWebsocketClient(ILogger<EventSubWebsocketClient> logger, IEnumera
         /// Instantiates an EventSubWebsocketClient used to subscribe to EventSub notifications via Websockets.
         /// </summary>
         /// <param name="loggerFactory">LoggerFactory used to construct Loggers for the EventSubWebsocketClient and underlying classes</param>
-        public EventSubWebsocketClient(ILoggerFactory loggerFactory = null)
+        public EventSubWebsocketClient ( ILoggerFactory loggerFactory = null )
         {
             _loggerFactory = loggerFactory;
 
@@ -390,7 +394,7 @@ public EventSubWebsocketClient(ILoggerFactory loggerFactory = null)
         /// </summary>
         /// <param name="url">Optional url param to be able to connect to reconnect urls provided by Twitch or test servers</param>
         /// <returns>true: Connection successful false: Connection failed</returns>
-        public async Task<bool> ConnectAsync(Uri url = null)
+        public async Task<bool> ConnectAsync ( Uri url = null )
         {
             url = url ?? new Uri(WEBSOCKET_URL);
             _lastReceived = DateTimeOffset.MinValue;
@@ -413,7 +417,7 @@ public async Task<bool> ConnectAsync(Uri url = null)
         /// Disconnect from Twitch EventSub Websockets
         /// </summary>
         /// <returns>true: Disconnect successful false: Disconnect failed</returns>
-        public async Task<bool> DisconnectAsync()
+        public async Task<bool> DisconnectAsync ()
         {
             _cts?.Cancel();
             return await _websocketClient.DisconnectAsync();
@@ -423,7 +427,7 @@ public async Task<bool> DisconnectAsync()
         /// Reconnect to Twitch EventSub Websockets with a Twitch given Url
         /// </summary>
         /// <returns>true: Reconnect successful false: Reconnect failed</returns>
-        public Task<bool> ReconnectAsync()
+        public Task<bool> ReconnectAsync ()
         {
             return ReconnectAsync(new Uri(WEBSOCKET_URL));
         }
@@ -433,7 +437,7 @@ public Task<bool> ReconnectAsync()
         /// </summary>
         /// <param name="url">New Websocket Url to connect to, to preserve current session and topics</param>
         /// <returns>true: Reconnect successful false: Reconnect failed</returns>
-        private async Task<bool> ReconnectAsync(Uri url)
+        private async Task<bool> ReconnectAsync ( Uri url )
         {
             url = url ?? new Uri(WEBSOCKET_URL);
 
@@ -505,7 +509,7 @@ private async Task<bool> ReconnectAsync(Uri url)
         /// Setup handlers for all supported subscription types
         /// </summary>
         /// <param name="handlers">Enumerable of handlers that are responsible for acting on a specified subscription type</param>
-        private void PrepareHandlers(IEnumerable<INotificationHandler> handlers)
+        private void PrepareHandlers ( IEnumerable<INotificationHandler> handlers )
         {
             _handlers = _handlers ?? new Dictionary<string, Action<EventSubWebsocketClient, string, JsonSerializerOptions>>();
 
@@ -525,7 +529,7 @@ private void PrepareHandlers(IEnumerable<INotificationHandler> handlers)
         /// <para>E.g. a Twitch specified 10 seconds minimum frequency would result in 12 seconds used by the client to honor network latencies and so on.</para>
         /// </summary>
         /// <returns>a Task that represents the background operation</returns>
-        private async Task ConnectionCheckAsync()
+        private async Task ConnectionCheckAsync ()
         {
             while (_cts != null && _websocketClient.IsConnected && !_cts.IsCancellationRequested)
             {
@@ -547,7 +551,7 @@ private async Task ConnectionCheckAsync()
         /// </summary>
         /// <param name="sender">Sender of the event. In this case <see cref="WebsocketClient"/></param>
         /// <param name="e">EventArgs send with the event. <see cref="DataReceivedArgs"/></param>
-        private async Task OnDataReceived(object sender, DataReceivedArgs e)
+        private async Task OnDataReceived ( object sender, DataReceivedArgs e )
         {
             _lastReceived = DateTimeOffset.Now;
 
@@ -592,7 +596,7 @@ private async Task OnDataReceived(object sender, DataReceivedArgs e)
         /// </summary>
         /// <param name="sender">Sender of the event. In this case <see cref="WebsocketClient"/></param>
         /// <param name="e">EventArgs send with the event. <see cref="ErrorOccuredArgs"/></param>
-        private async Task OnErrorOccurred(object sender, ErrorOccuredArgs e)
+        private async Task OnErrorOccurred ( object sender, ErrorOccuredArgs e )
         {
             await ErrorOccurred.InvokeAsync(this, e);
         }
@@ -601,7 +605,7 @@ private async Task OnErrorOccurred(object sender, ErrorOccuredArgs e)
         /// Handles 'session_reconnect' notifications
         /// </summary>
         /// <param name="message">notification message received from Twitch EventSub</param>
-        private void HandleReconnect(string message)
+        private void HandleReconnect ( string message )
         {
             _logger?.LogReconnectRequested(SessionId);
             var data = JsonSerializer.Deserialize<EventSubWebsocketSessionInfoMessage>(message, _jsonSerializerOptions);
@@ -616,7 +620,7 @@ private void HandleReconnect(string message)
         /// Handles 'session_welcome' notifications
         /// </summary>
         /// <param name="message">notification message received from Twitch EventSub</param>
-        private async ValueTask HandleWelcome(string message)
+        private async ValueTask HandleWelcome ( string message )
         {
             var data = JsonSerializer.Deserialize<EventSubWebsocketSessionInfoMessage>(message, _jsonSerializerOptions);
 
@@ -640,7 +644,7 @@ private async ValueTask HandleWelcome(string message)
         /// Handles 'session_disconnect' notifications
         /// </summary>
         /// <param name="message">notification message received from Twitch EventSub</param>
-        private async Task HandleDisconnect(string message)
+        private async Task HandleDisconnect ( string message )
         {
             var data = JsonSerializer.Deserialize<EventSubWebsocketSessionInfoMessage>(message);
 
@@ -654,7 +658,7 @@ private async Task HandleDisconnect(string message)
         /// Handles 'session_keepalive' notifications
         /// </summary>
         /// <param name="message">notification message received from Twitch EventSub</param>
-        private void HandleKeepAlive(string message)
+        private void HandleKeepAlive ( string message )
         {
             _logger?.LogMessage(message);
         }
@@ -664,7 +668,7 @@ private void HandleKeepAlive(string message)
         /// </summary>
         /// <param name="message">notification message received from Twitch EventSub</param>
         /// <param name="subscriptionType">subscription type received from Twitch EventSub</param>
-        private void HandleNotification(string message, string subscriptionType)
+        private void HandleNotification ( string message, string subscriptionType )
         {
             if (_handlers != null && _handlers.TryGetValue(subscriptionType, out var handler))
                 handler(this, message, _jsonSerializerOptions);
@@ -676,7 +680,7 @@ private void HandleNotification(string message, string subscriptionType)
         /// Handles 'revocation' notifications
         /// </summary>
         /// <param name="message">notification message received from Twitch EventSub</param>
-        private void HandleRevocation(string message)
+        private void HandleRevocation ( string message )
         {
             if (_handlers != null && _handlers.TryGetValue("revocation", out var handler))
                 handler(this, message, _jsonSerializerOptions);
@@ -689,7 +693,7 @@ private void HandleRevocation(string message)
         /// </summary>
         /// <param name="eventName">name of the event to raise</param>
         /// <param name="args">args to pass with the event</param>
-        internal async void RaiseEvent(string eventName, object args = null)
+        internal async void RaiseEvent ( string eventName, object args = null )
         {
             var fInfo = GetType().GetField(eventName, BindingFlags.Instance | BindingFlags.NonPublic);
 

TwitchLib.EventSub.Websockets/Handler/Channel/Chat/ChatNotificationHandler.cs

@@ -0,0 +1,30 @@
+using System;
+using System.Text.Json;
+using TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
+using TwitchLib.EventSub.Websockets.Core.EventArgs;
+using TwitchLib.EventSub.Websockets.Core.EventArgs.Channel;
+using TwitchLib.EventSub.Websockets.Core.Handler;
+using TwitchLib.EventSub.Websockets.Core.Models;
+
+namespace TwitchLib.EventSub.Websockets.Handler.Channel.Chat
+{
+    public class ChatNotificationHandler : INotificationHandler
+    {
+        public string SubscriptionType => "channel.chat.notification";
+
+        public void Handle ( EventSubWebsocketClient client, string jsonString, JsonSerializerOptions serializerOptions )
+        {
+            try
+            {
+                var data = JsonSerializer.Deserialize<EventSubNotification<ChannelChatNotification>>(jsonString.AsSpan(), serializerOptions);
+                if (data is null)
+                    throw new InvalidOperationException("Parsed JSON cannot be null!");
+                client.RaiseEvent("ChannelChatNotification", new ChannelChatNotificationArgs { Notification = data });
+            }
+            catch (Exception ex)
+            {
+                client.RaiseEvent("ErrorOccurred", new ErrorOccuredArgs { Exception = ex, Message = $"Error encountered while trying to handle {SubscriptionType} notification! Raw Json: {jsonString}" });
+            }
+        }
+    }
+}