Add Icons to IRole (discord-net#204)

* Added icon field to IRole * Added GetGuildRoleIconUrl()
quinchs · Oct 1, 2021 · 42b693c · 42b693c
1 parent 9b7e3da
commit 42b693c
Show file tree

Hide file tree

Showing 8 changed files with 79 additions and 0 deletions.
diff --git a/src/Discord.Net.Core/CDN.cs b/src/Discord.Net.Core/CDN.cs
@@ -86,6 +86,16 @@ public static string GetDefaultUserAvatarUrl(ushort discriminator)
         public static string GetGuildIconUrl(ulong guildId, string iconId)
             => iconId != null ? $"{DiscordConfig.CDNUrl}icons/{guildId}/{iconId}.jpg" : null;
         /// <summary>
+        ///     Returns a guild role's icon URL.
+        /// </summary>
+        /// <param name="roleId">The role identifier.</param>
+        /// <param name="roleHash">The icon hash.</param>
+        /// <returns>
+        ///     A URL pointing to the guild role's icon.
+        /// </returns>
+        public static string GetGuildRoleIconUrl(ulong roleId, string roleHash)
+            => roleHash != null ? $"{DiscordConfig.CDNUrl}role-icons/{roleId}/{roleHash}.png" : null;
+        /// <summary>
         ///     Returns a guild splash URL.
         /// </summary>
         /// <param name="guildId">The guild snowflake identifier.</param>

diff --git a/src/Discord.Net.Core/Discord.Net.Core.xml b/src/Discord.Net.Core/Discord.Net.Core.xml
@@ -131,6 +131,16 @@
                 A URL pointing to the guild's icon.
             </returns>
         </member>
+        <member name="M:Discord.CDN.GetGuildRoleIconUrl(System.UInt64,System.String)">
+            <summary>
+                Returns a guild role's icon URL.
+            </summary>
+            <param name="roleId">The role identifier.</param>
+            <param name="roleHash">The icon hash.</param>
+            <returns>
+                A URL pointing to the guild role's icon.
+            </returns>
+        </member>
         <member name="M:Discord.CDN.GetGuildSplashUrl(System.UInt64,System.String)">
             <summary>
                 Returns a guild splash URL.
@@ -9646,6 +9656,14 @@
                 A string containing the name of this role.
             </returns>
         </member>
+        <member name="P:Discord.IRole.Icon">
+            <summary>
+                Gets the icon of this role.
+            </summary>
+            <returns>
+                A string containing the hash of this role's icon.
+            </returns>
+        </member>
         <member name="P:Discord.IRole.Permissions">
             <summary>
                 Gets the permissions granted to members of this role.
@@ -9684,6 +9702,14 @@
                 A task that represents the asynchronous modification operation.
             </returns>
         </member>
+        <member name="M:Discord.IRole.GetIconUrl">
+            <summary>
+                Gets the image url of the icon role.
+            </summary>
+            <returns>
+                An image url of the icon role.
+            </returns>
+        </member>
         <member name="T:Discord.ReorderRoleProperties">
             <summary>
                 Properties that are used to reorder an <see cref="T:Discord.IRole"/>.

diff --git a/src/Discord.Net.Core/Entities/Roles/IRole.cs b/src/Discord.Net.Core/Entities/Roles/IRole.cs
@@ -52,6 +52,13 @@ public interface IRole : ISnowflakeEntity, IDeletable, IMentionable, IComparable
         /// </returns>
         string Name { get; }
         /// <summary>
+        ///     Gets the icon of this role.
+        /// </summary>
+        /// <returns>
+        ///     A string containing the hash of this role's icon.
+        /// </returns>
+        string Icon { get; }
+        /// <summary>
         ///     Gets the permissions granted to members of this role.
         /// </summary>
         /// <returns>
@@ -86,5 +93,13 @@ public interface IRole : ISnowflakeEntity, IDeletable, IMentionable, IComparable
         ///     A task that represents the asynchronous modification operation.
         /// </returns>
         Task ModifyAsync(Action<RoleProperties> func, RequestOptions options = null);
+
+        /// <summary>
+        ///     Gets the image url of the icon role.
+        /// </summary>
+        /// <returns>
+        ///     An image url of the icon role.
+        /// </returns>
+        string GetIconUrl();
     }
 }
