DiscordKt/me.jakejmattson.discordkt.arguments/GuildEmojiArg

GuildEmojiArg

open class GuildEmojiArg(val name: String = "Guild Emoji", val description: String = internalLocale.guildEmojiArgDescription, allowsGlobal: Boolean = false) : StringArgument<GuildEmoji>

Accepts a guild emoji.

Parameters

allowsGlobal

Whether this entity can be retrieved from outside this guild.

Inheritors

Companion

Constructors

GuildEmojiArg

constructor(name: String = "Guild Emoji", description: String = internalLocale.guildEmojiArgDescription, allowsGlobal: Boolean = false)

Types

Companion

object Companion : GuildEmojiArg

Accepts a guild emote from within this guild.

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.

Functions

autocomplete

open fun autocomplete(choices: suspend AutocompleteData.() -> List<String>): AutocompleteArg<String, GuildEmoji>

Offer autocomplete options for this argument.

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<String, GuildEmoji>

Accept multiple inputs of this Argument.

optional

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

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

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

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

optionalNullable

open fun optionalNullable(default: GuildEmoji?): OptionalArg<String, GuildEmoji, GuildEmoji?>

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

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

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

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

transform

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

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