UserArg

open class UserArg(val name: String = "User", val description: String = internalLocale.userArgDescription) : UserArgument<User>

Accepts a Discord User entity as an ID or mention.

Constructors

fun UserArg(name: String = "User", description: String = internalLocale.userArgDescription)

Accepts a Discord User entity as an ID or mention. Does not allow bots.

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.

open fun multiple(): MultipleArg<User, User>

Accept multiple inputs of this Argument.

open fun optional(default: User): OptionalArg<User, User, User>

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

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

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

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

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

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

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): User?

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

open suspend fun transform(input: User, context: DiscordContext): Result<User>

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.