Package net.dv8tion.jda.api.entities
Enum ChannelField
- java.lang.Object
-
- java.lang.Enum<ChannelField>
-
- net.dv8tion.jda.api.entities.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 byAudit Log Entries
.
Values of this enum without anAuditLogKey
are not tracked by the Audit Log.- See Also:
GenericChannelEvent
,AuditLogKey
-
-
Enum Constant Summary
Enum Constants Enum Constant Description 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.BITRATE
The bitrate (in bits per second) of the audio in this 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
Theparent
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
Thetype
of the channel.USER_LIMIT
The maximum user count of this channel.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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.
-
-
-
Enum Constant Detail
-
TYPE
public static final ChannelField TYPE
Thetype
of the channel.- See Also:
Channel.getType()
-
NAME
public static final ChannelField NAME
The name of the channel.- See Also:
Channel.getName()
-
PARENT
public static final ChannelField PARENT
Theparent
of the channel. Limited toCategorizable Channels
(and implementations).
-
POSITION
public static final ChannelField POSITION
The position of this channel relative to other channels in the guild.- See Also:
IPositionableChannel.getPosition()
-
TOPIC
public static final ChannelField TOPIC
The topic of the channel. Limited toNewsChannels
andTextChannels
.- See Also:
BaseGuildMessageChannel.getTopic()
-
NSFW
public static final ChannelField NSFW
The NSFW state of the channel. Limited toBase Guild Channels
(and implementations).- See Also:
BaseGuildMessageChannel.isNSFW()
-
SLOWMODE
public static final ChannelField SLOWMODE
The state of slow mode in the channel. This defines the minimum time between message sends. Limited toText Channels
.- See Also:
TextChannel.getSlowmode()
-
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 inthe boost tiers
. Limited toAudio Channels
.- See Also:
AudioChannel.getBitrate()
-
REGION
public static final ChannelField REGION
The region of the channel. Limited toAudio Channels
.- See Also:
AudioChannel.getRegion()
,Region
-
USER_LIMIT
public static final ChannelField USER_LIMIT
The maximum user count of this channel. Limited toVoice Channels
.- See Also:
VoiceChannel.getUserLimit()
-
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 toThread Channels
.
-
ARCHIVED
public static final ChannelField ARCHIVED
The archive state of this channel. If the channel is archived, this is true. Limited toThread 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 happen:- The channel is archived
- The channel is unarchived
- The AUTO_ARCHIVE_DURATION is changed.
Thread Channels
.
-
LOCKED
public static final ChannelField LOCKED
The locked state of this channel. If the channel is locked, this is true. Limited toThread 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 toThread Channels
.- See Also:
ThreadChannel.isInvitable()
-
-
Method Detail
-
values
public static ChannelField[] 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 (ChannelField c : ChannelField.values()) System.out.println(c);
- 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 nameNullPointerException
- if the argument is null
-
getAuditLogKey
@Nullable public AuditLogKey getAuditLogKey()
-
toString
public String toString()
- Overrides:
toString
in classEnum<ChannelField>
-
-