Enum ChannelFlag

java.lang.Object
java.lang.Enum<ChannelFlag>
net.dv8tion.jda.api.entities.channel.ChannelFlag
All Implemented Interfaces:
Serializable, Comparable<ChannelFlag>

public enum ChannelFlag extends Enum<ChannelFlag>
Flags for specific channel settings.
  • Enum Constant Details

    • PINNED

      public static final ChannelFlag PINNED
      This is a forum post ThreadChannel which is pinned in the ForumChannel.
    • REQUIRE_TAG

      public static final ChannelFlag REQUIRE_TAG
      This is a ForumChannel which requires all new post threads to have at least one applied tag.
    • HIDE_MEDIA_DOWNLOAD_OPTIONS

      public static final ChannelFlag HIDE_MEDIA_DOWNLOAD_OPTIONS
      This is a MediaChannel which hides the copy embed option.
  • Method Details

    • values

      public static ChannelFlag[] 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 ChannelFlag 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
    • getRaw

      public int getRaw()
      The raw bitset value of this flag.
      Returns:
      The raw value
    • fromRaw

      @Nonnull public static EnumSet<ChannelFlag> fromRaw(int bitset)
      Parses the provided bitset to the corresponding enum constants.
      Parameters:
      bitset - The bitset of channel flags
      Returns:
      The enum constants of the provided bitset
    • getRaw

      public static int getRaw(@Nonnull Collection<ChannelFlag> flags)
      The raw bitset value for the provided flags.
      Returns:
      The raw value