GuildArg

open class GuildArg(val name: String = "Guild", val description: String = internalLocale.guildArgDescription) : StringArgument<Guild>

Accepts a Discord Guild entity as an ID.

Constructors

fun GuildArg(name: String = "Guild", description: String = internalLocale.guildArgDescription)

Accepts a Discord Guild entity as an ID.

Offer autocomplete options for this argument.

open suspend override fun generateExamples(context: DiscordContext): List<String>

A function called whenever an example of this type is needed.

Utility function to check that this Argument is an OptionalArg.

Accept multiple inputs of this Argument.

open fun optional(default: Guild): OptionalArg<String, Guild, Guild>

Make this argument optional and fall back to the default value if the conversion fails.

open fun optional(default: suspend (DiscordContext) -> Guild): OptionalArg<String, Guild, Guild>

Make this argument optional and fall back to the default value if the conversion fails. Exposes a CommandEvent.

open fun optionalNullable(default: Guild? = null): OptionalArg<String, Guild, Guild?>

Make this argument optional and fall back to the default value if the conversion fails.

open fun optionalNullable(default: suspend (DiscordContext) -> Guild?): OptionalArg<String, Guild, Guild?>

Make this argument optional and fall back to the default value if the conversion fails. Exposes a CommandEvent.

open suspend override fun parse(args: MutableList<String>, discord: Discord): String?

Parse string input into the correct type handled by this argument.

open suspend override fun transform(input: String, context: DiscordContext): Result<Guild>

Transforms a value produced by a slash command or by the parse function.

open override val description: String

A description of the data that this type represents.

open override val name: String

The display name for this type in documentations and examples.