Split up interaction metadata types.

See discord/discord-api-docs#71781.

Author: Nihlus

Backend/Remora.Discord.API.Abstractions/API/Objects/Interactions/IApplicationCommandInteractionMetadata.cs

@@ -0,0 +1,46 @@
+//
+//  IApplicationCommandInteractionMetadata.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using JetBrains.Annotations;
+using Remora.Rest.Core;
+
+namespace Remora.Discord.API.Abstractions.Objects;
+
+/// <summary>
+/// Represents the metadata of an application command interaction.
+/// </summary>
+[PublicAPI]
+public interface IApplicationCommandInteractionMetadata : IMessageInteractionMetadata
+{
+    /// <inheritdoc/>
+    InteractionType IMessageInteractionMetadata.Type => InteractionType.ApplicationCommand;
+
+    /// <summary>
+    /// Gets the user the command was run on.
+    /// </summary>
+    Optional<IUser> TargetUser { get; }
+
+    /// <summary>
+    /// Gets the ID of the message the command was run on.
+    /// </summary>
+    Optional<Snowflake> TargetMessageID { get; }
+}

Backend/Remora.Discord.API.Abstractions/API/Objects/Interactions/IMessageComponentInteractionMetadata.cs

@@ -0,0 +1,41 @@
+//
+//  IMessageComponentInteractionMetadata.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using JetBrains.Annotations;
+using Remora.Rest.Core;
+
+namespace Remora.Discord.API.Abstractions.Objects;
+
+/// <summary>
+/// Represents the metadata of a message component interaction.
+/// </summary>
+[PublicAPI]
+public interface IMessageComponentInteractionMetadata : IMessageInteractionMetadata
+{
+    /// <inheritdoc/>
+    InteractionType IMessageInteractionMetadata.Type => InteractionType.MessageComponent;
+
+    /// <summary>
+    /// Gets the ID of the message containing the interactive component.
+    /// </summary>
+    Optional<Snowflake> InteractedMessageID { get; }
+}

Backend/Remora.Discord.API.Abstractions/API/Objects/Interactions/IMessageInteractionMetadata.cs

@@ -27,7 +27,8 @@
 namespace Remora.Discord.API.Abstractions.Objects;
 
 /// <summary>
-/// Represents the metadata of an application command interaction.
+/// Represents generic information about a message interaction. Cast this to its relevant subtype based on
+/// <see cref="Type"/> to access type-specific fields.
 /// </summary>
 [PublicAPI]
 public interface IMessageInteractionMetadata
@@ -37,25 +38,15 @@ public interface IMessageInteractionMetadata
     /// </summary>
     Snowflake ID { get; }
 
-    /// <summary>
-    /// Gets the ID of the user who triggered the interaction.
-    /// </summary>
-    IUser User { get; }
-
     /// <summary>
     /// Gets the type of the interaction.
     /// </summary>
     InteractionType Type { get; }
 
     /// <summary>
-    /// Gets the ID of the original response message. Only applicable to followup messages.
-    /// </summary>
-    Optional<Snowflake> OriginalResponseMessageID { get; }
-
-    /// <summary>
-    /// Gets the ID of the message containing the interactive component; only applicable to component interactions.
+    /// Gets the ID of the user who triggered the interaction.
     /// </summary>
-    Optional<Snowflake> InteractedMessageID { get; }
+    IUser User { get; }
 
     /// <summary>
     /// Gets the integrations that authorized the interaction.
@@ -72,7 +63,7 @@ public interface IMessageInteractionMetadata
     IReadOnlyDictionary<ApplicationIntegrationType, Snowflake> AuthorizingIntegrationOwners { get; }
 
     /// <summary>
-    /// Gets the interaction metadata responsible, if this is a response to a modal.
+    /// Gets the ID of the original response message. Only applicable to followup messages.
     /// </summary>
-    Optional<IMessageInteractionMetadata> TriggeringInteractionMetadata { get; }
+    Optional<Snowflake> OriginalResponseMessageID { get; }
 }

Backend/Remora.Discord.API.Abstractions/API/Objects/Interactions/IModalSubmitInteractionMetadata.cs

