René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Redesigning Interactivity","articleBody":"# Summary\nPer [\"As some of y'all may know, Interactivity has had multiple bugs over the years, most of them being a result from the design. Since we haven't really maintained it recently - or even added more features to it - should we completely rewrite it from scratch?\"](https://discord.com/channels/379378609942560770/379386730538860554/1220790222736982026), there were 135 votes to merge Interactivity with the new Commands extension, 32 votes to keep Interactivity separate and rewrite it from scratch and 6 votes to just keep the current implementation and fix the bugs.\n\n![A screenshot of the above mentioned poll with reactions/votes shown below the message.](https://github.com/user-attachments/assets/e6dcdeea-14ae-4a58-9898-b3022d4678af)\n\n\nWe've decided to do the following solution, quoted directly from @akiraveliara:\n\u003e if i had to design this for v6, i would make an Interactivity.Stateful and an Interactivity.Stateless internal package (PrivateAssets=\"all\")\nand have Commands include and frontend the first one\nhave Interactivity proper include and frontend both of them\ni do respect that interactivity integrated into and understanding commands is really good UX\nespecially if it can automatically decide the \"right thing\" for different contexts\n(though, that stuff will need some work to work with custom contexts)\n\nI will be working on the `DSharpPlus.Interactivity.Stateful` package, which will directly interface with `DSharpPlus.Commands`. Here is the following API:\n\n```cs\npublic async ValueTask PromptAsync(CommandContext context, string question, Func\u003cPromptData, ValueTask\u003e callback);\npublic async ValueTask ChooseAsync(CommandContext context, string question, IReadOnlyList\u003cstring\u003e answers, Func\u003cChooseData, ValueTask\u003e callback);\npublic async ValueTask ConfirmAsync(CommandContext context, string question, Func\u003cConfirmData ValueTask\u003e callback);\npublic async ValueTask PaginateAsync(CommandContext context, IEnumerable\u003cDiscordMessageBuilder\u003e pages, PaginationControls? controls = null);\n```\n\n\u003e [!Note]\n\u003e ALL methods above are non-blocking.\n\n# `PromptAsync`\nThis method will utilize each processor's available feature set to nicely present the question to the user:\n- Interaction-based contexts will use modals\n- Text command-based contexts will use modals via a button\n\nPrompts can timeout and it will be the callback's responsibility to check for that by reading the `PromptData.IsTimedOut` property.\n\n# `ChooseAsync`\nThe user will be presented with multiple choices through a select component and will return a single (or optionally multiple) responses within the callback data. This method has the same API timeout behavior as the `PromptAsync` method.\n\n# `ConfirmAsync`\nThis method will ask the user to confirm their decision, which will be returned via a `bool` property within the callback data. This method has the same API timeout behavior as the `PromptAsync` method.\n\n# `PaginateAsync`\n`PaginateAsync` is nearly identical to the existing pagination API that you're already familiar from the `DSharpPlus.Interactivity` extension. The `PaginationControls? controls = null` parameter will act as an override for the default `PaginationControls` defined within the interactivity/commands (tbd) configuration. The `PaginationControls` contains the control buttons (previous page, stop, next page, etc) for the user, which will attempt to be **appended** onto the message builder and will throw when it fails. `PaginationControls` will also contain a property (likely flags enum or delegate) that defines what to do when a non-author of a pagination clicks on the control buttons. The default implementations available are:\n- Act as the author\n- Copy and respond (non)ephemerally\n- Error ephemerally\n- Ignore\n\n# Notes\nIf there are any other API methods that you would like to see on `CommandContext` specifically, please comment down below.","author":{"url":"https://github.com/OoLunar","@type":"Person","name":"OoLunar"},"datePublished":"2024-11-03T20:53:37.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/2153/DSharpPlus/issues/2153"}