DiscordKt/me.jakejmattson.discordkt.arguments/MemberArg

MemberArg

open class MemberArg( val name: String = "Member", val description: String = internalLocale.memberArgDescription, allowsBot: Boolean = false) : UserArgument<Member>

Accepts a Discord Member entity as an ID or mention.

Parameters

allowsBot

Whether a bot is a valid input.

Constructors

MemberArg

fun MemberArg( name: String = "Member", description: String = internalLocale.memberArgDescription, allowsBot: Boolean = false)

Types

Companion

object Companion : MemberArg

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

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<User, Member>

Accept multiple inputs of this Argument.

optional

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

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

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

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

optionalNullable

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

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

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

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

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

transform

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

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