Package net.dv8tion.jda.api.audit

Enum AuditLogKey

java.lang.Object

java.lang.Enum<AuditLogKey>

net.dv8tion.jda.api.audit.AuditLogKey

All Implemented Interfaces:

Serializable, Comparable<AuditLogKey>

public enum AuditLogKey
extends Enum<AuditLogKey>

Enum of possible/expected keys that can be provided to AuditLogEntry.getChangeByKey(AuditLogEntry.AuditLogKey.

Each constant in this enum has elaborate documentation on expected values for the returned AuditLogChange.
There is no guarantee that the resulting type is accurate or that the value selected is not null!

See Also:

• Audit Log Change Key

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPLICATION_ID	The id for an authorized application (webhook/bot/integration)
AUTO_MODERATION_RULE_NAME	Change of the AutoModRule.getName() for the target AutoModRule
AUTO_MODERATION_RULE_TRIGGER_TYPE	The AutoModRule.getTriggerType() for an AutoModRule trigger
CHANNEL_AVAILABLE_TAGS	The available tags of this ForumChannel.
CHANNEL_BITRATE	Change of the VoiceChannel.getBitrate() value.
CHANNEL_DEFAULT_REACTION_EMOJI	Change of the IPostContainer.getDefaultReaction() value.
CHANNEL_DEFAULT_SORT_ORDER	The IPostContainer.getDefaultSortOrder() value.
CHANNEL_DEFAULT_THREAD_SLOWMODE	Change of the IThreadContainer.getDefaultThreadSlowmode() value.
CHANNEL_FLAGS	Change of the flags value.
CHANNEL_ID	The relevant channel for the audit log entry.
CHANNEL_NAME	Change of the GuildChannel.getName() value.
CHANNEL_NSFW	Change of the IAgeRestrictedChannel.isNSFW() value.
CHANNEL_OVERRIDES	The overrides for this channel.
CHANNEL_PARENT	Change of the ICategorizableChannel.getParentCategory() ICategorizable.getParentCategory()} value.
CHANNEL_REGION	Change of the Region value.
CHANNEL_SLOWMODE	Change of the ISlowmodeChannel.getSlowmode() value.
CHANNEL_TOPIC	Change of the TextChannel.getTopic() value.
CHANNEL_TYPE	The integer type of this channel.
CHANNEL_USER_LIMIT	Change of the VoiceChannel.getUserLimit() value.
CHANNEL_VOICE_STATUS	Change of the VoiceChannel.getStatus() value.
DEFAULT_FORUM_LAYOUT	The ForumChannel.getDefaultLayout() value.
EMOJI_NAME	Change of the Emoji.getName() value.
EMOJI_ROLES_ADD	Roles added to RichCustomEmoji.getRoles() with this action Containing a list of Role IDs Use with Guild.getRoleById(String)
EMOJI_ROLES_REMOVE	Roles remove from RichCustomEmoji.getRoles() with this action Containing a list of Role IDs Use with Guild.getRoleById(String)
GUILD_AFK_CHANNEL	Change of the Guild.getAfkChannel() value represented by a VoiceChannel ID.
GUILD_AFK_TIMEOUT	Change of the AFKTimeout of a Guild.
GUILD_COMMUNITY_UPDATES_CHANNEL	Change of the Guild.getCommunityUpdatesChannel() value represented by a TextChannel ID.
GUILD_EXPLICIT_CONTENT_FILTER	Change of the Guild.getExplicitContentLevel() of a Guild.
GUILD_ICON	Change of the Icon ID of a Guild.
GUILD_MFA_LEVEL	Change of the Guild.getRequiredMFALevel() value Use with Guild.MFALevel.fromKey(int)
GUILD_NAME	Change for the Guild.getName() value
GUILD_NOTIFICATION_LEVEL	Change of the Guild.getDefaultNotificationLevel() value.
GUILD_OWNER	Change of User ID for the owner of a Guild
GUILD_PRUNE_DELETE_DAYS	Days of inactivity for a prune event.
GUILD_REGION	Change of region represented by a key.
GUILD_RULES_CHANNEL	Change of the Guild.getRulesChannel() value represented by a TextChannel ID.
GUILD_SPLASH	Change of the Splash ID of a Guild.
GUILD_SYSTEM_CHANNEL	Change of the Guild.getSystemChannel() value represented by a TextChannel ID.
GUILD_VANITY_URL_CODE	Change of the Guild.getVanityCode() value.
GUILD_VERIFICATION_LEVEL	Change of the Guild.getVerificationLevel() value.
GUILD_WIDGET_CHANNEL_ID	The target channel for a widget
GUILD_WIDGET_ENABLED	Whether the guild widget is disabled or enabled
ID	This is sometimes visible for ActionTypes which create a new entity.
INVITE_CHANNEL	Change of the Invite.getChannel() ID for the target Invite Use with JDA.getTextChannelById(String) or JDA.getVoiceChannelById(String)
INVITE_CODE	Change of the Invite.getCode() for the target Invite Use with Invite.resolve(net.dv8tion.jda.api.JDA, String) Invite.resolve(JDA, String)}
INVITE_INVITER	Change of the Invite.getInviter() ID for the target Invite Use with JDA.getUserById(String)
INVITE_MAX_AGE	Change of the Invite.getMaxAge() for the target Invite
INVITE_MAX_USES	Change of the Invite.getMaxUses() for the target Invite
INVITE_TEMPORARY	Change of the Invite.isTemporary() for the target Invite
INVITE_USES	Change of the Invite.getUses() for the target Invite
MEMBER_DEAF	Change of the GuildVoiceState of a Member.
MEMBER_MUTE	Change of the GuildVoiceState of a Member.
MEMBER_NICK	Change of the Member.getNickname() value
MEMBER_ROLES_ADD	Roles added to Member.getRoles() with this action Containing a list of Role IDs Use with Guild.getRoleById(String)
MEMBER_ROLES_REMOVE	Roles removed from Member.getRoles() with this action Containing a list of Role IDs Use with Guild.getRoleById(String)
MEMBER_TIME_OUT	Change of the Time out of a Member.
OVERRIDE_ALLOW	Modified raw allowed permission bits Similar to the value returned by PermissionOverride.getAllowedRaw() Use with Permission.getPermissions(long)
OVERRIDE_DENY	Modified raw denied permission bits Similar to the value returned by PermissionOverride.getDeniedRaw() Use with Permission.getPermissions(long)
OVERRIDE_TYPE	The string type of this override.
PRIVACY_LEVEL	Change of the StageInstance.getPrivacyLevel() value Use with StageInstance.PrivacyLevel.fromKey(int)
ROLE_COLOR	Change of the Role.getColor() value.
ROLE_HOISTED	Change of the Role.isHoisted() value.
ROLE_MENTIONABLE	Change of the Role.isMentionable() value.
ROLE_NAME	Change of the Role.getName() value.
ROLE_PERMISSIONS	Change of the Role.getPermissionsRaw() value.
STICKER_DESCRIPTION	Change of the Sticker.getDescription() value.
STICKER_FORMAT	Change of the Sticker.getFormatType() value.
STICKER_NAME	Change of the Sticker.getName() value.
STICKER_TAGS	Change of the Sticker.getTags() value.
THREAD_APPLIED_TAGS	The applied tags of this ThreadChannel, given that it is a forum post.
THREAD_ARCHIVED	Change of the ThreadChannel.isArchived() value.
THREAD_AUTO_ARCHIVE_DURATION	Change of the ThreadChannel.getAutoArchiveDuration() value.
THREAD_INVITABLE	Change of the ThreadChannel.isInvitable() value.
THREAD_LOCKED	Change of the ThreadChannel.isLocked() value.
THREAD_NAME	Change of the ThreadChannel.getName() value.
TYPE	Entity type (like channel type or webhook type)
WEBHOOK_CHANNEL	Change of the Webhook.getChannel() for the target Webhook Use with Guild.getTextChannelById(String)
WEBHOOK_ICON	Change of the Webhook.getDefaultUser()'s avatar hash of a Webhook.
WEBHOOK_NAME	Change of the Webhook.getName() value.

