Package net.dv8tion.jda.api.entities

Enum Guild.BoostTier

java.lang.Object
java.lang.Enum<Guild.BoostTier>
net.dv8tion.jda.api.entities.Guild.BoostTier
All Implemented Interfaces:
Serializable, Comparable<Guild.BoostTier>
Enclosing interface:
Guild
public static enum Guild.BoostTier extends Enum<Guild.BoostTier>
The boost tier for this guild.
Each tier unlocks new perks for a guild that can be seen in the features.
Since:
4.0.0

  • Enum Constant Details

    • NONE

      public static final Guild.BoostTier NONE
      The default tier.
      Unlocked at 0 boosters.

    • TIER_1

      public static final Guild.BoostTier TIER_1
      The first tier.
      Unlocked at 2 boosters.

    • TIER_2

      public static final Guild.BoostTier TIER_2
      The second tier.
      Unlocked at 7 boosters.

    • TIER_3

      public static final Guild.BoostTier TIER_3
      The third tier.
      Unlocked at 14 boosters.

    • UNKNOWN

      public static final Guild.BoostTier UNKNOWN
      Placeholder for future tiers.

  • Method Details

    • values

      public static Guild.BoostTier[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Guild.BoostTier valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getKey

      public int getKey()
      The API key used to represent this tier, identical to the ordinal.
      Returns:
      The key

    • getMaxBitrate

      public int getMaxBitrate()
      The maximum bitrate that can be applied to voice channels when this tier is reached.
      Returns:
      The maximum bitrate
      See Also:

    • getMaxEmotes

      public int getMaxEmotes()
      The maximum amount of emotes a guild can have when this tier is reached.
      Returns:
      The maximum emotes
      See Also:

    • getMaxFileSize

      public long getMaxFileSize()
      The maximum size for files that can be uploaded to this Guild.
      Returns:
      The maximum file size of this Guild
      See Also:

    • fromKey

      @Nonnull public static Guild.BoostTier fromKey(int key)
      Resolves the provided API key to the boost tier.
      Parameters:
      key - The API key
      Returns:
      The BoostTier or UNKNOWN