Companion

object Companion : UnicodeEmojiArg

Accepts a unicode emoji.

Functions

Link copied to clipboard
open fun autocomplete(choices: suspend AutocompleteData.() -> List<String>): AutocompleteArg<String, DiscordEmoji>

Offer autocomplete options for this argument.

Link copied to clipboard
open suspend override fun generateExamples(context: DiscordContext): List<String>

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

Link copied to clipboard
open fun isOptional(): Boolean

Utility function to check that this Argument is an OptionalArg.

Link copied to clipboard
open fun multiple(): MultipleArg<String, DiscordEmoji>

Accept multiple inputs of this Argument.

Link copied to clipboard
open fun optional(default: DiscordEmoji): OptionalArg<String, DiscordEmoji, DiscordEmoji>

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

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

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

Link copied to clipboard
open fun optionalNullable(default: DiscordEmoji? = null): OptionalArg<String, DiscordEmoji, DiscordEmoji?>

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

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

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

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

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

Link copied to clipboard
open suspend override fun transform(input: String, context: DiscordContext): Result<DiscordEmoji>

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

Properties

Link copied to clipboard
open override val description: String

A description of the data that this type represents.

Link copied to clipboard
open override val name: String

The display name for this type in documentations and examples.