Package net.dv8tion.jda.api.entities

Enum ChannelType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ChannelType>
    public enum ChannelType
extends java.lang.Enum<ChannelType>
    Enum used to differentiate between the different types of Discord channels.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ChannelType fromId​(int id)
      Static accessor for retrieving a channel type based on its Discord id key.
      static java.util.EnumSet<ChannelType> fromSortBucket​(int bucket)
      An EnumSet populated with all channel types using the provided sorting bucket.
      int getId()
      The Discord id key used to represent the channel type.
      int getSortBucket()
      The sorting bucket for this channel type.
      boolean isAudio()
      Whether channels of this type support audio connections.
      boolean isGuild()
      Whether this ChannelType is present for a GuildChannel
      boolean isMessage()
      Whether channels of this type support message sending.
      static ChannelType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ChannelType[] 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

    • Method Detail

      • values

        public static ChannelType[] 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 (ChannelType c : ChannelType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ChannelType 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

      • getSortBucket

        public int getSortBucket()
        The sorting bucket for this channel type.
        Returns:
        The sorting bucket

      • getId

        public int getId()
        The Discord id key used to represent the channel type.
        Returns:
        The id key used by discord for this channel type.

      • isGuild

        public boolean isGuild()
        Whether this ChannelType is present for a GuildChannel
        Returns:
        Whether or not this a GuildChannel

      • isAudio

        public boolean isAudio()
        Whether channels of this type support audio connections.
        Returns:
        True, if channels of this type support audio

      • isMessage

        public boolean isMessage()
        Whether channels of this type support message sending.
        Returns:
        True, if channels of this type support messages

      • fromId

        @Nonnull
public static ChannelType fromId​(int id)
        Static accessor for retrieving a channel type based on its Discord id key.
        Parameters:
        id - The id key of the requested channel type.
        Returns:
        The ChannelType that is referred to by the provided key. If the id key is unknown, UNKNOWN is returned.

      • fromSortBucket

        @Nonnull
public static java.util.EnumSet<ChannelType> fromSortBucket​(int bucket)
        An EnumSet populated with all channel types using the provided sorting bucket.
        Parameters:
        bucket - The sorting bucket
        Returns:
        Possibly-empty EnumSet for the bucket