DiscordKt/me.jakejmattson.discordkt.arguments/ChannelArg

ChannelArg

open class ChannelArg<T : GuildChannel>(val name: String = "Channel", val description: String = internalLocale.channelArgDescription, allowsGlobal: Boolean = false) : ChannelArgument<T>

Accepts a Discord TextChannel entity as an ID or mention.

Parameters

allowsGlobal

Whether this entity can be retrieved from outside this guild.

Inheritors

Companion

Constructors

ChannelArg

constructor(name: String = "Channel", description: String = internalLocale.channelArgDescription, allowsGlobal: Boolean = false)

Types

Companion

object Companion : ChannelArg<TextChannel>

Accepts a Discord TextChannel entity as an ID or mention 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

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<Channel, T>

Accept multiple inputs of this Argument.

optional

open fun optional(default: T): OptionalArg<Channel, T, T>

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

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

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

optionalNullable

open fun optionalNullable(default: T?): OptionalArg<Channel, T, T?>

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

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

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

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

transform

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

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