[Feature] Message Forwards

src/Discord.Net.Core/Entities/Messages/IUserMessage.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Threading.Tasks;
 
 namespace Discord
@@ -29,6 +30,11 @@ public interface IUserMessage : IMessage
         /// </remarks>
         IMessageInteractionMetadata InteractionMetadata { get; }
 
+        /// <summary>
+        ///     Gets a collection of partial messages that were forwarded with this message.
+        /// </summary>
+        IReadOnlyCollection<MessageSnapshot> ForwardedMessages { get; }
+
         /// <summary>
         ///     Modifies this message.
         /// </summary>

src/Discord.Net.Core/Entities/Messages/MessageReference.cs

@@ -33,6 +33,11 @@ public class MessageReference
         /// </summary>
         public Optional<bool> FailIfNotExists { get; internal set; }
 
+        /// <summary>
+        ///     Gets the type of message reference.
+        /// </summary>
+        public Optional<MessageReferenceType> ReferenceType { get; internal set; }
+
         /// <summary>
         ///     Initializes a new instance of the <see cref="MessageReference"/> class.
         /// </summary>
@@ -48,12 +53,14 @@ public class MessageReference
         /// <param name="failIfNotExists">
         ///     Whether to error if the referenced message doesn't exist instead of sending as a normal (non-reply) message. Defaults to true.
         /// </param>
-        public MessageReference(ulong? messageId = null, ulong? channelId = null, ulong? guildId = null, bool? failIfNotExists = null)
+        public MessageReference(ulong? messageId = null, ulong? channelId = null, ulong? guildId = null, bool? failIfNotExists = null,
+            MessageReferenceType referenceType = MessageReferenceType.Default)
         {
             MessageId = messageId ?? Optional.Create<ulong>();
             InternalChannelId = channelId ?? Optional.Create<ulong>();
             GuildId = guildId ?? Optional.Create<ulong>();
             FailIfNotExists = failIfNotExists ?? Optional.Create<bool>();
+            ReferenceType = referenceType;
         }
 
         private string DebuggerDisplay

src/Discord.Net.Core/Entities/Messages/MessageReferenceType.cs

@@ -0,0 +1,17 @@
+namespace Discord;
+
+/// <summary>
+///     Determines how associated data is populated.
+/// </summary>
+public enum MessageReferenceType
+{
+    /// <summary>
+    ///     A standard reference used by replies.
+    /// </summary>
+    Default = 0,
+
+    /// <summary>
+    ///     Reference used to point to a message at a point in time.
+    /// </summary>
+    Forward = 1,
+}

src/Discord.Net.Core/Entities/Messages/MessageSnapshot.cs

@@ -0,0 +1,23 @@
+namespace Discord;
+
+/// <summary>
+///     Represents a snapshot of a message.
+/// </summary>
+public readonly struct MessageSnapshot
+{
+    /// <summary>
+    ///     Gets the partial message that was forwarded.
+    /// </summary>
+    public readonly IMessage Message;
+
+    /// <summary>
+    ///     Gets the id of the originating message's guild
+    /// </summary>
+    public readonly ulong? GuildId;
+
+    internal MessageSnapshot(IMessage message, ulong? guildId)
+    {
+        Message = message;
+        GuildId = guildId;
+    }
+}

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

@@ -101,4 +101,7 @@ internal class Message
 
     [JsonProperty("interaction_metadata")]
     public Optional<MessageInteractionMetadata> InteractionMetadata { get; set; }
+
+    [JsonProperty("message_snapshot")]
+    public Optional<MessageSnapshot[]> MessageSnapshots { get; set; }
 }

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

