kord-extensions/dev.kordex.core.extensions.base/HelpProvider/getCommandHelpPaginator

getCommandHelpPaginator

abstract suspend fun getCommandHelpPaginator(event: MessageCreateEvent, prefix: String, args: List<String>): BasePaginator

Given an event, prefix and argument list, attempt to find the command represented by the arguments and return a BasePaginator, ready to be sent.

The BasePaginator will contain an error message if the command can't be found, or the command's checks fail.

Return

Paginator containing the command's help, or an error message.

Parameters

event

MessageCreateEvent that triggered this help invocation.

prefix

Command prefix to use for formatting.

args

List of arguments to use to find the command.

open suspend fun getCommandHelpPaginator(context: ChatCommandContext<*>, args: List<String>): BasePaginator

Given a command context and argument list, attempt to find the command represented by the arguments and return a BasePaginator, ready to be sent.

The BasePaginator will contain an error message if the command can't be found, or the command's checks fail.

Return

Paginator containing the command's help, or an error message.

Parameters

context

MessageCommandContext object that triggered this help invocation.

args

List of arguments to use to find the command.

abstract suspend fun getCommandHelpPaginator(event: MessageCreateEvent, prefix: String, command: ChatCommand<out Arguments>?): BasePaginator

Given an event, prefix and argument list, attempt to find the command represented by the arguments and return a BasePaginator, ready to be sent.

The BasePaginator will contain an error message if the command passed was null, or the command's checks fail.

Please be mindful of using this with subcommands, as the extension's design intends for users to be unable to retrieve help for subcommands when any parent command's checks fail, and this function does not run those checks.

Return

Paginator containing the command's help, or an error message.

Parameters

event

MessageCreateEvent that triggered this help invocation.

prefix

Command prefix to use for formatting.

command

Command object to format the help for.

open suspend fun getCommandHelpPaginator(context: ChatCommandContext<*>, command: ChatCommand<out Arguments>?): BasePaginator

Given a command context and argument list, attempt to find the command represented by the arguments and return a BasePaginator, ready to be sent.

The BasePaginator will contain an error message if the command passed was null, or the command's checks fail.

Please be mindful of using this with subcommands, as the extension's design intends for users to be unable to retrieve help for subcommands when any parent command's checks fail, and this function does not run those checks.

Return

Paginator containing the command's help, or an error message.

Parameters

context

MessageCommandContext object that triggered this help invocation.

command

Command object to format the help for.