Enum AuditLogKey
- java.lang.Object
-
- java.lang.Enum<AuditLogKey>
-
- net.dv8tion.jda.api.audit.AuditLogKey
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<AuditLogKey>
public enum AuditLogKey extends java.lang.Enum<AuditLogKey>
Enum of possible/expected keys that can be provided toAuditLogEntry.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 notnull
!- 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)CHANNEL_BITRATE
Change of theVoiceChannel.getBitrate()
value.CHANNEL_NAME
Change of theGuildChannel.getName()
value.CHANNEL_NSFW
Change of theTextChannel.isNSFW()
value.CHANNEL_OVERRIDES
The overrides for this channel.CHANNEL_PARENT
Change of theGuildChannel.getParent()
value.CHANNEL_REGION
Change of theRegion
value.CHANNEL_SLOWMODE
Change of theTextChannel.getSlowmode()
value.CHANNEL_TOPIC
Change of theTextChannel.getTopic()
value.CHANNEL_TYPE
The integer type of this channel.CHANNEL_USER_LIMIT
Change of theVoiceChannel.getUserLimit()
value.EMOTE_NAME
Change of theEmote.getName()
value.EMOTE_ROLES_ADD
Roles added toEmote.getRoles()
with this action
Containing a list ofRole
IDs
Use withGuild.getRoleById(String)
EMOTE_ROLES_REMOVE
Roles remove fromEmote.getRoles()
with this action
Containing a list ofRole
IDs
Use withGuild.getRoleById(String)
GUILD_AFK_CHANNEL
Change of theGuild.getAfkChannel()
value represented by a VoiceChannel ID.GUILD_AFK_TIMEOUT
Change of theAFKTimeout
of a Guild.GUILD_COMMUNITY_UPDATES_CHANNEL
Change of theGuild.getCommunityUpdatesChannel()
value represented by a TextChannel ID.GUILD_EXPLICIT_CONTENT_FILTER
Change of theGuild.getExplicitContentLevel()
of a Guild.GUILD_ICON
Change of theIcon ID
of a Guild.GUILD_MFA_LEVEL
GUILD_NAME
Change for theGuild.getName()
valueGUILD_NOTIFICATION_LEVEL
Change of theGuild.getDefaultNotificationLevel()
value.GUILD_OWNER
Change of User ID for the owner of aGuild
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 theGuild.getRulesChannel()
value represented by a TextChannel ID.GUILD_SPLASH
Change of theSplash ID
of a Guild.GUILD_SYSTEM_CHANNEL
Change of theGuild.getSystemChannel()
value represented by a TextChannel ID.GUILD_VANITY_URL_CODE
Change of theGuild.getVanityCode()
value.GUILD_VERIFICATION_LEVEL
Change of theGuild.getVerificationLevel()
value.GUILD_WIDGET_CHANNEL_ID
The target channel for a widgetGUILD_WIDGET_ENABLED
Whether the guild widget is disabled or enabledID
This is sometimes visible forActionTypes
which create a new entity.INVITE_CHANNEL
Change of theInvite.getChannel()
ID for the targetInvite
Use withJDA.getTextChannelById(String)
orJDA.getVoiceChannelById(String)
INVITE_CODE
Change of theInvite.getCode()
for the targetInvite
Use withInvite.resolve(net.dv8tion.jda.api.JDA, String)
Invite.resolve(JDA, String)}INVITE_INVITER
INVITE_MAX_AGE
Change of theInvite.getMaxAge()
for the targetInvite
INVITE_MAX_USES
Change of theInvite.getMaxUses()
for the targetInvite
INVITE_TEMPORARY
Change of theInvite.isTemporary()
for the targetInvite
INVITE_USES
Change of theInvite.getUses()
for the targetInvite
MEMBER_DEAF
Change of theGuildVoiceState
of a Member.MEMBER_MUTE
Change of theGuildVoiceState
of a Member.MEMBER_NICK
Change of theMember.getNickname()
valueMEMBER_ROLES_ADD
Roles added toMember.getRoles()
with this action
Containing a list ofRole
IDs
Use withGuild.getRoleById(String)
MEMBER_ROLES_REMOVE
Roles removed fromMember.getRoles()
with this action
Containing a list ofRole
IDs
Use withGuild.getRoleById(String)
OVERRIDE_ALLOW
Modified raw allowed permission bits
Similar to the value returned byPermissionOverride.getAllowedRaw()
Use withPermission.getPermissions(long)
OVERRIDE_DENY
Modified raw denied permission bits
Similar to the value returned byPermissionOverride.getDeniedRaw()
Use withPermission.getPermissions(long)
OVERRIDE_TYPE
The string type of this override.PRIVACY_LEVEL
Change of theStageInstance.getPrivacyLevel()
value
Use withStageInstance.PrivacyLevel.fromKey(int)
ROLE_COLOR
Change of theRole.getColor()
value.ROLE_HOISTED
Change of theRole.isHoisted()
value.ROLE_MENTIONABLE
Change of theRole.isMentionable()
value.ROLE_NAME
Change of theRole.getName()
value.ROLE_PERMISSIONS
Change of theRole.getPermissionsRaw()
value.TYPE
Entity type (like channel type or webhook type)WEBHOOK_CHANNEL
WEBHOOK_ICON
Change of theWebhook.getDefaultUser()
's avatar hash of a Webhook.WEBHOOK_NAME
Change of theWebhook.getName()
value.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getKey()
java.lang.String
toString()
static AuditLogKey
valueOf(java.lang.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.
-
-
-
Enum Constant Detail
-
ID
public static final AuditLogKey ID
This is sometimes visible forActionTypes
which create a new entity.
Use with designatedgetXById
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 theGuild.getName()
valueExpected type: String
-
GUILD_OWNER
public static final AuditLogKey GUILD_OWNER
Change of User ID for the owner of aGuild
Expected type: String
-
GUILD_REGION
public static final AuditLogKey GUILD_REGION
-
GUILD_AFK_TIMEOUT
public static final AuditLogKey GUILD_AFK_TIMEOUT
-
GUILD_AFK_CHANNEL
public static final AuditLogKey GUILD_AFK_CHANNEL
Change of theGuild.getAfkChannel()
value represented by a VoiceChannel ID.
Use withGuild.getVoiceChannelById(String)
Expected type: String
-
GUILD_SYSTEM_CHANNEL
public static final AuditLogKey GUILD_SYSTEM_CHANNEL
Change of theGuild.getSystemChannel()
value represented by a TextChannel ID.
Use withGuild.getTextChannelById(String)
Expected type: String
-
GUILD_RULES_CHANNEL
public static final AuditLogKey GUILD_RULES_CHANNEL
Change of theGuild.getRulesChannel()
value represented by a TextChannel ID.
Use withGuild.getTextChannelById(String)
Expected type: String
-
GUILD_COMMUNITY_UPDATES_CHANNEL
public static final AuditLogKey GUILD_COMMUNITY_UPDATES_CHANNEL
Change of theGuild.getCommunityUpdatesChannel()
value represented by a TextChannel ID.
Use withGuild.getTextChannelById(String)
Expected type: String
-
GUILD_EXPLICIT_CONTENT_FILTER
public static final AuditLogKey GUILD_EXPLICIT_CONTENT_FILTER
Change of theGuild.getExplicitContentLevel()
of a Guild.
Use withGuild.ExplicitContentLevel.fromKey(int)
Expected type: Integer
-
GUILD_ICON
public static final AuditLogKey GUILD_ICON
Change of theIcon ID
of a Guild.Expected type: String
-
GUILD_SPLASH
public static final AuditLogKey GUILD_SPLASH
Change of theSplash ID
of a Guild.Expected type: String
-
GUILD_VERIFICATION_LEVEL
public static final AuditLogKey GUILD_VERIFICATION_LEVEL
Change of theGuild.getVerificationLevel()
value.
Use withGuild.VerificationLevel.fromKey(int)
Expected type: Integer
-
GUILD_NOTIFICATION_LEVEL
public static final AuditLogKey GUILD_NOTIFICATION_LEVEL
Change of theGuild.getDefaultNotificationLevel()
value.
Use withGuild.NotificationLevel.fromKey(int)
Expected type: Integer
-
GUILD_MFA_LEVEL
public static final AuditLogKey GUILD_MFA_LEVEL
Change of theGuild.getRequiredMFALevel()
value
Use withGuild.MFALevel.fromKey(int)
Expected type: Integer
-
GUILD_VANITY_URL_CODE
public static final AuditLogKey GUILD_VANITY_URL_CODE
Change of theGuild.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 enabledExpected type: Boolean
-
GUILD_WIDGET_CHANNEL_ID
public static final AuditLogKey GUILD_WIDGET_CHANNEL_ID
The target channel for a widgetExpected type: String
-
CHANNEL_NAME
public static final AuditLogKey CHANNEL_NAME
Change of theGuildChannel.getName()
value.Expected type: String
-
CHANNEL_PARENT
public static final AuditLogKey CHANNEL_PARENT
Change of theGuildChannel.getParent()
value.
Use withGuild.getCategoryById(String)
Expected type: String
-
CHANNEL_TOPIC
public static final AuditLogKey CHANNEL_TOPIC
-
CHANNEL_SLOWMODE
public static final AuditLogKey CHANNEL_SLOWMODE
-
CHANNEL_BITRATE
public static final AuditLogKey CHANNEL_BITRATE
-
CHANNEL_USER_LIMIT
public static final AuditLogKey CHANNEL_USER_LIMIT
-
CHANNEL_NSFW
public static final AuditLogKey CHANNEL_NSFW
-
CHANNEL_REGION
public static final AuditLogKey CHANNEL_REGION
-
CHANNEL_TYPE
public static final AuditLogKey CHANNEL_TYPE
-
CHANNEL_OVERRIDES
public static final AuditLogKey CHANNEL_OVERRIDES
The overrides for this channel.Expected type: List<Map<String, Object>>
-
PRIVACY_LEVEL
public static final AuditLogKey PRIVACY_LEVEL
Change of theStageInstance.getPrivacyLevel()
value
Use withStageInstance.PrivacyLevel.fromKey(int)
Expected type: Integer
-
MEMBER_NICK
public static final AuditLogKey MEMBER_NICK
Change of theMember.getNickname()
valueExpected type: String
-
MEMBER_MUTE
public static final AuditLogKey MEMBER_MUTE
Change of theGuildVoiceState
of a Member.
Indicating that theGuild.isGuildMuted()
value updated.Expected type: Boolean
-
MEMBER_DEAF
public static final AuditLogKey MEMBER_DEAF
Change of theGuildVoiceState
of a Member.
Indicating that theGuild.isGuildDeafened()
value updated.Expected type: Boolean
-
MEMBER_ROLES_ADD
public static final AuditLogKey MEMBER_ROLES_ADD
Roles added toMember.getRoles()
with this action
Containing a list ofRole
IDs
Use withGuild.getRoleById(String)
Expected type: List<String>
-
MEMBER_ROLES_REMOVE
public static final AuditLogKey MEMBER_ROLES_REMOVE
Roles removed fromMember.getRoles()
with this action
Containing a list ofRole
IDs
Use withGuild.getRoleById(String)
Expected type: List<String>
-
OVERRIDE_DENY
public static final AuditLogKey OVERRIDE_DENY
Modified raw denied permission bits
Similar to the value returned byPermissionOverride.getDeniedRaw()
Use withPermission.getPermissions(long)
Expected type: long
-
OVERRIDE_ALLOW
public static final AuditLogKey OVERRIDE_ALLOW
Modified raw allowed permission bits
Similar to the value returned byPermissionOverride.getAllowedRaw()
Use withPermission.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 theRole.getName()
value.Expected type: String
-
ROLE_PERMISSIONS
public static final AuditLogKey ROLE_PERMISSIONS
Change of theRole.getPermissionsRaw()
value.
Use withPermission.getPermissions(long)
Expected type: Long
-
ROLE_COLOR
public static final AuditLogKey ROLE_COLOR
-
ROLE_HOISTED
public static final AuditLogKey ROLE_HOISTED
Change of theRole.isHoisted()
value.Expected type: Boolean
-
ROLE_MENTIONABLE
public static final AuditLogKey ROLE_MENTIONABLE
Change of theRole.isMentionable()
value.Expected type: Boolean
-
EMOTE_NAME
public static final AuditLogKey EMOTE_NAME
Change of theEmote.getName()
value.Expected type: String
-
EMOTE_ROLES_ADD
public static final AuditLogKey EMOTE_ROLES_ADD
Roles added toEmote.getRoles()
with this action
Containing a list ofRole
IDs
Use withGuild.getRoleById(String)
Expected type: List<String>
-
EMOTE_ROLES_REMOVE
public static final AuditLogKey EMOTE_ROLES_REMOVE
Roles remove fromEmote.getRoles()
with this action
Containing a list ofRole
IDs
Use withGuild.getRoleById(String)
Expected type: List<String>
-
WEBHOOK_NAME
public static final AuditLogKey WEBHOOK_NAME
Change of theWebhook.getName()
value.Expected type: String
-
WEBHOOK_ICON
public static final AuditLogKey WEBHOOK_ICON
Change of theWebhook.getDefaultUser()
's avatar hash of a Webhook.
This is used to build theUser.getAvatarUrl()
!Expected type: String
-
WEBHOOK_CHANNEL
public static final AuditLogKey WEBHOOK_CHANNEL
Change of theWebhook.getChannel()
for the targetWebhook
Use withGuild.getTextChannelById(String)
Expected type: String
-
INVITE_CODE
public static final AuditLogKey INVITE_CODE
Change of theInvite.getCode()
for the targetInvite
Use withInvite.resolve(net.dv8tion.jda.api.JDA, String)
Invite.resolve(JDA, String)}Expected type: String
-
INVITE_MAX_AGE
public static final AuditLogKey INVITE_MAX_AGE
-
INVITE_TEMPORARY
public static final AuditLogKey INVITE_TEMPORARY
-
INVITE_INVITER
public static final AuditLogKey INVITE_INVITER
Change of theInvite.getInviter()
ID for the targetInvite
Use withJDA.getUserById(String)
Expected type: String
-
INVITE_CHANNEL
public static final AuditLogKey INVITE_CHANNEL
Change of theInvite.getChannel()
ID for the targetInvite
Use withJDA.getTextChannelById(String)
orJDA.getVoiceChannelById(String)
Expected type: String
-
INVITE_USES
public static final AuditLogKey INVITE_USES
-
INVITE_MAX_USES
public static final AuditLogKey INVITE_MAX_USES
-
-
Method Detail
-
values
public static AuditLogKey[] 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 (AuditLogKey c : AuditLogKey.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static AuditLogKey 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 namejava.lang.NullPointerException
- if the argument is null
-
getKey
public java.lang.String getKey()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Enum<AuditLogKey>
-
-