Add DisplayName property to IGuildUser. (#2107)

discord-net · Feb 16, 2022 · abfba3c · abfba3c
1 parent 169d54f
commit abfba3c
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 1 deletion.
diff --git a/src/Discord.Net.Core/Entities/Users/IGuildUser.cs b/src/Discord.Net.Core/Entities/Users/IGuildUser.cs
@@ -18,6 +18,13 @@ public interface IGuildUser : IUser, IVoiceState
         /// </returns>
         DateTimeOffset? JoinedAt { get; }
         /// <summary>
+        ///     Gets the displayed name for this user.
+        /// </summary>
+        /// <returns>
+        ///     A string representing the display name of the user; If the nickname is null, this will be the username.
+        /// </returns>
+        string DisplayName { get; }
+        /// <summary>
         ///     Gets the nickname for this user.
         /// </summary>
         /// <returns>

diff --git a/src/Discord.Net.Rest/Entities/Users/RestGuildUser.cs b/src/Discord.Net.Rest/Entities/Users/RestGuildUser.cs
@@ -19,7 +19,8 @@ public class RestGuildUser : RestUser, IGuildUser
         private long? _timedOutTicks;
         private long? _joinedAtTicks;
         private ImmutableArray<ulong> _roleIds;
-
+        /// <inheritdoc />
+        public string DisplayName => Nickname ?? Username;
         /// <inheritdoc />
         public string Nickname { get; private set; }
         /// <inheritdoc/>

diff --git a/src/Discord.Net.Rest/Entities/Users/RestWebhookUser.cs b/src/Discord.Net.Rest/Entities/Users/RestWebhookUser.cs
@@ -52,6 +52,8 @@ IGuild IGuildUser.Guild
         /// <inheritdoc />
         DateTimeOffset? IGuildUser.JoinedAt => null;
         /// <inheritdoc />
+        string IGuildUser.DisplayName => null;
+        /// <inheritdoc />
         string IGuildUser.Nickname => null;
         /// <inheritdoc />
         string IGuildUser.GuildAvatarId => null;

diff --git a/src/Discord.Net.WebSocket/Entities/Users/SocketGuildUser.cs b/src/Discord.Net.WebSocket/Entities/Users/SocketGuildUser.cs
@@ -30,6 +30,8 @@ public class SocketGuildUser : SocketUser, IGuildUser
         /// </summary>
         public SocketGuild Guild { get; }
         /// <inheritdoc />
+        public string DisplayName => Nickname ?? Username;
+        /// <inheritdoc />
         public string Nickname { get; private set; }
         /// <inheritdoc/>
         public string GuildAvatarId { get; private set; }

diff --git a/src/Discord.Net.WebSocket/Entities/Users/SocketThreadUser.cs b/src/Discord.Net.WebSocket/Entities/Users/SocketThreadUser.cs
@@ -29,6 +29,10 @@ public class SocketThreadUser : SocketUser, IThreadUser, IGuildUser
         public DateTimeOffset? JoinedAt
             => GuildUser.JoinedAt;
 
+        /// <inheritdoc/>
+        public string DisplayName
+            => GuildUser.Nickname ?? GuildUser.Username;
+
         /// <inheritdoc/>
         public string Nickname
             => GuildUser.Nickname;

diff --git a/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs b/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs
@@ -63,6 +63,8 @@ internal static SocketWebhookUser Create(SocketGuild guild, ClientState state, M
         /// <inheritdoc />
         DateTimeOffset? IGuildUser.JoinedAt => null;
         /// <inheritdoc />
+        string IGuildUser.DisplayName => null;
+        /// <inheritdoc />
         string IGuildUser.Nickname => null;
         /// <inheritdoc />
         string IGuildUser.GuildAvatarId => null;