@@ -4,6 +4,9 @@ namespace Discord.API
 {
     internal class MessageReference
     {
+        [JsonProperty("type")]
+        public Optional<MessageReferenceType> Type { get; set; }
+
         [JsonProperty("message_id")]
         public Optional<ulong> MessageId { get; set; }
 

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

@@ -0,0 +1,12 @@
+using Newtonsoft.Json;
+
+namespace Discord.API;
+
+internal class MessageSnapshot
+{
+    [JsonProperty("message")]
+    public Message Message { get; set; }
+
+    [JsonProperty("guild_id")]
+    public Optional<ulong> GuildId { get; set; }
+}

src/Discord.Net.Rest/Entities/Messages/RestMessage.cs

@@ -158,7 +158,8 @@ internal virtual void Update(Model model)
                     GuildId = model.Reference.Value.GuildId,
                     InternalChannelId = model.Reference.Value.ChannelId,
                     MessageId = model.Reference.Value.MessageId,
-                    FailIfNotExists = model.Reference.Value.FailIfNotExists
+                    FailIfNotExists = model.Reference.Value.FailIfNotExists,
+                    ReferenceType = model.Reference.Value.Type
                 };
             }
 

src/Discord.Net.Rest/Entities/Messages/RestUserMessage.cs

@@ -54,6 +54,9 @@ public class RestUserMessage : RestMessage, IUserMessage
         /// <inheritdoc />
         public MessageResolvedData ResolvedData { get; internal set; }
 
+        /// <inheritdoc />
+        public IReadOnlyCollection<MessageSnapshot> ForwardedMessages { get; internal set; }
+
         internal RestUserMessage(BaseDiscordClient discord, ulong id, IMessageChannel channel, IUser author, MessageSource source)
             : base(discord, id, channel, author, source)
         {
@@ -167,6 +170,15 @@ internal override void Update(Model model)
             }
             if (model.InteractionMetadata.IsSpecified)
                 InteractionMetadata = model.InteractionMetadata.Value.ToInteractionMetadata();
+
+            if (model.MessageSnapshots.IsSpecified)
+            {
+                ForwardedMessages = model.MessageSnapshots.Value.Select(x =>
+                    new MessageSnapshot(RestMessage.Create(Discord, null, null, x.Message),
+                        x.GuildId.IsSpecified ? x.GuildId.Value : null)).ToImmutableArray();
+            }
+            else
+                ForwardedMessages = ImmutableArray<MessageSnapshot>.Empty;
         }
 
         /// <inheritdoc />

src/Discord.Net.WebSocket/Entities/Messages/SocketMessage.cs

@@ -192,7 +192,8 @@ internal virtual void Update(ClientState state, Model model)
                     GuildId = model.Reference.Value.GuildId,
                     InternalChannelId = model.Reference.Value.ChannelId,
                     MessageId = model.Reference.Value.MessageId,
-                    FailIfNotExists = model.Reference.Value.FailIfNotExists
+                    FailIfNotExists = model.Reference.Value.FailIfNotExists,
+                    ReferenceType = model.Reference.Value.Type
                 };
             }
 

src/Discord.Net.WebSocket/Entities/Messages/SocketUserMessage.cs

@@ -55,6 +55,9 @@ public class SocketUserMessage : SocketMessage, IUserMessage
         /// <inheritdoc />
         public MessageResolvedData ResolvedData { get; internal set; }
 
+        /// <inheritdoc />
+        public IReadOnlyCollection<MessageSnapshot> ForwardedMessages { get; internal set; }
+
         internal SocketUserMessage(DiscordSocketClient discord, ulong id, ISocketMessageChannel channel, SocketUser author, MessageSource source)
             : base(discord, id, channel, author, source)
         {
@@ -209,6 +212,16 @@ internal override void Update(ClientState state, Model model)
 
             if (model.InteractionMetadata.IsSpecified)
                 InteractionMetadata = model.InteractionMetadata.Value.ToInteractionMetadata();
+
+
+            if (model.MessageSnapshots.IsSpecified)
+            {
+                ForwardedMessages = model.MessageSnapshots.Value.Select(x =>
+                    new MessageSnapshot(RestMessage.Create(Discord, null, null, x.Message),
+                        x.GuildId.IsSpecified ? x.GuildId.Value : null)).ToImmutableArray();
+            }
+            else
+                ForwardedMessages = ImmutableArray<MessageSnapshot>.Empty;
         }
 
         /// <inheritdoc />