[Feature] User primary guild (#3156)

src/Discord.Net.Core/CDN.cs

@@ -285,5 +285,14 @@ namespace Discord
         /// </returns>
         public static string GetAvatarDecorationUrl(string avatarDecorationHash)
             => $"{DiscordConfig.CDNUrl}avatar-decoration-presets/{avatarDecorationHash}.png";
+
+        /// <summary>
+        ///     Gets a guild tag badge url based off the hash.
+        /// </summary>
+        /// <returns>
+        ///     A URL to the guild tag badge.
+        /// </returns>
+        public static string GetGuildTagBadgeUrl(ulong guildId, string badgeHash)
+            => $"{DiscordConfig.CDNUrl} guild-tag-badges/{guildId}/{badgeHash}.png";
     }
 }

src/Discord.Net.Core/Entities/Users/IUser.cs

@@ -122,6 +122,11 @@ namespace Discord
         /// </remarks>
         ulong? AvatarDecorationSkuId { get; }
 
+        /// <summary>
+        ///     Gets the user's primary guild. <see langword="null" /> if one is not set.
+        /// </summary>
+        PrimaryGuild? PrimaryGuild { get; }
+
         /// <summary>
         ///     Creates the direct message channel of this user.
         /// </summary>

src/Discord.Net.Core/Entities/Users/PrimaryGuild.cs

@@ -0,0 +1,46 @@
+namespace Discord;
+
+/// <summary>
+///     Represents a primary guild object.
+/// </summary>
+public readonly struct PrimaryGuild
+{
+    /// <summary>
+    ///     Gets the id of the user's primary guild.
+    /// </summary>
+    public ulong? GuildId { get; }
+
+    /// <summary>
+    ///     Gets whether the user is displaying the primary guild's server tag.
+    /// </summary>
+    /// <remarks>
+    ///     This property will be <see langword="null"/> if the system clears the identity, e.g. because the server no longer supports tags.
+    /// </remarks>
+    public bool? IdentityEnabled { get; }
+
+    /// <summary>
+    ///     Gets the text of the user's server tag.
+    /// </summary>
+    public string Tag { get; }
+
+    /// <summary>
+    ///     Gets the hash of the guild tag badge.
+    /// </summary>
+    public string BadgeHash { get; }
+
+    internal PrimaryGuild(ulong? guildId, bool? identityEnabled, string tag, string badgeHash)
+    {
+        GuildId = guildId;
+        IdentityEnabled = identityEnabled;
+        Tag = tag;
+        BadgeHash = badgeHash;
+    }
+
+    /// <summary>
+    ///     Gets the url for the tag badge.
+    /// </summary>
+    public string GetBadgeUrl()
+        => (GuildId is null || BadgeHash is null)
+            ? null
+            : CDN.GetGuildTagBadgeUrl(GuildId.Value, BadgeHash);
+}

src/Discord.Net.Rest/API/Common/PrimaryGuild.cs

@@ -0,0 +1,18 @@
+using Newtonsoft.Json;
+
+namespace Discord.API;
+
+internal class PrimaryGuild
+{
+    [JsonProperty("identity_guild_id")]
+    public ulong? GuildId { get; set; }
+
+    [JsonProperty("identity_enabled")]
+    public bool? IdentityEnabled { get; set; }
+
+    [JsonProperty("tag")]
+    public string Tag { get; set; }
+
+    [JsonProperty("badge")]
+    public string BadgeHash { get; set; }
+}

src/Discord.Net.Rest/API/Common/User.cs

@@ -27,6 +27,9 @@ namespace Discord.API
         [JsonProperty("avatar_decoration_data")]
         public Optional<AvatarDecorationData> AvatarDecoration { get; set; }
 
+        [JsonProperty("primary_guild")]
+        public Optional<PrimaryGuild> PrimaryGuild { get; set; }
+
         //CurrentUser
         [JsonProperty("verified")]
         public Optional<bool> Verified { get; set; }

src/Discord.Net.Rest/Entities/Users/RestUser.cs

@@ -72,6 +72,8 @@ namespace Discord.Rest
         /// <inheritdoc />
         public ulong? AvatarDecorationSkuId { get; private set; }
 
+        /// <inheritdoc />
+        public PrimaryGuild? PrimaryGuild { get; private set; }
 
         internal RestUser(BaseDiscordClient discord, ulong id)
             : base(discord, id)
@@ -126,6 +128,18 @@ namespace Discord.Rest
                 AvatarDecorationHash = model.AvatarDecoration.Value?.Asset;
                 AvatarDecorationSkuId = model.AvatarDecoration.Value?.SkuId;
             }
+
+            if (model.PrimaryGuild.IsSpecified)
+            {
+                if (model.PrimaryGuild.Value is null)
+                    PrimaryGuild = null;
+                else
+                    PrimaryGuild = new(
+                        model.PrimaryGuild.Value.GuildId,
+                        model.PrimaryGuild.Value.IdentityEnabled,
+                        model.PrimaryGuild.Value.Tag,
+                        model.PrimaryGuild.Value.BadgeHash);
+            }
         }
 
         /// <inheritdoc />

src/Discord.Net.WebSocket/Entities/Users/SocketUser.cs

@@ -54,6 +54,9 @@ namespace Discord.WebSocket
         /// <inheritdoc />
         public ulong? AvatarDecorationSkuId { get; private set; }
 
+        /// <inheritdoc />
+        public PrimaryGuild? PrimaryGuild { get; private set; }
+
         /// <summary>
         ///     Gets mutual guilds shared with this user.
         /// </summary>
@@ -113,6 +116,32 @@ namespace Discord.WebSocket
                 hasChanges = true;
             }
 
+            if (model.PrimaryGuild.IsSpecified)
+            {
+                if (model.PrimaryGuild.Value is null)
+                {
+                    PrimaryGuild = null;
+                    if (PrimaryGuild is not null)
+                        hasChanges = true;
+                }
+                else
+                {
+                    if (PrimaryGuild?.GuildId != model.PrimaryGuild.Value.GuildId ||
+                        PrimaryGuild?.BadgeHash != model.PrimaryGuild.Value.BadgeHash ||
+                        PrimaryGuild?.Tag != model.PrimaryGuild.Value.Tag||
+                        PrimaryGuild?.IdentityEnabled != model.PrimaryGuild.Value.IdentityEnabled)
+                    {
+                        PrimaryGuild = new(
+                            model.PrimaryGuild.Value.GuildId,
+                            model.PrimaryGuild.Value.IdentityEnabled,
+                            model.PrimaryGuild.Value.Tag,
+                            model.PrimaryGuild.Value.BadgeHash);
+
+                        hasChanges = true;
+                    }
+                }
+            }
+
             return hasChanges;
         }