Class HelpModule
- Namespace
- Signal.Application.Commands
- Assembly
- Signal.Application.dll
Built-in help command (aliases ?, commands), generated from command metadata:
/helplists all visible commands, under headings (command groups and CategoryAttribute) when there is more than one, paged by HelpPageSize;/help 2shows the second page;/help <command>shows usage, description, aliases, parameter summaries and examples;/help <group>lists a command group.
Disable with Signal:Commands:EnableHelp = false.
public sealed class HelpModule : CommandModule
- Inheritance
-
HelpModule
- Inherited Members
Constructors
HelpModule(ICommandRegistry)
Built-in help command (aliases ?, commands), generated from command metadata:
/helplists all visible commands, under headings (command groups and CategoryAttribute) when there is more than one, paged by HelpPageSize;/help 2shows the second page;/help <command>shows usage, description, aliases, parameter summaries and examples;/help <group>lists a command group.
Disable with Signal:Commands:EnableHelp = false.
public HelpModule(ICommandRegistry registry)
Parameters
registryICommandRegistryThe command registry.
Methods
HelpAsync(string?)
Lists all commands (or one page of them), or describes one command or group.
[Command("help", Aliases = new string[] { "?", "commands" }, Description = "Lists all commands or shows details of one command.")]
[Example("help")]
[Example("help 2")]
[Example("help add")]
public Task HelpAsync(string? command = null)
Parameters
commandstringThe command or group to describe (with or without prefix, e.g.
addorplaylist add), a page number, or null for the first page.
Returns
- Task
A task that completes when the reply was sent.