diff --git a/src/Discord.Net.Rest/API/Common/Role.cs b/src/Discord.Net.Rest/API/Common/Role.cs
@@ -8,6 +8,8 @@ internal class Role
         public ulong Id { get; set; }
         [JsonProperty("name")]
         public string Name { get; set; }
+        [JsonProperty("icon")]
+        public string Icon { get; set; }
         [JsonProperty("color")]
         public uint Color { get; set; }
         [JsonProperty("hoist")]

diff --git a/src/Discord.Net.Rest/Discord.Net.Rest.xml b/src/Discord.Net.Rest/Discord.Net.Rest.xml
diff --git a/src/Discord.Net.Rest/Entities/Roles/RestRole.cs b/src/Discord.Net.Rest/Entities/Roles/RestRole.cs
@@ -24,6 +24,8 @@ public class RestRole : RestEntity<ulong>, IRole
         /// <inheritdoc />
         public string Name { get; private set; }
         /// <inheritdoc />
+        public string Icon { get; private set; }
+        /// <inheritdoc />
         public GuildPermissions Permissions { get; private set; }
         /// <inheritdoc />
         public int Position { get; private set; }
@@ -53,6 +55,7 @@ internal static RestRole Create(BaseDiscordClient discord, IGuild guild, Model m
         internal void Update(Model model)
         {
             Name = model.Name;
+            Icon = model.Icon;
             IsHoisted = model.Hoist;
             IsManaged = model.Managed;
             IsMentionable = model.Mentionable;
@@ -73,6 +76,10 @@ public async Task ModifyAsync(Action<RoleProperties> func, RequestOptions option
         public Task DeleteAsync(RequestOptions options = null)
             => RoleHelper.DeleteAsync(this, Discord, options);
 
+        /// <inheritdoc />
+        public string GetIconUrl()
+            => CDN.GetGuildRoleIconUrl(Id, Icon);
+
         /// <inheritdoc />
         public int CompareTo(IRole role) => RoleUtils.Compare(this, role);
 

diff --git a/src/Discord.Net.WebSocket/Discord.Net.WebSocket.xml b/src/Discord.Net.WebSocket/Discord.Net.WebSocket.xml
diff --git a/src/Discord.Net.WebSocket/Entities/Roles/SocketRole.cs b/src/Discord.Net.WebSocket/Entities/Roles/SocketRole.cs
@@ -34,6 +34,8 @@ public class SocketRole : SocketEntity<ulong>, IRole
         /// <inheritdoc />
         public string Name { get; private set; }
         /// <inheritdoc />
+        public string Icon { get; private set; }
+        /// <inheritdoc />
         public GuildPermissions Permissions { get; private set; }
         /// <inheritdoc />
         public int Position { get; private set; }
@@ -72,6 +74,7 @@ internal static SocketRole Create(SocketGuild guild, ClientState state, Model mo
         internal void Update(ClientState state, Model model)
         {
             Name = model.Name;
+            Icon = model.Icon;
             IsHoisted = model.Hoist;
             IsManaged = model.Managed;
             IsMentionable = model.Mentionable;
@@ -89,6 +92,10 @@ public Task ModifyAsync(Action<RoleProperties> func, RequestOptions options = nu
         public Task DeleteAsync(RequestOptions options = null)
             => RoleHelper.DeleteAsync(this, Discord, options);
 
+        /// <inheritdoc />
+        public string GetIconUrl()
+            => CDN.GetGuildRoleIconUrl(Id, Icon);
+
         /// <summary>
         ///     Gets the name of the role.
         /// </summary>