Method Summary

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

ID

public static final AuditLogKey ID

This is sometimes visible for ActionTypes which create a new entity.
Use with designated getXById method.

Expected type: String

TYPE

public static final AuditLogKey TYPE

Entity type (like channel type or webhook type)

Expected type: String or int

APPLICATION_ID

public static final AuditLogKey APPLICATION_ID

The id for an authorized application (webhook/bot/integration)

Expected type: String

GUILD_NAME

public static final AuditLogKey GUILD_NAME

Change for the Guild.getName() value

Expected type: String

GUILD_OWNER

public static final AuditLogKey GUILD_OWNER

Change of User ID for the owner of a Guild

Expected type: String

GUILD_REGION

public static final AuditLogKey GUILD_REGION

Change of region represented by a key.
Use with Region.fromKey(String)

Expected type: String

GUILD_AFK_TIMEOUT

public static final AuditLogKey GUILD_AFK_TIMEOUT

Change of the AFKTimeout of a Guild.
Use with Timeout.fromKey(int)

Expected type: Integer

GUILD_AFK_CHANNEL

public static final AuditLogKey GUILD_AFK_CHANNEL

Change of the Guild.getAfkChannel() value represented by a VoiceChannel ID.
Use with Guild.getVoiceChannelById(String)

Expected type: String

