io.github.freya022.botcommands.api.commands.application.annotations.Test.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of BotCommands Show documentation

A Kotlin-first (and Java) framework that makes creating Discord bots a piece of cake, using the JDA library.

There is a newer version: 3.0.0-alpha.18

package io.github.freya022.botcommands.api.commands.application.annotations

import io.github.freya022.botcommands.api.commands.application.slash.annotations.TopLevelSlashCommandData
import io.github.freya022.botcommands.api.core.config.BApplicationConfig
import net.dv8tion.jda.api.entities.Guild

/**
 * Defines an **annotated** application command as being test-only.
 *
 * This means this application command will only be pushed in guilds
 * defined by [BApplicationConfig.testGuildIds] and [guildIds].
 *
 * **Note:** This only applies to top-level commands, for slash commands,
 * this means the annotation needs to be used alongside [@TopLevelSlashCommandData][TopLevelSlashCommandData].
 */
@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.RUNTIME)
annotation class Test(
    /**
     * Specifies the [Guild] IDs in which the command should try to be inserted in
     */
    val guildIds: LongArray = [],

    /**
     * Whether this should be added to the list of existing test guild IDs
     *
     * **Default:** false
     */
    val append: Boolean = false
)