Package com.dianxin.tori.api.bot

Interface IBotMeta

public interface IBotMeta
Represents the metadata of a Discord bot running on the Tori Server.

The data provided by this interface is typically parsed directly from the bot's bot.yml configuration file located in its resources.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull String
    botAuthor()
    Gets the name of the primary author or developer of the bot.
    @NotNull List<String>
    botContributors()
    Gets a list of additional contributors who helped develop the bot.
    @UnknownNullability String
    botDescription()
    Gets a brief description of what the bot does.
    @NotNull String
    botName()
    Gets the name of the bot.
    @NotNull String
    botOwnerId()
    Gets the Discord User ID of the bot's primary owner.
    @NotNull String
    botVersion()
    Gets the current version of the bot.
    @Nullable String
    botWebsite()
    Gets the official website or promotional page for the bot.
    @NotNull String
    mainClassPath()
    Gets the fully qualified class path to the bot's main class (the class that extends JavaDiscordBot).

  • Method Details

    • botName

      @NotNull @NotNull String botName()
      Gets the name of the bot.
      Returns:
      The bot's name.

    • botDescription

      @UnknownNullability String botDescription()
      Gets a brief description of what the bot does.
      Returns:
      The description of the bot, or null/empty if not specified.

    • botVersion

      @NotNull @NotNull String botVersion()
      Gets the current version of the bot.
      Returns:
      The version string (e.g., "1.0.0").

    • botAuthor

      @NotNull @NotNull String botAuthor()
      Gets the name of the primary author or developer of the bot.
      Returns:
      The author's name.

    • botContributors

      @NotNull @NotNull List<String> botContributors()
      Gets a list of additional contributors who helped develop the bot.
      Returns:
      A list of contributor names, or an empty list if there are none.

    • mainClassPath

      @NotNull @NotNull String mainClassPath()
      Gets the fully qualified class path to the bot's main class (the class that extends JavaDiscordBot).
      Returns:
      The main class path (e.g., "com.example.bot.MainBotClass").

    • botWebsite

      @Nullable @Nullable String botWebsite()
      Gets the official website or promotional page for the bot.
      Returns:
      The URL of the bot's website, or null if not provided.

    • botOwnerId

      @NotNull @NotNull String botOwnerId()
      Gets the Discord User ID of the bot's primary owner.

      This is typically used by the framework to verify owner-exclusive permissions, such as restricting access to commands annotated with @OwnerOnly.

      Returns:
      The snowflake ID of the bot owner.