ff0fea98a6
* Add XML docs
* Clean up style switcher
* Squash commits on branch docs/faq-n-patches
* Fix broken theme selector
* Add local image embed instruction
* Add a bunch of XML docs
* Add a bunch of XML docs
* Fix broken search
+ DocFX by default ships with an older version of jQuery, switching to a newer version confuses parts of the DocFX Javascript.
* Minor fixes for CONTRIBUTING.md and README.md
* Clean up filterConfig.yml
+ New config exposes Discord.Net namespace since it has several common public exceptions that may be helpful to users
* Add XML docs
* Read token from Environment Variable instead of hardcode
* Add XMLDocs
* Compress some assets & add OAuth2 URL generator
* Fix sample link & add missing pictures
* Add tag examples
* Fix embed docs consistency
* Add details regarding userbot support
* Add XML Docs
* Add XML Docs
* Add XML Docs
* Minor fixes in documentations
+ Fix unescaped '<'
+ Fix typo
* Fix seealso for preconditions and add missing descriptions
* Add missing exceptions
* Document exposed TypeReaders
* Fix letter-casing for files
* Add 'last modified' plugin
Source: https://github.com/Still34/DocFx.Plugin.LastModified
Licensed under MIT License
* XML Docs
* Fix minor consistencies & redundant impl
* Add properties examples to overwrite
* Fix missing Username prop
* Add warning for bulk-delete endpoint
* Replace note block
* Add BaseSocketClient docs
* Add XML docs
* Replace langword null to code block null instead
- Because DocFX sucks at rendering langword
* Replace all langword placements with code block
* Add more IGuild docs
* Add details to SpotifyGame
* Initial proofread of the articles
* Add explanation for RunMode
* Add event docs
- MessageReceived
- ChannelUpdated/Destroyed/Created
* Fix light theme link color
* Fix xml docs error
* Add partial documentation for audit log impl
* Add documentation for some REST-based objects
* Add partial documentation for audit log objects
* Add more XML comments to quotation mark alias map stuff, including an example
* Add reference to CommandServiceConfig from the util docs'
* Add explanation that if " is removed then it wont work
* Fix missing service provider in example
* Add documentation for new INestedChannel
* Add documentation
* Add documentation for new API version & few events
* Revise guide paragraphs/samples
+ Fix various formatting.
+ Provide a more detailed walkthrough for dependency injection.
+ Add C# note at intro.
* Fix typos & formatting
* Improve group module example
* Small amount to see if I'm doing it right
* Remove/cleanup redundant variables
* Fix EnterTypingState impl for doc inheritance
* Fix Test to resolve changes made in 15b58e
* Improve precondition documentation
+ Add precondition usage sample
+ Add precondition group usage sample
+ Move precondition samples to its own sample folder
* Move samples to individual folders
* Clarify token source
* Cleanup styling of README.md for docs
* Replace InvalidPathChars for NS1.3
* InvalidPathChars does not exist in NS1.3; replaced with GetInvalidPathChars instead.
* Add a missing change for 2c7cc738
* Update LastModified to v1.1.0 & add license
* Rewrite installation page for Core 2.1
* Fix anchor link
* Bump post-processor to v1.1.1
* Add fixes to partial file & add license
* Moved theme-switcher code to scripts partial file
+ Add author's MIT license to featherlight javascript
* Remove unused bootstrap plugin
* Bump LastModified plugin
* Changed the path from 'lastmodified' to 'last-modified' for consistency
* Cleanup README & Contribution guide
* Changes to last pr
* Fix GetCategoryAsync docs
* Proofread and cleanup articles
* Change passive voice in "Get Started" to active
* Fix improper preposition in Commands Introduction page
* Fix minor grammar mistakes in "Your First Bot" (future tense -> present tense/subjunctive mood -> indicative mood/proper noun casing/incorrect noun/add missing article)
* Fix minor grammar mistakes in "Installation" (missing article)
* no hablo ingles
* Try try try again
* I'm sure you're having as much fun as I am
* Cleanup TOC & fix titles
* Improve styling
+ Change title font to Noto Sans
+ Add materialized design for commit message box
* Add DescriptionGenerator plugin
* Add nightly section for clarification
* Fix typos in Nightlies & Post-execution
* Bump DescriptionGenerator to v1.1.0
+ This build adds the functionality of generating managed references' summary into the description tag.
* Initial emoji article draft
* Add 'additional information' section for emoji article
* Add cosmetic changes to the master css
* Alter info box color
+ Add transition to article content
* Add clarification in the emoji article
* Emphasize that normal emoji string will not translate to its Unicode representation.
* Clean up or add some of the samples featured in the article.
+ Add emoji/emote declaration section for clarification.
+ Add WebSocket emote sample.
- Remove inconsistent styling ('wacky memes' proves to be too out of place).
* Improve readability for nightlies article
* Move 'Bundled Preconditions' section
* Bump LastModified to fix UTC DateTime parsing
* Add langwordMapping.yml
* Add XML docs
* Add VSC workspace rule
* The root workspace limits the ruler to 120 characters for member documentations and excludes folders such as 'samples' and 'docs'.
* The docs workspace limits the ruler to 70 characters for standard conceptual article to comply with documentation's CONTRIBUTING.md rule, and excludes temprorary folders created by DocFX.
* Update CONTRIBUTING.md
* Add documentation style rule
* Fix styling of several member documentation
* Fix ' />' caused by Agent Smith oddities
* Fix styling to be more specific about the mention of IDs
* Fix exception summary to comply with official Microsoft Docs style
* References
https://docs.microsoft.com/en-us/dotnet/api/system.argumentnullexception?view=netframework-4.7.2
https://docs.microsoft.com/en-us/dotnet/api/system.platformnotsupportedexception?view=netframework-4.7.2
https://docs.microsoft.com/en-us/dotnet/api/system.badimageformatexception?view=netframework-4.7.2
* Add XML documentations
* Shift color return docs
* Fix minor docs
* Added documentation for SocketDMChannel, SocketGuildChannel, and SocketTextChannel
* Add XML docs
* Corrections to SocketGuildChannel
* Corrections to SocketTextChannel
* Corrections to SocketDMChannel
* Swapped out 'id' for 'snowflake identifier
* Swapped out 'id' for 'snowflake identifier'
* SocketDMChannel amendments
* SocketGuildChannel amendments
* SocketTextChannel amendments
* Add XML docs & patch return types
+ Starting from this commit, all return types for tasks will use style similar to most documentations featured on docs.microsoft.com
References:
https://docs.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.dbcontext.-ctor?view=efcore-2.1
https://docs.microsoft.com/en-us/dotnet/api/system.io.filestream.readasync?view=netcore-2.1
https://docs.microsoft.com/en-us/dotnet/api/system.io.textwriter.writelineasync?view=netcore-2.1#System_IO_TextWriter_WriteLineAsync_System_Char___
And many more other asynchronous method documentations featured in the latest BCL.
* Added documentation for many audit log data types, fixed vowel indefinite articles
* Change audit log data types to start with 'Contains' (verb) instead of an article
* Fix some documentation issues and document some more audit log data types
* Fix English posession
* Add XML doc
* Documented two more types
* Documented RoleCreateAuditLogData
* Document remaining audit log data types
* Added RestDMChannel documentation
* Added RestGuildChannel documentation
* Added RestTextChannel documentation
* Added RestVoiceChannel documentation
* Added RestUser documentation
* Added RestRole documentation
* Added RestMessage documentation
* Slightly better wording
* Contains -> Contains a piece of (describe article)
* [EN] Present perf. -> past perf.
* Add XML docs
* Fix arrow alignment
* Clarify supported nullable type
* Fixed a typo in ISnowflakeEntity
* Added RestUser Documentation
* Added RestInvite documentation
* Add XML docs & minor optimizations
* Minor optimization for doc rendering
* Rollback font optimization changes
* Amendments to RestUser
* Added SocketDMChannel documentation
* Added RestDMChannel documentation
* Added RestGuild documentation
* Adjustment to SocketDMChannel
* Added minimal descriptions from the API documentation for Integration types
* Added obsolete mention to the ReadMessages flag.
* Added remarks about 2FA requirement for guild permissions
* Added xmldoc for GuildPermission methods
* Added xml doc for ToAllowList and ToDenyList
* Added specification of how the bits of the color raw value are packed
* Added discord API documentation to IConnection interface
* I can spell :^)
* Fix whitespace in ChannelPermission
* fix spacing of values in guildpermission
* Made changes to get field descriptions from feedback, added returns tag to IConnection
* Added property get standard for IntegrationAccount
* Added property get pattern to xml docs and identical returns tag.
* Change all color class references to struct
...because it isn't a class.
* Add XML docs
* Rewrote the returns tags in IGuildIntegration, removed the ones I was unsure about.
* Rewrote the rest of the returns tags
* Amendments
* Cleanup doc for c1d78189
* Added types to <returns> tags where missing
* Added second sample for adding reactions
* Added some class summaries
* Missed a period
* Amendments
* restored the removed line break
* Removed unnecessary see tag
* Use consistent quotation marks around subscribers, the name for these users are dependant on the source of where they are integrated from (youtube or twitch), so we should not use a name that is specific to one platform
* Add <remarks> tag to the IGuildIntegration xmldocs
* Fix grammar issue
* Update DescriptionGenerator
* Cleanup of https://github.com/Still34/Discord.Net/pull/8
* Cleanup previous PR
* Fix for misleading behaviour in the emoji guide
+ Original lines stated that sending a emoji wrapped in colon will not be parsed, but that was incorrect; replaced with reactions instead of sending messages as the example
* Add strings for dictionary in DotSettings
* Add XML docs
* Fix lots of typos in comments
+ Geez, I didn't know there were so many.
* Add XML docs & rewrite GetMessagesAsync docs
This commit rewrites the remarks section of GetMessagesAsync, as well as adding examples to several methods.
* Update 'Your First Bot'
+ This commit reflects the new changes made to the Discord Application Developer Portal after its major update
* Initial optimization for DocFX render & add missing files
* Add examples in message methods
* Cleanup https://github.com/RogueException/Discord.Net/pull/1128
* Fix first bot note
* Cleanup FAQ structure
* Add XML docs
* Update docfx plugins
* Fix navbar collapsing issue
* Fix broken xref
* Cleanup FAQ section
+ Add introductory paragraphs to each FAQ section.
+ Add 'missing dependency' entry to commands FAQ.
* Split commands FAQ to 'General' and 'DI' sections.
* Cleanup https://github.com/RogueException/Discord.Net/pull/1139
* Fix missing namespace
* Add missing highlighting css for the light theme
* Add additional clarification for installing packages
* Add indentation to example for clarity
* Cleanup several articles to be more human-friendly and easier to read
* Remove RPC-related notes
* Cleanup slow-mode-related documentation strings
* Add an additional note about cross-guild emote usage
* Add CreateTextChannel sample
* Add XMLDocs
142 lines
5.8 KiB
Markdown
142 lines
5.8 KiB
Markdown
---
|
|
uid: FAQ.Commands.General
|
|
title: General Questions about Commands
|
|
---
|
|
|
|
# Command-related Questions
|
|
|
|
In the following section, you will find commonly asked questions and
|
|
answered regarding general command usage when using @Discord.Commands.
|
|
|
|
## How can I restrict some of my commands so only specific users can execute them?
|
|
|
|
Based on how you want to implement the restrictions, you can use the
|
|
built-in [RequireUserPermission] precondition, which allows you to
|
|
restrict the command based on the user's current permissions in the
|
|
guild or channel (*e.g., `GuildPermission.Administrator`,
|
|
`ChannelPermission.ManageMessages`*).
|
|
|
|
If, however, you wish to restrict the commands based on the user's
|
|
role, you can either create your custom precondition or use
|
|
Joe4evr's [Preconditions Addons] that provides a few custom
|
|
preconditions that aren't provided in the stock library.
|
|
Its source can also be used as an example for creating your
|
|
custom preconditions.
|
|
|
|
[RequireUserPermission]: xref:Discord.Commands.RequireUserPermissionAttribute
|
|
[Preconditions Addons]: https://github.com/Joe4evr/Discord.Addons/tree/master/src/Discord.Addons.Preconditions
|
|
|
|
## Why am I getting an error about `Assembly.GetEntryAssembly`?
|
|
|
|
You may be confusing @Discord.Commands.CommandService.AddModulesAsync*
|
|
with @Discord.Commands.CommandService.AddModuleAsync*. The former
|
|
is used to add modules via the assembly, while the latter is used to
|
|
add a single module.
|
|
|
|
## What does [Remainder] do in the command signature?
|
|
|
|
The [RemainderAttribute] leaves the string unparsed, meaning you
|
|
do not have to add quotes around the text for the text to be
|
|
recognized as a single object. Please note that if your method has
|
|
multiple parameters, the remainder attribute can only be applied to
|
|
the last parameter.
|
|
|
|
[!code-csharp[Remainder](samples/Remainder.cs)]
|
|
|
|
[RemainderAttribute]: xref:Discord.Commands.RemainderAttribute
|
|
|
|
## Discord.Net keeps saying that a `MessageReceived` handler is blocking the gateway, what should I do?
|
|
|
|
By default, the library warns the user about any long-running event
|
|
handler that persists for **more than 3 seconds**. Any event
|
|
handlers that are run on the same thread as the gateway task, the task
|
|
in charge of keeping the connection alive, may block the processing of
|
|
heartbeat, and thus terminating the connection.
|
|
|
|
In this case, the library detects that a `MessageReceived`
|
|
event handler is blocking the gateway thread. This warning is
|
|
typically associated with the command handler as it listens for that
|
|
particular event. If the command handler is blocking the thread, then
|
|
this **might** mean that you have a long-running command.
|
|
|
|
> [!NOTE]
|
|
> In rare cases, runtime errors can also cause blockage, usually
|
|
> associated with Mono, which is not supported by this library.
|
|
|
|
To prevent a long-running command from blocking the gateway
|
|
thread, a flag called [RunMode] is explicitly designed to resolve
|
|
this issue.
|
|
|
|
There are 2 main `RunMode`s.
|
|
|
|
1. `RunMode.Sync`
|
|
2. `RunMode.Async`
|
|
|
|
`Sync` is the default behavior and makes the command to be run on the
|
|
same thread as the gateway one. `Async` will spin the task off to a
|
|
different thread from the gateway one.
|
|
|
|
> [!IMPORTANT]
|
|
> While specifying `RunMode.Async` allows the command to be spun off
|
|
> to a different thread, keep in mind that by doing so, there will be
|
|
> **potentially unwanted consequences**. Before applying this flag,
|
|
> please consider whether it is necessary to do so.
|
|
>
|
|
> Further details regarding `RunMode.Async` can be found below.
|
|
|
|
You can set the `RunMode` either by specifying it individually via
|
|
the `CommandAttribute` or by setting the global default with
|
|
the [DefaultRunMode] flag under `CommandServiceConfig`.
|
|
|
|
# [CommandAttribute](#tab/cmdattrib)
|
|
|
|
[!code-csharp[Command Attribute](samples/runmode-cmdattrib.cs)]
|
|
|
|
# [CommandServiceConfig](#tab/cmdconfig)
|
|
|
|
[!code-csharp[Command Service Config](samples/runmode-cmdconfig.cs)]
|
|
|
|
***
|
|
|
|
***
|
|
|
|
[RunMode]: xref:Discord.Commands.RunMode
|
|
[CommandAttribute]: xref:Discord.Commands.CommandAttribute
|
|
[DefaultRunMode]: xref:Discord.Commands.CommandServiceConfig.DefaultRunMode
|
|
|
|
## How does `RunMode.Async` work, and why is Discord.Net *not* using it by default?
|
|
|
|
`RunMode.Async` works by spawning a new `Task` with an unawaited
|
|
[Task.Run], essentially making the task that is used to invoke the
|
|
command task to be finished on a different thread. This design means
|
|
that [ExecuteAsync] will be forced to return a successful
|
|
[ExecuteResult] regardless of the actual execution result.
|
|
|
|
The following are the known caveats with `RunMode.Async`,
|
|
|
|
1. You can potentially introduce a race condition.
|
|
2. Unnecessary overhead caused by the [async state machine].
|
|
3. [ExecuteAsync] will immediately return [ExecuteResult] instead of
|
|
other result types (this is particularly important for those who wish
|
|
to utilize [RuntimeResult] in 2.0).
|
|
4. Exceptions are swallowed.
|
|
|
|
However, there are ways to remedy some of these.
|
|
|
|
For #3, in Discord.Net 2.0, the library introduces a new event called
|
|
[CommandExecuted], which is raised whenever the command is
|
|
**successfully executed**. This event will be raised regardless of
|
|
the `RunMode` type and will return the appropriate execution result.
|
|
|
|
For #4, exceptions are caught in [CommandService.Log] event under
|
|
[LogMessage.Exception] as [CommandException].
|
|
|
|
[Task.Run]: https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task.run
|
|
[async state machine]: https://www.red-gate.com/simple-talk/dotnet/net-tools/c-async-what-is-it-and-how-does-it-work/
|
|
[ExecuteAsync]: xref:Discord.Commands.CommandService.ExecuteAsync*
|
|
[ExecuteResult]: xref:Discord.Commands.ExecuteResult
|
|
[RuntimeResult]: xref:Discord.Commands.RuntimeResult
|
|
[CommandExecuted]: xref:Discord.Commands.CommandService.CommandExecuted
|
|
[CommandService.Log]: xref:Discord.Commands.CommandService.Log
|
|
[LogMessage.Exception]: xref:Discord.LogMessage.Exception*
|
|
[CommandException]: xref:Discord.Commands.CommandException |