GUILD_SYSTEM_CHANNEL

public static final AuditLogKey GUILD_SYSTEM_CHANNEL

Change of the Guild.getSystemChannel() value represented by a TextChannel ID.
Use with Guild.getTextChannelById(String)

Expected type: String

GUILD_RULES_CHANNEL

public static final AuditLogKey GUILD_RULES_CHANNEL

Change of the Guild.getRulesChannel() value represented by a TextChannel ID.
Use with Guild.getTextChannelById(String)

Expected type: String

GUILD_COMMUNITY_UPDATES_CHANNEL

public static final AuditLogKey GUILD_COMMUNITY_UPDATES_CHANNEL

Change of the Guild.getCommunityUpdatesChannel() value represented by a TextChannel ID.
Use with Guild.getTextChannelById(String)

Expected type: String

GUILD_EXPLICIT_CONTENT_FILTER

public static final AuditLogKey GUILD_EXPLICIT_CONTENT_FILTER

Change of the Guild.getExplicitContentLevel() of a Guild.
Use with Guild.ExplicitContentLevel.fromKey(int)

Expected type: Integer

GUILD_ICON

public static final AuditLogKey GUILD_ICON

Change of the Icon ID of a Guild.

Expected type: String

GUILD_SPLASH

public static final AuditLogKey GUILD_SPLASH

Change of the Splash ID of a Guild.

Expected type: String

GUILD_VERIFICATION_LEVEL

public static final AuditLogKey GUILD_VERIFICATION_LEVEL

Change of the Guild.getVerificationLevel() value.
Use with Guild.VerificationLevel.fromKey(int)

Expected type: Integer

GUILD_NOTIFICATION_LEVEL

public static final AuditLogKey GUILD_NOTIFICATION_LEVEL

Change of the Guild.getDefaultNotificationLevel() value.
Use with Guild.NotificationLevel.fromKey(int)

Expected type: Integer

GUILD_MFA_LEVEL

public static final AuditLogKey GUILD_MFA_LEVEL

Change of the Guild.getRequiredMFALevel() value
Use with Guild.MFALevel.fromKey(int)

Expected type: Integer

GUILD_VANITY_URL_CODE

public static final AuditLogKey GUILD_VANITY_URL_CODE

Change of the Guild.getVanityCode() value.

Expected type: String

GUILD_PRUNE_DELETE_DAYS

