Merge pull request #117 from pilky/raid-cancel-events

Add support for raid_cancel_v2 event
TwitchLib · Apr 28, 2023 · 658e305 · 658e305
2 parents 9b12b32 + 273fd50
commit 658e305
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 1 deletion.
diff --git a/TwitchLib.PubSub/Enums/RaidType.cs b/TwitchLib.PubSub/Enums/RaidType.cs
@@ -20,6 +20,10 @@ public enum RaidType
         /// <summary>
         /// When the raid actually starts
         /// </summary>
-        RaidGo
+        RaidGo,
+        /// <summary>
+        /// When the raid is cancelled
+        /// </summary>
+        RaidCancel
     }
 }
diff --git a/TwitchLib.PubSub/Events/OnRaidCancelArgs.cs b/TwitchLib.PubSub/Events/OnRaidCancelArgs.cs
@@ -0,0 +1,38 @@
+using System;
+
+namespace TwitchLib.PubSub.Events {
+    /// <inheritdoc />
+    /// <summary>
+    /// Object representing the arguments for a raid cancel event
+    /// </summary>
+    public class OnRaidCancelArgs: EventArgs {
+        /// <summary>
+        /// The channel ID the event came from
+        /// </summary>
+        public string ChannelId;
+        /// <summary>
+        /// Property representing the id of the raid event
+        /// </summary>
+        public Guid Id;
+        /// <summary>
+        /// Property representing the target channel id
+        /// </summary>
+        public string TargetChannelId;
+        /// <summary>
+        /// Property representing the target channel login
+        /// </summary>
+        public string TargetLogin;
+        /// <summary>
+        /// Property representing  the target display name
+        /// </summary>
+        public string TargetDisplayName;
+        /// <summary>
+        /// Property representing the target profile image url
+        /// </summary>
+        public string TargetProfileImage;
+        /// <summary>
+        /// Property representing the count of people in the raid
+        /// </summary>
+        public int ViewerCount;
+    }
+}
diff --git a/TwitchLib.PubSub/Models/Responses/Messages/RaidEvents.cs b/TwitchLib.PubSub/Models/Responses/Messages/RaidEvents.cs
@@ -86,6 +86,9 @@ public RaidEvents(string jsonStr)
                 case "raid_go_v2":
                     Type = RaidType.RaidGo;
                     break;
+                case "raid_cancel_v2":
+                    Type = RaidType.RaidCancel;
+                    break;
 
             }
 
@@ -118,6 +121,15 @@ public RaidEvents(string jsonStr)
                     TargetProfileImage = json.SelectToken("raid.target_profile_image").ToString();
                     ViewerCount = int.Parse(json.SelectToken("raid.viewer_count").ToString());
                     break;
+                case RaidType.RaidCancel:
+                    Id = Guid.Parse(json.SelectToken("raid.id").ToString());
+                    ChannelId = json.SelectToken("raid.source_id").ToString();
+                    TargetChannelId = json.SelectToken("raid.target_id").ToString();
+                    TargetLogin = json.SelectToken("raid.target_login").ToString();
+                    TargetDisplayName = json.SelectToken("raid.target_display_name").ToString();
+                    TargetProfileImage = json.SelectToken("raid.target_profile_image").ToString();
+                    ViewerCount = int.Parse(json.SelectToken("raid.viewer_count").ToString());
+                    break;
             }
         }
     }

diff --git a/TwitchLib.PubSub/TwitchPubSub.cs b/TwitchLib.PubSub/TwitchPubSub.cs
@@ -250,6 +250,11 @@ public class TwitchPubSub : ITwitchPubSub
         public event EventHandler<OnRaidGoArgs> OnRaidGo;
         /// <inheritdoc />
         /// <summary>
+        /// Fires when PubSub receives notice when a channel cancels the raid
+        /// </summary>
+        public event EventHandler<OnRaidCancelArgs> OnRaidCancel; 
+        /// <inheritdoc />
+        /// <summary>
         /// Fires when PubSub receives any data from Twitch
         /// </summary>
         public event EventHandler<OnLogArgs> OnLog;
@@ -647,6 +652,9 @@ private void ParseMessage(string message)
                                 case RaidType.RaidGo:
                                     OnRaidGo?.Invoke(this, new OnRaidGoArgs { Id = r.Id, ChannelId = r.ChannelId, TargetChannelId = r.TargetChannelId, TargetLogin = r.TargetLogin, TargetDisplayName = r.TargetDisplayName, TargetProfileImage = r.TargetProfileImage, ViewerCount = r.ViewerCount });
                                     return;
+                                case RaidType.RaidCancel:
+                                    OnRaidCancel?.Invoke(this, new OnRaidCancelArgs() { Id = r.Id, ChannelId = r.ChannelId, TargetChannelId = r.TargetChannelId, TargetLogin = r.TargetLogin, TargetDisplayName = r.TargetDisplayName, TargetProfileImage = r.TargetProfileImage, ViewerCount = r.ViewerCount });
+                                    return;
                             }
                             return;
                         case "predictions-channel-v1":