Package net.dv8tion.jda.api.entities.channel

Enum ChannelField

java.lang.Object

java.lang.Enum<ChannelField>

net.dv8tion.jda.api.entities.channel.ChannelField

All Implemented Interfaces:

Serializable, Comparable<ChannelField>

public enum ChannelField
extends Enum<ChannelField>

This enum represents the attributes of a channel that can be modified by events.
Most of these changes are tracked and reflected by Audit Log Entries.
Values of this enum without an AuditLogKey are not tracked by the Audit Log.

See Also:

• GenericChannelEvent
• AuditLogKey

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPLIED_TAGS	The tags applied to a forum post thread.
ARCHIVED	The archive state of this channel.
ARCHIVED_TIMESTAMP	The time this channel's archival information was last updated.
AUTO_ARCHIVE_DURATION	The auto archive duration of this channel.
AVAILABLE_TAGS	The applied tags of a ForumChannel.
BITRATE	The bitrate (in bits per second) of the audio in this channel.
DEFAULT_FORUM_LAYOUT	The default layout of a forum channel.
DEFAULT_REACTION_EMOJI	The default reaction emoji used in a ForumChannel.
DEFAULT_SORT_ORDER	The default sort order of a forum channel.
DEFAULT_THREAD_SLOWMODE	The default slowmode applied to threads in a ThreadContainer.
FLAGS	The flags of the channel.
INVITABLE	The invite state of this channel.
LOCKED	The locked state of this channel.
NAME	The name of the channel.
NSFW	The NSFW state of the channel.
PARENT	The parent of the channel.
POSITION	The position of this channel relative to other channels in the guild.
REGION	The region of the channel.
SLOWMODE	The state of slow mode in the channel.
TOPIC	The topic of the channel.
TYPE	The type of the channel.
USER_LIMIT	The maximum user count of this channel.
VOICE_STATUS	The status of the channel.

Method Summary

Modifier and Type	Method	Description
AuditLogKey	getAuditLogKey()
String	getFieldName()
String	toString()
static ChannelField	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ChannelField[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TYPE

public static final ChannelField TYPE

The type of the channel.

See Also:

• Channel.getType()

NAME

public static final ChannelField NAME

The name of the channel.

See Also:

• Channel.getName()

FLAGS

public static final ChannelField FLAGS

The flags of the channel.

See Also:

• Channel.getFlags()

PARENT

public static final ChannelField PARENT

The parent of the channel.

Limited to Categorizable Channels (and implementations).

See Also:

• ICategorizableChannel.getParentCategory()

POSITION

public static final ChannelField POSITION

The position of this channel relative to other channels in the guild.

See Also:

• IPositionableChannel.getPosition()

DEFAULT_THREAD_SLOWMODE

public static final ChannelField DEFAULT_THREAD_SLOWMODE

The default slowmode applied to threads in a ThreadContainer.

See Also:

• IThreadContainer.getDefaultThreadSlowmode()

DEFAULT_REACTION_EMOJI

public static final ChannelField DEFAULT_REACTION_EMOJI

The default reaction emoji used in a ForumChannel.

See Also:

• IPostContainer.getDefaultReaction()

TOPIC

public static final ChannelField TOPIC

The topic of the channel.

Limited to NewsChannels, TextChannels, and ForumChannels.

See Also:

• StandardGuildMessageChannel.getTopic()
• IPostContainer.getTopic()

NSFW

public static final ChannelField NSFW

The NSFW state of the channel.

Limited to IAgeRestrictedChannels (and implementations).

See Also:

• IAgeRestrictedChannel.isNSFW()

SLOWMODE

public static final ChannelField SLOWMODE

The state of slow mode in the channel.
This defines the minimum time between message sends.

Limited to ISlowmodeChannels (and implementations).

See Also:

• ISlowmodeChannel.getSlowmode()

AVAILABLE_TAGS

public static final ChannelField AVAILABLE_TAGS

The applied tags of a ForumChannel.

See Also:

• IPostContainer.getAvailableTags()

BITRATE

public static final ChannelField BITRATE

The bitrate (in bits per second) of the audio in this channel.

For standard channels this is between 8000 and 96000.

VIP servers extend this limit to 128000.
The bitrates of boost tiers may be found in the boost tiers.

Limited to Audio Channels.

See Also:

• AudioChannel.getBitrate()

REGION

public static final ChannelField REGION

The region of the channel.

Limited to Audio Channels.

See Also:

• AudioChannel.getRegion()
• Region

USER_LIMIT

public static final ChannelField USER_LIMIT

The maximum user count of this channel.

Limited to Voice Channels.

See Also:

• AudioChannel.getUserLimit()

VOICE_STATUS

public static final ChannelField VOICE_STATUS

The status of the channel.

Limited to Voice Channels.

See Also:

• IVoiceStatusChannel.getStatus()

AUTO_ARCHIVE_DURATION

public static final ChannelField AUTO_ARCHIVE_DURATION

The auto archive duration of this channel.

If the thread is inactive for this long, it becomes auto-archived.

Limited to Thread Channels.

See Also:

• ThreadChannel.getAutoArchiveDuration()
• ThreadChannel.AutoArchiveDuration

ARCHIVED

public static final ChannelField ARCHIVED

The archive state of this channel.

If the channel is archived, this is true.

Limited to Thread Channels.

See Also:

• ThreadChannel.isArchived()

ARCHIVED_TIMESTAMP

public static final ChannelField ARCHIVED_TIMESTAMP

The time this channel's archival information was last updated.

This timestamp will be updated when any of the following happens:

• The channel is archived
• The channel is unarchived
• The AUTO_ARCHIVE_DURATION is changed.

Limited to Thread Channels.

See Also:

• ThreadChannel.getTimeArchiveInfoLastModified()

LOCKED

public static final ChannelField LOCKED

The locked state of this channel.

If the channel is locked, this is true.

Limited to Thread Channels.

See Also:

• ThreadChannel.isLocked()

INVITABLE

public static final ChannelField INVITABLE

The invite state of this channel.

If the channel is invitable, this is true.

Limited to Thread Channels.

See Also:

• ThreadChannel.isInvitable()

APPLIED_TAGS

public static final ChannelField APPLIED_TAGS

The tags applied to a forum post thread.

Limited to ThreadChannels inside ForumChannels

See Also:

• ThreadChannel.getAppliedTags()

DEFAULT_FORUM_LAYOUT

public static final ChannelField DEFAULT_FORUM_LAYOUT

The default layout of a forum channel.

Limited to Forum Channels.

See Also:

• ForumChannel.getDefaultLayout()

DEFAULT_SORT_ORDER

public static final ChannelField DEFAULT_SORT_ORDER

The default sort order of a forum channel.

Limited to Forum Channels and Media Channels.

See Also:

• IPostContainer.getDefaultSortOrder()

Method Details

values

public static ChannelField[] 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 ChannelField 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

getFieldName

@Nonnull
public String getFieldName()

getAuditLogKey

@Nullable
public AuditLogKey getAuditLogKey()

toString

@Nonnull
public String toString()

Overrides:

toString in class Enum<ChannelField>