public static final AuditLogKey GUILD_PRUNE_DELETE_DAYS

Days of inactivity for a prune event.

Expected type: Integer

GUILD_WIDGET_ENABLED

public static final AuditLogKey GUILD_WIDGET_ENABLED

Whether the guild widget is disabled or enabled

Expected type: Boolean

GUILD_WIDGET_CHANNEL_ID

public static final AuditLogKey GUILD_WIDGET_CHANNEL_ID

The target channel for a widget

Expected type: String

CHANNEL_NAME

public static final AuditLogKey CHANNEL_NAME

Change of the GuildChannel.getName() value.

Expected type: String

CHANNEL_FLAGS

public static final AuditLogKey CHANNEL_FLAGS

Change of the flags value.

Expected type: Integer

CHANNEL_PARENT

public static final AuditLogKey CHANNEL_PARENT

Change of the ICategorizableChannel.getParentCategory() ICategorizable.getParentCategory()} value.
Use with Guild.getCategoryById(String)

Expected type: String

CHANNEL_TOPIC

public static final AuditLogKey CHANNEL_TOPIC

Change of the TextChannel.getTopic() value.
Only for ChannelType.TEXT

Expected type: String

CHANNEL_VOICE_STATUS

public static final AuditLogKey CHANNEL_VOICE_STATUS

Change of the VoiceChannel.getStatus() value.
Only for ChannelType.VOICE

Expected type: String

CHANNEL_SLOWMODE

public static final AuditLogKey CHANNEL_SLOWMODE

Change of the ISlowmodeChannel.getSlowmode() value.

Expected type: Integer

CHANNEL_DEFAULT_THREAD_SLOWMODE

public static final AuditLogKey CHANNEL_DEFAULT_THREAD_SLOWMODE

Change of the IThreadContainer.getDefaultThreadSlowmode() value.

Expected type: Integer

CHANNEL_DEFAULT_REACTION_EMOJI

public static final AuditLogKey CHANNEL_DEFAULT_REACTION_EMOJI

Change of the IPostContainer.getDefaultReaction() value.

Expected type: Map containing emoji_id and emoji_name

CHANNEL_BITRATE

public static final AuditLogKey CHANNEL_BITRATE

Change of the VoiceChannel.getBitrate() value.
Only for ChannelType.VOICE

Expected type: Integer

CHANNEL_USER_LIMIT

public static final AuditLogKey CHANNEL_USER_LIMIT

Change of the VoiceChannel.getUserLimit() value.
Only for ChannelType.VOICE

Expected type: Integer

CHANNEL_NSFW

public static final AuditLogKey CHANNEL_NSFW

Change of the IAgeRestrictedChannel.isNSFW() value.

Expected type: Boolean

CHANNEL_REGION

public static final AuditLogKey CHANNEL_REGION

Change of the Region value.
Only for ChannelType.VOICE and ChannelType.STAGE

Expected type: String

CHANNEL_TYPE

public static final AuditLogKey CHANNEL_TYPE

The integer type of this channel.
Use with ChannelType.fromId(int).

Expected type: int

CHANNEL_OVERRIDES

public static final AuditLogKey CHANNEL_OVERRIDES

The overrides for this channel.

Expected type: List<Map<String, Object>>

CHANNEL_AVAILABLE_TAGS

public static final AuditLogKey CHANNEL_AVAILABLE_TAGS

The available tags of this ForumChannel.

Expected type: List<Map<String, Object>>

CHANNEL_ID

public static final AuditLogKey CHANNEL_ID

The relevant channel for the audit log entry.

Expected type: String

CHANNEL_DEFAULT_SORT_ORDER

public static final AuditLogKey CHANNEL_DEFAULT_SORT_ORDER

The IPostContainer.getDefaultSortOrder() value.
Only for ChannelType.FORUM and ChannelType.MEDIA.

Expected type: Integer

DEFAULT_FORUM_LAYOUT

public static final AuditLogKey DEFAULT_FORUM_LAYOUT

