HelpArguments

Help command arguments class.

Constructors

constructor()

List of Argument objects, which wrap converters.

Command to get help for.

During an autocomplete interaction, whether to try to fill the defined arguments from that event before calling the registered callback.

open fun <R : Any> arg(displayName: Key, description: Key, converter: CoalescingConverter<R>): CoalescingConverter<R>

Add a CoalescingConverter argument to this set of arguments.

Add a DefaultingCoalescingConverter argument to this set of arguments.

open fun <R : Any> arg(displayName: Key, description: Key, converter: DefaultingConverter<R>): DefaultingConverter<R>

Add a DefaultingConverter argument to this set of arguments.

open fun <R : Any> arg(displayName: Key, description: Key, converter: ListConverter<R>): ListConverter<R>

Add a ListConverter argument to this set of arguments.

Add an OptionalCoalescingConverter argument to this set of arguments.

open fun <R : Any> arg(displayName: Key, description: Key, converter: OptionalConverter<R>): OptionalConverter<R>

Add an OptionalConverter argument to this set of arguments.

open fun <R : Any> arg(displayName: Key, description: Key, converter: SingleConverter<R>): SingleConverter<R>

Add a SingleConverter argument to this set of arguments.

open fun validate(locale: Locale)

Validation function that will throw an error if there's a problem with this Arguments class/subclass.