Package net.dv8tion.jda.api.entities

Enum Guild.BoostTier

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Guild.BoostTier>
    Enclosing interface:
    Guild
    public static enum Guild.BoostTier
extends java.lang.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 Summary

      Enum Constants 
      Enum Constant Description
      NONE
      The default tier.
      TIER_1
      The first tier.
      TIER_2
      The second tier.
      TIER_3
      The third tier.
      UNKNOWN
      Placeholder for future tiers.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Guild.BoostTier fromKey​(int key)
      Resolves the provided API key to the boost tier.
      int getKey()
      The API key used to represent this tier, identical to the ordinal.
      int getMaxBitrate()
      The maximum bitrate that can be applied to voice channels when this tier is reached.
      int getMaxEmotes()
      The maximum amount of emotes a guild can have when this tier is reached.
      long getMaxFileSize()
      The maximum size for files that can be uploaded to this Guild.
      static Guild.BoostTier valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Guild.BoostTier[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • 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 Detail

      • values

        public static Guild.BoostTier[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Guild.BoostTier c : Guild.BoostTier.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Guild.BoostTier valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.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:
        Guild.getMaxBitrate()

      • getMaxEmotes

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

      • 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:
        Guild.getMaxFileSize()

      • 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