The ForumChannel.getDefaultLayout() value.
Only for ChannelType.FORUM.

Expected type: Integer

THREAD_NAME

public static final AuditLogKey THREAD_NAME

Change of the ThreadChannel.getName() value.

Expected type: String

THREAD_AUTO_ARCHIVE_DURATION

public static final AuditLogKey THREAD_AUTO_ARCHIVE_DURATION

Change of the ThreadChannel.getAutoArchiveDuration() value.

Expected type: Integer

THREAD_ARCHIVED

public static final AuditLogKey THREAD_ARCHIVED

Change of the ThreadChannel.isArchived() value.

Expected type: Boolean

THREAD_LOCKED

public static final AuditLogKey THREAD_LOCKED

Change of the ThreadChannel.isLocked() value.

Expected type: Boolean

THREAD_INVITABLE

public static final AuditLogKey THREAD_INVITABLE

Change of the ThreadChannel.isInvitable() value. This can only be set/modified on a private thread.

Expected type: Boolean

THREAD_APPLIED_TAGS

public static final AuditLogKey THREAD_APPLIED_TAGS

The applied tags of this ThreadChannel, given that it is a forum post.

Expected type: List<String>

PRIVACY_LEVEL

public static final AuditLogKey PRIVACY_LEVEL

Change of the StageInstance.getPrivacyLevel() value
Use with StageInstance.PrivacyLevel.fromKey(int)

Expected type: Integer

MEMBER_NICK

public static final AuditLogKey MEMBER_NICK

Change of the Member.getNickname() value

Expected type: String

MEMBER_MUTE

public static final AuditLogKey MEMBER_MUTE

Change of the GuildVoiceState of a Member.
Indicating that the Guild.isGuildMuted() value updated.

Expected type: Boolean

MEMBER_DEAF

public static final AuditLogKey MEMBER_DEAF

Change of the GuildVoiceState of a Member.
Indicating that the Guild.isGuildDeafened() value updated.

Expected type: Boolean

MEMBER_ROLES_ADD

public static final AuditLogKey MEMBER_ROLES_ADD

Roles added to Member.getRoles() with this action
Containing a list of Role IDs
Use with Guild.getRoleById(String)

Expected type: List<String>

MEMBER_ROLES_REMOVE

public static final AuditLogKey MEMBER_ROLES_REMOVE

Roles removed from Member.getRoles() with this action
Containing a list of Role IDs
Use with Guild.getRoleById(String)

Expected type: List<String>

MEMBER_TIME_OUT

public static final AuditLogKey MEMBER_TIME_OUT

Change of the Time out of a Member.
Indicating that the Member.getTimeOutEnd() value updated.
This is provided as an ISO8601 Date-Time string.

Expected type: String

OVERRIDE_DENY

public static final AuditLogKey OVERRIDE_DENY

Modified raw denied permission bits
Similar to the value returned by PermissionOverride.getDeniedRaw()
Use with Permission.getPermissions(long)

Expected type: long

OVERRIDE_ALLOW

public static final AuditLogKey OVERRIDE_ALLOW

Modified raw allowed permission bits
Similar to the value returned by PermissionOverride.getAllowedRaw()
Use with Permission.getPermissions(long)

Expected type: long

OVERRIDE_TYPE

public static final AuditLogKey OVERRIDE_TYPE

The string type of this override.
"role" or "member".

Expected type: String

ROLE_NAME

public static final AuditLogKey ROLE_NAME

Change of the Role.getName() value.

Expected type: String

ROLE_PERMISSIONS

public static final AuditLogKey ROLE_PERMISSIONS

Change of the Role.getPermissionsRaw() value.
Use with Permission.getPermissions(long)

Expected type: Long

ROLE_COLOR

public static final AuditLogKey ROLE_COLOR

Change of the Role.getColor() value.
Use with Color(int)

Expected type: Integer

ROLE_HOISTED

public static final AuditLogKey ROLE_HOISTED

Change of the Role.isHoisted() value.

