DiscordKt/me.jakejmattson.discordkt.arguments/RoleArg

RoleArg

open class RoleArg( val name: String = "Role", val description: String = internalLocale.roleArgDescription, guildId: Snowflake? = null, allowsGlobal: Boolean = false) : RoleArgument<Role>

Accepts a Discord Role entity as an ID, a mention, or by name.

Parameters

guildId

The guild ID used to determine which guild to search in.

allowsGlobal

Whether this entity can be retrieved from outside this guild.

Constructors

RoleArg

fun RoleArg( name: String = "Role", description: String = internalLocale.roleArgDescription, guildId: Snowflake? = null, allowsGlobal: Boolean = false)

Types

Companion

object Companion : RoleArg

Accepts a Discord Role entity as an ID, a mention, or by name from within this guild.

Functions

generateExamples

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

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

isOptional

open fun isOptional(): Boolean

Utility function to check that this Argument is an OptionalArg.

multiple

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

Accept multiple inputs of this Argument.

optional

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

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

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

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

optionalNullable

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

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

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

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

parse

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

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

transform

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

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

Properties

description

open override val description: String

A description of the data that this type represents.

name

open override val name: String

The display name for this type in documentations and examples.

Inheritors

Companion