@@ -0,0 +1,41 @@
+//
+//  IModalSubmitInteractionMetadata.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using JetBrains.Annotations;
+using Remora.Rest.Core;
+
+namespace Remora.Discord.API.Abstractions.Objects;
+
+/// <summary>
+/// Represents the metadata of a modal submission interaction.
+/// </summary>
+[PublicAPI]
+public interface IModalSubmitInteractionMetadata : IMessageInteractionMetadata
+{
+    /// <inheritdoc/>
+    InteractionType IMessageInteractionMetadata.Type => InteractionType.ModalSubmit;
+
+    /// <summary>
+    /// Gets the metadata for the interaction that was used to open the modal.
+    /// </summary>
+    Optional<IMessageInteractionMetadata> TriggeringInteractionMetadata { get; }
+}

Backend/Remora.Discord.API.Abstractions/API/Objects/Messages/IMessage.cs

@@ -208,6 +208,11 @@ public interface IMessage : IPartialMessage
     /// </summary>
     new Optional<IPoll> Poll { get; }
 
+    /// <summary>
+    /// Gets the call associated with the message, if any.
+    /// </summary>
+    new Optional<IMessageCall> Call { get; }
+
     /// <inheritdoc/>
     Optional<Snowflake> IPartialMessage.ID => this.ID;
 
@@ -306,4 +311,7 @@ public interface IMessage : IPartialMessage
 
     /// <inheritdoc/>
     Optional<IPoll> IPartialMessage.Poll => this.Poll;
+
+    /// <inheritdoc/>
+    Optional<IMessageCall> IPartialMessage.Call => this.Call;
 }

Backend/Remora.Discord.API.Abstractions/API/Objects/Messages/IMessageCall.cs

@@ -0,0 +1,45 @@
+//
+//  IMessageCall.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using System;
+using System.Collections.Generic;
+using JetBrains.Annotations;
+using Remora.Rest.Core;
+
+namespace Remora.Discord.API.Abstractions.Objects;
+
+/// <summary>
+/// Represents information about a call in a private channel.
+/// </summary>
+[PublicAPI]
+public interface IMessageCall
+{
+    /// <summary>
+    /// Gets the IDs of the participants of the call.
+    /// </summary>
+    IReadOnlyList<Snowflake> Participants { get; }
+
+    /// <summary>
+    /// Gets the time when the call ended.
+    /// </summary>
+    Optional<DateTimeOffset?> EndedTimestamp { get; }
+}

Backend/Remora.Discord.API.Abstractions/API/Objects/Messages/IPartialMessage.cs

@@ -131,4 +131,7 @@ public interface IPartialMessage
 
     /// <inheritdoc cref="IMessage.Poll"/>
     Optional<IPoll> Poll { get; }
+
+    /// <inheritdoc cref="IMessage.Call"/>
+    Optional<IMessageCall> Call { get; }
 }

Backend/Remora.Discord.API.Abstractions/Remora.Discord.API.Abstractions.csproj

@@ -125,6 +125,15 @@
       <Compile Update="API\Rest\IListGuildSoundboardSoundsResponse.cs">
         <DependentUpon>IDiscordRestSoundboardAPI.cs</DependentUpon>
       </Compile>
+      <Compile Update="API\Objects\Interactions\IMessageComponentInteractionMetadata.cs">
+        <DependentUpon>IMessageInteractionMetadata.cs</DependentUpon>
+      </Compile>
+      <Compile Update="API\Objects\Interactions\IModalSubmitInteractionMetadata.cs">
+        <DependentUpon>IMessageInteractionMetadata.cs</DependentUpon>
+      </Compile>
+      <Compile Update="API\Objects\Interactions\IApplicationCommandInteractionMetadata.cs">
+        <DependentUpon>IMessageInteractionMetadata.cs</DependentUpon>
+      </Compile>
     </ItemGroup>
 
 </Project>

Backend/Remora.Discord.API/API/Gateway/Events/Messages/MessageCreate.cs

@@ -67,5 +67,6 @@ public record MessageCreate
     Optional<int> Position = default,
     Optional<IApplicationCommandInteractionDataResolved> Resolved = default,
     Optional<IMessageInteractionMetadata> InteractionMetadata = default,
-    Optional<IPoll> Poll = default
+    Optional<IPoll> Poll = default,
+    Optional<IMessageCall> Call = default
 ) : IMessageCreate;

Backend/Remora.Discord.API/API/Gateway/Events/Messages/MessageUpdate.cs

@@ -67,5 +67,6 @@ public record MessageUpdate
     Optional<int> Position = default,
     Optional<IApplicationCommandInteractionDataResolved> Resolved = default,
     Optional<IMessageInteractionMetadata> InteractionMetadata = default,
-    Optional<IPoll> Poll = default
+    Optional<IPoll> Poll = default,
+    Optional<IMessageCall> Call = default
 ) : IMessageUpdate;