AttachmentArg

open class AttachmentArg(val name: String = "Attachment", val description: String = internalLocale.attachmentArgDescription) : AttachmentArgument<Attachment>

Accepts a message attachment.

Constructors

fun AttachmentArg(name: String = "Attachment", description: String = internalLocale.attachmentArgDescription)

Accepts a message attachment.

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<Attachment, Attachment>

Accept multiple inputs of this Argument.

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

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

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

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

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

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

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

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

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

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

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.