Expected type: Boolean

ROLE_MENTIONABLE

public static final AuditLogKey ROLE_MENTIONABLE

Change of the Role.isMentionable() value.

Expected type: Boolean

EMOJI_NAME

public static final AuditLogKey EMOJI_NAME

Change of the Emoji.getName() value.

Expected type: String

EMOJI_ROLES_ADD

public static final AuditLogKey EMOJI_ROLES_ADD

Roles added to RichCustomEmoji.getRoles() with this action
Containing a list of Role IDs
Use with Guild.getRoleById(String)

Expected type: List<String>

EMOJI_ROLES_REMOVE

public static final AuditLogKey EMOJI_ROLES_REMOVE

Roles remove from RichCustomEmoji.getRoles() with this action
Containing a list of Role IDs
Use with Guild.getRoleById(String)

Expected type: List<String>

STICKER_NAME

public static final AuditLogKey STICKER_NAME

Change of the Sticker.getName() value.

Expected type: String

STICKER_FORMAT

public static final AuditLogKey STICKER_FORMAT

Change of the Sticker.getFormatType() value.

Expected type: String

STICKER_DESCRIPTION

public static final AuditLogKey STICKER_DESCRIPTION

Change of the Sticker.getDescription() value.

Expected type: String

STICKER_TAGS

public static final AuditLogKey STICKER_TAGS

Change of the Sticker.getTags() value.

Expected type: String

WEBHOOK_NAME

public static final AuditLogKey WEBHOOK_NAME

Change of the Webhook.getName() value.

Expected type: String

WEBHOOK_ICON

public static final AuditLogKey WEBHOOK_ICON

Change of the Webhook.getDefaultUser()'s avatar hash of a Webhook.
This is used to build the User.getAvatarUrl()!

Expected type: String

WEBHOOK_CHANNEL

public static final AuditLogKey WEBHOOK_CHANNEL

Change of the Webhook.getChannel() for the target Webhook
Use with Guild.getTextChannelById(String)

Expected type: String

INVITE_CODE

public static final AuditLogKey INVITE_CODE

Change of the Invite.getCode() for the target Invite
Use with Invite.resolve(net.dv8tion.jda.api.JDA, String) Invite.resolve(JDA, String)}

Expected type: String

INVITE_MAX_AGE

public static final AuditLogKey INVITE_MAX_AGE

Change of the Invite.getMaxAge() for the target Invite

Expected type: int

INVITE_TEMPORARY

public static final AuditLogKey INVITE_TEMPORARY

Change of the Invite.isTemporary() for the target Invite

Expected type: boolean

INVITE_INVITER

public static final AuditLogKey INVITE_INVITER

Change of the Invite.getInviter() ID for the target Invite
Use with JDA.getUserById(String)

Expected type: String

INVITE_CHANNEL

public static final AuditLogKey INVITE_CHANNEL

Change of the Invite.getChannel() ID for the target Invite
Use with JDA.getTextChannelById(String) or JDA.getVoiceChannelById(String)

Expected type: String

INVITE_USES

public static final AuditLogKey INVITE_USES

Change of the Invite.getUses() for the target Invite

Expected type: int

INVITE_MAX_USES

public static final AuditLogKey INVITE_MAX_USES

Change of the Invite.getMaxUses() for the target Invite

Expected type: int

AUTO_MODERATION_RULE_NAME

public static final AuditLogKey AUTO_MODERATION_RULE_NAME

Change of the AutoModRule.getName() for the target AutoModRule

Expected type: String

AUTO_MODERATION_RULE_TRIGGER_TYPE

public static final AuditLogKey AUTO_MODERATION_RULE_TRIGGER_TYPE

The AutoModRule.getTriggerType() for an AutoModRule trigger

Use with AutoModTriggerType.fromKey(int)

Expected type: int

Method Details

values

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

getKey

@Nonnull
public String getKey()

toString

@Nonnull
public String toString()

Overrides:

toString in class Enum<AuditLogKey>