Update interaction summaries (#2099)

quinchs · lhjt · web-flow · commit 503d32aa7e35 · 2022-02-12T06:51:14.000-04:00
* init

* Update RestMessageComponentData.cs

* Update src/Discord.Net.Rest/Entities/Interactions/RestApplicationCommandOption.cs

Co-authored-by: Jared L &lt;48422312+lhjt@users.noreply.github.com&gt;

* Update src/Discord.Net.Rest/Entities/Interactions/RestApplicationCommandOption.cs

Co-authored-by: Jared L &lt;48422312+lhjt@users.noreply.github.com&gt;

* Update src/Discord.Net.WebSocket/Entities/Interaction/SocketBaseCommand/SocketApplicationCommand.cs

Co-authored-by: Jared L &lt;48422312+lhjt@users.noreply.github.com&gt;

* Update src/Discord.Net.WebSocket/Entities/Interaction/SocketBaseCommand/SocketApplicationCommand.cs

Co-authored-by: Jared L &lt;48422312+lhjt@users.noreply.github.com&gt;

Co-authored-by: Jared L &lt;48422312+lhjt@users.noreply.github.com&gt;
diff --git a/src/Discord.Net.Core/Entities/Interactions/IDiscordInteraction.cs b/src/Discord.Net.Core/Entities/Interactions/IDiscordInteraction.cs
@@ -50,12 +50,12 @@ public interface IDiscordInteraction : ISnowflakeEntity
         IUser User { get; }
 
         /// <summary>
-        ///     The preferred locale of the invoking User.
+        ///     Gets the preferred locale of the invoking User.
         /// </summary>
         string UserLocale { get; }
 
         /// <summary>
-        ///     The preferred locale of the guild this interaction was executed in. <see cref="null"/> if not executed in a guild.
+        ///     Gets the preferred locale of the guild this interaction was executed in. <see cref="null"/> if not executed in a guild.
         /// </summary>
         /// <remarks>
         ///     Non-community guilds (With no locale setting available) will have en-US as the default value sent by Discord.
diff --git a/src/Discord.Net.Rest/Entities/Interactions/CommandBase/RestCommandBase.cs b/src/Discord.Net.Rest/Entities/Interactions/CommandBase/RestCommandBase.cs
@@ -28,7 +28,7 @@ public ulong CommandId
             => Data.Id;
 
         /// <summary>
-        ///     The data associated with this interaction.
+        ///     Gets the data associated with this interaction.
         /// </summary>
         internal new RestCommandBaseData Data { get; private set; }
 
diff --git a/src/Discord.Net.Rest/Entities/Interactions/ContextMenuCommands/MessageCommands/RestMessageCommand.cs b/src/Discord.Net.Rest/Entities/Interactions/ContextMenuCommands/MessageCommands/RestMessageCommand.cs
@@ -10,7 +10,7 @@ namespace Discord.Rest
     public class RestMessageCommand : RestCommandBase, IMessageCommandInteraction, IDiscordInteraction
     {
         /// <summary>
-        ///     The data associated with this interaction.
+        ///     Gets the data associated with this interaction.
         /// </summary>
         public new RestMessageCommandData Data { get; private set; }
 
diff --git a/src/Discord.Net.Rest/Entities/Interactions/ContextMenuCommands/MessageCommands/RestMessageCommandData.cs b/src/Discord.Net.Rest/Entities/Interactions/ContextMenuCommands/MessageCommands/RestMessageCommandData.cs
@@ -20,7 +20,7 @@ public RestMessage Message
 
         /// <inheritdoc/>
         /// <remarks>
-        ///     <b>Note</b> Not implemented for <see cref="SocketMessageCommandData"/>
+        ///     <b>Note</b> Not implemented for <see cref="RestMessageCommandData"/>
         /// </remarks>
         public override IReadOnlyCollection<IApplicationCommandInteractionDataOption> Options
             => throw new System.NotImplementedException();
diff --git a/src/Discord.Net.Rest/Entities/Interactions/ContextMenuCommands/UserCommands/RestUserCommandData.cs b/src/Discord.Net.Rest/Entities/Interactions/ContextMenuCommands/UserCommands/RestUserCommandData.cs
@@ -18,7 +18,7 @@ public RestUser Member
 
         /// <inheritdoc/>
         /// <remarks>
-        ///     <b>Note</b> Not implemented for <see cref="SocketUserCommandData"/>
+        ///     <b>Note</b> Not implemented for <see cref="RestUserCommandData"/>
         /// </remarks>
         public override IReadOnlyCollection<IApplicationCommandInteractionDataOption> Options
             => throw new System.NotImplementedException();
diff --git a/src/Discord.Net.Rest/Entities/Interactions/MessageComponents/RestMessageComponentData.cs b/src/Discord.Net.Rest/Entities/Interactions/MessageComponents/RestMessageComponentData.cs
@@ -12,19 +12,13 @@ namespace Discord.Rest
     /// </summary>
     public class RestMessageComponentData : IComponentInteractionData, IDiscordInteractionData
     {
-        /// <summary>
-        ///     Gets the components Custom Id that was clicked.
-        /// </summary>
+        /// <inheritdoc/>
         public string CustomId { get; }
 
-        /// <summary>
-        ///     Gets the type of the component clicked.
-        /// </summary>
+        /// <inheritdoc/>
         public ComponentType Type { get; }
 
-        /// <summary>
-        ///     Gets the value(s) of a <see cref="SelectMenuComponent"/> interaction response.
-        /// </summary>
+        /// <inheritdoc/>
         public IReadOnlyCollection<string> Values { get; }
 
         /// <inheritdoc/>
diff --git a/src/Discord.Net.Rest/Entities/Interactions/RestApplicationCommand.cs b/src/Discord.Net.Rest/Entities/Interactions/RestApplicationCommand.cs
@@ -28,7 +28,7 @@ public abstract class RestApplicationCommand : RestEntity<ulong>, IApplicationCo
         public bool IsDefaultPermission { get; private set; }
 
         /// <summary>
-        ///     The options of this command.
+        ///     Gets a collection of options for this command.
         /// </summary>
         public IReadOnlyCollection<RestApplicationCommandOption> Options { get; private set; }
 
diff --git a/src/Discord.Net.Rest/Entities/Interactions/RestApplicationCommandOption.cs b/src/Discord.Net.Rest/Entities/Interactions/RestApplicationCommandOption.cs
@@ -36,18 +36,16 @@ public class RestApplicationCommandOption : IApplicationCommandOption
         public double? MaxValue { get; private set; }
 
         /// <summary>
-        ///     A collection of <see cref="RestApplicationCommandChoice"/>'s for this command.
+        ///     Gets a collection of <see cref="RestApplicationCommandChoice"/>s for this command.
         /// </summary>
         public IReadOnlyCollection<RestApplicationCommandChoice> Choices { get; private set; }
 
         /// <summary>
-        ///     A collection of <see cref="RestApplicationCommandOption"/>'s for this command.
+        ///     Gets a collection of <see cref="RestApplicationCommandOption"/>s for this command.
         /// </summary>
         public IReadOnlyCollection<RestApplicationCommandOption> Options { get; private set; }
 
-        /// <summary>
-        ///     The allowed channel types for this option.
-        /// </summary>
+        /// <inheritdoc/>
         public IReadOnlyCollection<ChannelType> ChannelTypes { get; private set; }
 
         internal RestApplicationCommandOption() { }
diff --git a/src/Discord.Net.Rest/Entities/Interactions/RestGuildCommand.cs b/src/Discord.Net.Rest/Entities/Interactions/RestGuildCommand.cs
@@ -10,7 +10,7 @@ namespace Discord.Rest
     public class RestGuildCommand : RestApplicationCommand
     {
         /// <summary>
-        ///     The guild Id where this command originates.
+        ///     Gets the guild Id where this command originates.
         /// </summary>
         public ulong GuildId { get; private set; }
 
diff --git a/src/Discord.Net.Rest/Entities/Interactions/RestInteraction.cs b/src/Discord.Net.Rest/Entities/Interactions/RestInteraction.cs
@@ -43,7 +43,7 @@ public abstract class RestInteraction : RestEntity<ulong>, IDiscordInteraction
         public DateTimeOffset CreatedAt { get; private set; }
 
         /// <summary>
-        ///     <see langword="true"/> if the token is valid for replying to, otherwise <see langword="false"/>.
+        ///     Gets whether or not the token used to respond to this interaction is valid.
         /// </summary>
         public bool IsValidToken
             => InteractionHelper.CanRespondOrFollowup(this);
diff --git a/src/Discord.Net.Rest/Entities/Interactions/SlashCommands/RestAutocompleteInteractionData.cs b/src/Discord.Net.Rest/Entities/Interactions/SlashCommands/RestAutocompleteInteractionData.cs
@@ -13,34 +13,22 @@ namespace Discord.Rest
     /// </summary>
     public class RestAutocompleteInteractionData : IAutocompleteInteractionData
     {
-        /// <summary>
-        ///     Gets the name of the invoked command.
-        /// </summary>
+        /// <inheritdoc/>
         public string CommandName { get; }
 
-        /// <summary>
-        ///     Gets the id of the invoked command.
-        /// </summary>
+        /// <inheritdoc/>
         public ulong CommandId { get; }
 
-        /// <summary>
-        ///     Gets the type of the invoked command.
-        /// </summary>
+        /// <inheritdoc/>
         public ApplicationCommandType Type { get; }
 
-        /// <summary>
-        ///     Gets the version of the invoked command.
-        /// </summary>
+        /// <inheritdoc/>
         public ulong Version { get; }
 
-        /// <summary>
-        ///     Gets the current autocomplete option that is actively being filled out.
-        /// </summary>
+        /// <inheritdoc/>
         public AutocompleteOption Current { get; }
 
-        /// <summary>
-        ///     Gets a collection of all the other options the executing users has filled out.
-        /// </summary>
+        /// <inheritdoc/>
         public IReadOnlyCollection<AutocompleteOption> Options { get; }
 
         internal RestAutocompleteInteractionData(DataModel model)
diff --git a/src/Discord.Net.WebSocket/Entities/Interaction/ContextMenuCommands/MessageCommands/SocketMessageCommand.cs b/src/Discord.Net.WebSocket/Entities/Interaction/ContextMenuCommands/MessageCommands/SocketMessageCommand.cs
@@ -9,7 +9,7 @@ namespace Discord.WebSocket
     public class SocketMessageCommand : SocketCommandBase, IMessageCommandInteraction, IDiscordInteraction
     {
         /// <summary>
-        ///     The data associated with this interaction.
+        ///     Gets the data associated with this interaction.
         /// </summary>
         public new SocketMessageCommandData Data { get; }
 
diff --git a/src/Discord.Net.WebSocket/Entities/Interaction/Modals/SocketModal.cs b/src/Discord.Net.WebSocket/Entities/Interaction/Modals/SocketModal.cs
@@ -17,9 +17,8 @@ namespace Discord.WebSocket
     public class SocketModal : SocketInteraction, IDiscordInteraction, IModalInteraction
     {
         /// <summary>
-        ///     The data for this <see cref="Modal"/> interaction.
+        ///     Gets the data for this <see cref="Modal"/> interaction.
         /// </summary>
-        /// <value></value>
         public new SocketModalData Data { get; set; }
 
         internal SocketModal(DiscordSocketClient client, ModelBase model, ISocketMessageChannel channel, SocketUser user)
diff --git a/src/Discord.Net.WebSocket/Entities/Interaction/SlashCommands/SocketAutocompleteInteraction.cs b/src/Discord.Net.WebSocket/Entities/Interaction/SlashCommands/SocketAutocompleteInteraction.cs
@@ -14,11 +14,13 @@ namespace Discord.WebSocket
     public class SocketAutocompleteInteraction : SocketInteraction, IAutocompleteInteraction, IDiscordInteraction
     {
         /// <summary>
-        ///     The autocomplete data of this interaction.
+        ///     Gets the autocomplete data of this interaction.
         /// </summary>
         public new SocketAutocompleteInteractionData Data { get; }
 
+        /// <inheritdoc/>
         public override bool HasResponded { get; internal set; }
+
         private object _lock = new object();
 
         internal SocketAutocompleteInteraction(DiscordSocketClient client, Model model, ISocketMessageChannel channel, SocketUser user)
diff --git a/src/Discord.Net.WebSocket/Entities/Interaction/SlashCommands/SocketAutocompleteInteractionData.cs b/src/Discord.Net.WebSocket/Entities/Interaction/SlashCommands/SocketAutocompleteInteractionData.cs
@@ -10,34 +10,22 @@ namespace Discord.WebSocket
     /// </summary>
     public class SocketAutocompleteInteractionData : IAutocompleteInteractionData, IDiscordInteractionData
     {
-        /// <summary>
-        ///     Gets the name of the invoked command.
-        /// </summary>
+        /// <inheritdoc/>
         public string CommandName { get; }
 
-        /// <summary>
-        ///     Gets the id of the invoked command.
-        /// </summary>
+        /// <inheritdoc/>
         public ulong CommandId { get; }
 
-        /// <summary>
-        ///     Gets the type of the invoked command.
-        /// </summary>
+        /// <inheritdoc/>
         public ApplicationCommandType Type { get; }
 
-        /// <summary>
-        ///     Gets the version of the invoked command.
-        /// </summary>
+        /// <inheritdoc/>
         public ulong Version { get; }
 
-        /// <summary>
-        ///     Gets the current autocomplete option that is actively being filled out.
-        /// </summary>
+        /// <inheritdoc/>
         public AutocompleteOption Current { get; }
 
-        /// <summary>
-        ///     Gets a collection of all the other options the executing users has filled out.
-        /// </summary>
+        /// <inheritdoc/>
         public IReadOnlyCollection<AutocompleteOption> Options { get; }
 
         internal SocketAutocompleteInteractionData(DataModel model)
diff --git a/src/Discord.Net.WebSocket/Entities/Interaction/SlashCommands/SocketSlashCommand.cs b/src/Discord.Net.WebSocket/Entities/Interaction/SlashCommands/SocketSlashCommand.cs
@@ -9,7 +9,7 @@ namespace Discord.WebSocket
     public class SocketSlashCommand : SocketCommandBase, ISlashCommandInteraction, IDiscordInteraction
     {
         /// <summary>
-        ///     The data associated with this interaction.
+        ///     Gets the data associated with this interaction.
         /// </summary>
         public new SocketSlashCommandData Data { get; }
 
diff --git a/src/Discord.Net.WebSocket/Entities/Interaction/SlashCommands/SocketSlashCommandDataOption.cs b/src/Discord.Net.WebSocket/Entities/Interaction/SlashCommands/SocketSlashCommandDataOption.cs
@@ -21,7 +21,7 @@ public class SocketSlashCommandDataOption : IApplicationCommandInteractionDataOp
         public ApplicationCommandOptionType Type { get; private set; }
 
         /// <summary>
-        ///      The sub command options received for this sub command group.
+        ///      Gets the sub command options received for this sub command group.
         /// </summary>
         public IReadOnlyCollection<SocketSlashCommandDataOption> Options { get; private set; }
 
diff --git a/src/Discord.Net.WebSocket/Entities/Interaction/SocketBaseCommand/SocketApplicationCommand.cs b/src/Discord.Net.WebSocket/Entities/Interaction/SocketBaseCommand/SocketApplicationCommand.cs
@@ -16,7 +16,7 @@ public class SocketApplicationCommand : SocketEntity<ulong>, IApplicationCommand
     {
         #region SocketApplicationCommand
         /// <summary>
-        ///    <see langword="true"/> if this command is a global command, otherwise <see langword="false"/>.
+        ///    Gets whether or not this command is a global application command.
         /// </summary>
         public bool IsGlobalCommand
             => Guild == null;
@@ -37,7 +37,7 @@ public bool IsGlobalCommand
         public bool IsDefaultPermission { get; private set; }
 
         /// <summary>
-        ///     A collection of <see cref="SocketApplicationCommandOption"/>'s for this command.
+        ///     Gets a collection of <see cref="SocketApplicationCommandOption"/>s for this command.
         /// </summary>
         /// <remarks>
         ///     If the <see cref="Type"/> is not a slash command, this field will be an empty collection.
@@ -49,7 +49,7 @@ public DateTimeOffset CreatedAt
             => SnowflakeUtils.FromSnowflake(Id);
 
         /// <summary>
-        ///     Returns the guild this command resides in, if this command is a global command then it will return <see langword="null"/>
+        ///     Gets the guild this command resides in; if this command is a global command then it will return <see langword="null"/>
         /// </summary>
         public SocketGuild Guild
             => GuildId.HasValue ? Discord.GetGuild(GuildId.Value) : null;
diff --git a/src/Discord.Net.WebSocket/Entities/Interaction/SocketBaseCommand/SocketApplicationCommandOption.cs b/src/Discord.Net.WebSocket/Entities/Interaction/SocketBaseCommand/SocketApplicationCommandOption.cs
@@ -34,17 +34,17 @@ public class SocketApplicationCommandOption : IApplicationCommandOption
         public double? MaxValue { get; private set; }
 
         /// <summary>
-        ///     Choices for string and int types for the user to pick from.
+        ///     Gets a collection of choices for the user to pick from.
         /// </summary>
         public IReadOnlyCollection<SocketApplicationCommandChoice> Choices { get; private set; }
 
         /// <summary>
-        ///     If the option is a subcommand or subcommand group type, this nested options will be the parameters.
+        ///     Gets a collection of nested options.
         /// </summary>
         public IReadOnlyCollection<SocketApplicationCommandOption> Options { get; private set; }
 
         /// <summary>
-        ///     The allowed channel types for this option.
+        ///     Gets the allowed channel types for this option.
         /// </summary>
         public IReadOnlyCollection<ChannelType> ChannelTypes { get; private set; }
 
diff --git a/src/Discord.Net.WebSocket/Entities/Interaction/SocketBaseCommand/SocketCommandBase.cs b/src/Discord.Net.WebSocket/Entities/Interaction/SocketBaseCommand/SocketCommandBase.cs
@@ -27,10 +27,11 @@ public ulong CommandId
             => Data.Id;
 
         /// <summary>
-        ///     The data associated with this interaction.
+        ///     Gets the data associated with this interaction.
         /// </summary>
         internal new SocketCommandBaseData Data { get; }
 
+        /// <inheritdoc/>
         public override bool HasResponded { get; internal set; }
 
         private object _lock = new object();
diff --git a/src/Discord.Net.WebSocket/Entities/Interaction/SocketBaseCommand/SocketCommandBaseData.cs b/src/Discord.Net.WebSocket/Entities/Interaction/SocketBaseCommand/SocketCommandBaseData.cs
@@ -12,19 +12,15 @@ public class SocketCommandBaseData<TOption> : SocketEntity<ulong>, IApplicationC
         public string Name { get; private set; }
 
         /// <summary>
-        ///     The <typeparamref name="TOption"/> received with this interaction.
+        ///     Gets the <typeparamref name="TOption"/> received with this interaction.
         /// </summary>
         public virtual IReadOnlyCollection<TOption> Options { get; internal set; }
 
         internal readonly SocketResolvableData<Model> ResolvableData;
 
-        private ApplicationCommandType Type { get; set; }
-
         internal SocketCommandBaseData(DiscordSocketClient client, Model model, ulong? guildId)
             : base(client, model.Id)
         {
-            Type = model.Type;
-
             if (model.Resolved.IsSpecified)
             {
                 ResolvableData = new SocketResolvableData<Model>(client, guildId, model);
diff --git a/src/Discord.Net.WebSocket/Entities/Interaction/SocketInteraction.cs b/src/Discord.Net.WebSocket/Entities/Interaction/SocketInteraction.cs

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ namespace Discord.Rest`
`10`	`10`	`public class RestMessageCommand : RestCommandBase, IMessageCommandInteraction, IDiscordInteraction`
`11`	`11`	`{`
`12`	`12`	`/// <summary>`
`13`		`- /// The data associated with this interaction.`
	`13`	`+ /// Gets the data associated with this interaction.`
`14`	`14`	`/// </summary>`
`15`	`15`	`public new RestMessageCommandData Data { get; private set; }`
`16`	`16`