Package net.dv8tion.jda.core.entities

Enum ChannelType

java.lang.Object

java.lang.Enum<ChannelType>

net.dv8tion.jda.core.entities.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.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CATEGORY	A Category, Guild-Only.
GROUP	A Group.
NEWS
PRIVATE	A PrivateChannel.
STORE
TEXT	A TextChannel, Guild-Only.
UNKNOWN	Unknown Discord channel type.
VOICE	A VoiceChannel, Guild-Only.

Method Summary

Modifier and Type	Method	Description
static ChannelType	fromId(int id)	Static accessor for retrieving a channel type based on its Discord id key.
int	getId()	The Discord id key used to represent the channel type.
boolean	isGuild()	Whether this ChannelType is present for a Guild Channel
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

Enum Constant Detail

TEXT

public static final ChannelType TEXT

A TextChannel, Guild-Only.

PRIVATE

public static final ChannelType PRIVATE

A PrivateChannel.

VOICE

public static final ChannelType VOICE

A VoiceChannel, Guild-Only.

GROUP

public static final ChannelType GROUP

A Group. AccountType.CLIENT only.

CATEGORY

public static final ChannelType CATEGORY

A Category, Guild-Only.

NEWS

public static final ChannelType NEWS

STORE

public static final ChannelType STORE

UNKNOWN

public static final ChannelType UNKNOWN

Unknown Discord channel type. Should never happen and would only possibly happen if Discord implemented a new channel type and JDA had yet to implement support for it.

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

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 Guild Channel

Returns:

Whether or not this a Guild Channel

fromId

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.