Package net.dv8tion.jda.api.entities

Enum ChannelType

    • 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​(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

      • 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

      • isThread

        public boolean isThread()
        Whether channels of this type are ThreadChannels. This mostly exists to make handling threads simpler than having to check 3 separate ChannelTypes every time.
        Returns:
        True, if channels of this type are ThreadChannel

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