feat: client extensions

Author: LumiFae

DiscordLab.Bot/API/Enums/ChannelReturn.cs

@@ -0,0 +1,33 @@
+namespace DiscordLab.Bot.API.Enums
+{
+    /// <summary>
+    /// Used to determine if a channel was found or not, and if not, the reason why it wasn't found.
+    /// </summary>
+    public enum ChannelReturn
+    {
+        /// <summary>
+        /// The guild and channel were found.
+        /// </summary>
+        Found = 0,
+        /// <summary>
+        /// Couldn't find the guild with the specified ID.
+        /// </summary>
+        InvalidGuild = 1,
+        /// <summary>
+        /// The guild ID was 0.
+        /// </summary>
+        NoGuild = 2,
+        /// <summary>
+        /// Couldn't find the channel with the specified ID.
+        /// </summary>
+        InvalidChannel = 3,
+        /// <summary>
+        /// The channel ID was 0.
+        /// </summary>
+        NoChannel = 4,
+        /// <summary>
+        /// The channel type was not the requested type.
+        /// </summary>
+        InvalidType = 5
+    }
+}

DiscordLab.Bot/API/Enums/GuildReturn.cs

@@ -0,0 +1,21 @@
+namespace DiscordLab.Bot.API.Enums
+{
+    /// <summary>
+    /// Used to determine if a guild was found or not, and if not, the reason why it wasn't found.
+    /// </summary>
+    public enum GuildReturn
+    {
+        /// <summary>
+        /// The guild was found.
+        /// </summary>
+        Found = 0,
+        /// <summary>
+        /// The guild ID was invalid.
+        /// </summary>
+        InvalidGuild = 1,
+        /// <summary>
+        /// The guild ID was 0.
+        /// </summary>
+        NoGuild = 2
+    }
+}

DiscordLab.Bot/API/Extensions/ClientExtensions.cs

@@ -0,0 +1,65 @@
+using Discord.WebSocket;
+using DiscordLab.Bot.API.Enums;
+
+namespace DiscordLab.Bot.API.Extensions
+{
+    public static class ClientExtensions
+    {
+        public static GuildReturn TryGetGuild(this DiscordSocketClient client, ulong guildId, out SocketGuild guild)
+        {
+            if (guildId == 0)
+            {
+                guild = null;
+                return GuildReturn.NoGuild;
+            }
+            SocketGuild tempGuild = client.GetGuild(guildId);
+            if (tempGuild == null)
+            {
+                guild = null;
+                return GuildReturn.InvalidGuild;
+            }
+            guild = tempGuild;
+            return GuildReturn.Found;
+        }
+        
+        public static ChannelReturn TryGetTextChannel(this DiscordSocketClient client, ulong channelId, out SocketTextChannel channel)
+        {
+            if (channelId == 0)
+            {
+                channel = null;
+                return ChannelReturn.NoChannel;
+            }
+            SocketChannel tempChannel = client.GetChannel(channelId);
+            if (tempChannel == null)
+            {
+                channel = null;
+                return ChannelReturn.InvalidChannel;
+            }
+            if(tempChannel is not SocketTextChannel textChannel)
+            {
+                channel = null;
+                return ChannelReturn.InvalidType;
+            }
+            channel = textChannel;
+            return ChannelReturn.Found;
+        }
+
+        public static ChannelReturn TryGetTextChannel(this SocketGuild guild, ulong channelId,
+            out SocketTextChannel channel)
+        {
+            if(channelId == 0)
+            {
+                channel = null;
+                return ChannelReturn.NoChannel;
+            }
+            SocketTextChannel tempChannel = guild.GetTextChannel(channelId);
+            if (tempChannel == null)
+            {
+                channel = null;
+                return ChannelReturn.InvalidChannel;
+            }
+            channel = tempChannel;
+            return ChannelReturn.Found;
+        }
+    }
+}