diff --git a/docs/guides/interactions_framework/autocompleters.md b/docs/guides/interactions_framework/autocompleters.md index a90608424..6d5555281 100644 --- a/docs/guides/interactions_framework/autocompleters.md +++ b/docs/guides/interactions_framework/autocompleters.md @@ -1,3 +1,8 @@ +--- +uid: Guides.InteractionsFramework.Autocompleters +title: Autocompleters +--- + # Autocompleters Autocompleters provide a similar pattern to TypeConverters. Autocompleters are cached, singleton services and they are used by the Interaction Service to handle Autocomplete Interations targeted to a specific Slash Command parameter. diff --git a/docs/guides/interactions_framework/dependency_injection.md b/docs/guides/interactions_framework/dependency-injection.md similarity index 93% rename from docs/guides/interactions_framework/dependency_injection.md rename to docs/guides/interactions_framework/dependency-injection.md index d8b5ede41..bed58e1c3 100644 --- a/docs/guides/interactions_framework/dependency_injection.md +++ b/docs/guides/interactions_framework/dependency-injection.md @@ -1,3 +1,8 @@ +--- +uid: Guides.InteractionsFramework.DependencyInjection +title: Dependency Injection +--- + # Dependency Injection Interaction Service uses dependency injection to perform most of its operations. This way, you can access service dependencies throughout the framework. diff --git a/docs/guides/interactions_framework/intro.md b/docs/guides/interactions_framework/intro.md index 1429fe1eb..0e72e4cc3 100644 --- a/docs/guides/interactions_framework/intro.md +++ b/docs/guides/interactions_framework/intro.md @@ -1,3 +1,8 @@ +--- +uid: Guides.InteractionsFramework.Intro +title: Introduction to the Interaction Framework +--- + # Getting Started Interaction Service provides an attribute based framework for creating Discord Interaction handlers. @@ -50,9 +55,10 @@ Valid **Interaction Commands** must comply with the following requirements: |[Component Interaction Command](#component-interaction-commands)| `Task`/`Task` | inf | `string` or `string[]` | `[ComponentInteraction]` | |[Autocomplete Command](#autocomplete-commands)| `Task`/`Task` | - | - | `[AutocompleteCommand]`| -**a `TypeConverter` that is capable of parsing type in question must be registered to the `InteractionService` instance.* +> [!NOTE] +> a `TypeConverter` that is capable of parsing type in question must be registered to the `InteractionService` instance. -> You should avoid using long running code in your command module. Depending on your setup, long running code may block the Gateway thread of your bot, interrupting its connection to Discord. +You should avoid using long running code in your command module. Depending on your setup, long running code may block the Gateway thread of your bot, interrupting its connection to Discord. ### Slash Commands diff --git a/docs/guides/interactions_framework/post_execution.md b/docs/guides/interactions_framework/post_execution.md index b8e7750f1..7a5e34d05 100644 --- a/docs/guides/interactions_framework/post_execution.md +++ b/docs/guides/interactions_framework/post_execution.md @@ -1,3 +1,8 @@ +--- +uid: Guides.InteractionsFramework.PostEx +title: Post-Execution +--- + # Post-Execution Logic Interaction Service uses `IResult`s to provide information about the state of command execution. These can be used to log internal exceptions or provide some insight to the command user. diff --git a/docs/guides/interactions_framework/preconditions.md b/docs/guides/interactions_framework/preconditions.md index c032714e8..e9b5d73b6 100644 --- a/docs/guides/interactions_framework/preconditions.md +++ b/docs/guides/interactions_framework/preconditions.md @@ -1,3 +1,8 @@ +--- +uid: Guides.InteractionsFramework.Preconditions +title: Preconditions +--- + # Preconditions Preconditions in Interaction Service work exactly the same as they do in ***Discord.Net.Commands***. For more information, check out [Preconditions](../commands/preconditions.md) \ No newline at end of file diff --git a/docs/guides/interactions_framework/typeconverters.md b/docs/guides/interactions_framework/typeconverters.md index 382cc7cc0..c06f40386 100644 --- a/docs/guides/interactions_framework/typeconverters.md +++ b/docs/guides/interactions_framework/typeconverters.md @@ -1,3 +1,8 @@ +--- +uid: Guides.InteractionsFramework.TypeConverters +title: Type Converters +--- + # TypeConverters TypeConverters are responsible for registering command parameters to Discord and parsing the user inputs into method parameters. diff --git a/docs/guides/toc.yml b/docs/guides/toc.yml index 6bd2d269a..e8c89dab5 100644 --- a/docs/guides/toc.yml +++ b/docs/guides/toc.yml @@ -46,3 +46,17 @@ topicUid: Guides.MessageComponents.SelectMenus - name: Advanced Concepts topicUid: Guides.MessageComponents.Advanced +- name: Interaction Framework + items: + - name: Getting started + topicUid: Guides.InteractionsFramework.Intro + - name: Dependency Injection + topicUid: Guides.InteractionsFramework.DependencyInjection + - name: Autocompleters + topicUid: Guides.InteractionsFramework.Autocompleters + - name: Preconditions + topicUid: Guides.InteractionsFramework.Preconditions + - name: Type Converters + topicUid: Guides.InteractionsFramework.TypeConverters + - name: Post Execution + topicUid: Guides.InteractionsFramework.PostEx