Package discord4j.core.object.entity.channel

Enum Channel.Type

java.lang.Object

java.lang.Enum<Channel.Type>

discord4j.core.object.entity.channel.Channel.Type

All Implemented Interfaces:

Serializable, Comparable<Channel.Type>

Enclosing interface:

Channel

public static enum Channel.Type
extends Enum<Channel.Type>

Represents the various types of channels.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DM	Represents a PrivateChannel.
GROUP_DM	Represents a group DM.
GUILD_CATEGORY	Represents a Category.
GUILD_NEWS	Represents a NewsChannel.
GUILD_STAGE_VOICE	Represents a VoiceChannel for hosting events with an audience.
GUILD_STORE	Represents a StoreChannel.
GUILD_TEXT	Represents a TextChannel.
GUILD_VOICE	Represents a VoiceChannel.
UNKNOWN	Unknown type.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Gets the underlying value as represented by Discord.
static Channel.Type	of(int value)	Gets the type of channel.
static Channel.Type	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Channel.Type[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final Channel.Type UNKNOWN

Unknown type.

GUILD_TEXT

public static final Channel.Type GUILD_TEXT

Represents a TextChannel.

DM

public static final Channel.Type DM

Represents a PrivateChannel.

GUILD_VOICE

public static final Channel.Type GUILD_VOICE

Represents a VoiceChannel.

GROUP_DM

public static final Channel.Type GROUP_DM

Represents a group DM.

GUILD_CATEGORY

public static final Channel.Type GUILD_CATEGORY

Represents a Category.

GUILD_NEWS

public static final Channel.Type GUILD_NEWS

Represents a NewsChannel.

GUILD_STORE

public static final Channel.Type GUILD_STORE

Represents a StoreChannel.

GUILD_STAGE_VOICE

public static final Channel.Type GUILD_STAGE_VOICE

Represents a VoiceChannel for hosting events with an audience.

Method Detail

values

public static Channel.Type[] 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 (Channel.Type c : Channel.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Channel.Type 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

getValue

public int getValue()

Gets the underlying value as represented by Discord.

Returns:

The underlying value as represented by Discord.

of

public static Channel.Type of(int value)

Gets the type of channel. It is guaranteed that invoking getValue() from the returned enum will equal (==) the supplied value.

Parameters:

value - The underlying value as represented by Discord.

Returns:

The type of channel.