Package net.dv8tion.jda.api.audit
Enum AuditLogOption
- All Implemented Interfaces:
Serializable,Comparable<AuditLogOption>
Enum constants for possible options
Providing detailed description of possible occasions and expected types.
Providing detailed description of possible occasions and expected types.
The expected types are not guaranteed to be accurate!
- See Also:
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionPossible secondary target of anActionTypesuch as:ActionType.MEMBER_VOICE_MOVEActionType.MESSAGE_PINActionType.MESSAGE_UNPINActionType.MESSAGE_DELETEUse withGuild.getGuildChannelById(String).Possible detail forActionType.MESSAGE_DELETEActionType.MESSAGE_BULK_DELETEActionType.MEMBER_VOICE_KICKActionType.MEMBER_VOICE_MOVEdescribing the amount of targeted entities.Possible option ofActionType.PRUNEdescribing the period of inactivity for that prune.This is sometimes visible forActionTypeswhich create a new entity.Possible option ofActionType.PRUNEdescribing the amount of kicked members for that prune.Possible message id for actions of typeActionType.MESSAGE_PINandActionType.MESSAGE_UNPIN.Possible secondary target of anActionTypesuch asActionType.CHANNEL_OVERRIDE_CREATE
Use withGuild.getRoleById(String)Possible name of the role if the target type isTargetType.ROLEPossible option indicating the type of an entity.Possible secondary target of anActionTypesuch asActionType.CHANNEL_OVERRIDE_CREATE
Use withJDA.getUserById(String) -
Method Summary
Modifier and TypeMethodDescriptiongetKey()Key used inAuditLogEntry.getOptionByName(String)toString()static AuditLogOptionReturns the enum constant of this type with the specified name.static AuditLogOption[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
COUNT
Possible detail forActionType.MESSAGE_DELETEActionType.MESSAGE_BULK_DELETEActionType.MEMBER_VOICE_KICKActionType.MEMBER_VOICE_MOVE
Use withInteger.parseInt(String).Expected type: String
-
MESSAGE
Possible message id for actions of typeActionType.MESSAGE_PINandActionType.MESSAGE_UNPIN.
Use withMessageChannel.retrieveMessageById(String).Expected type: String
-
CHANNEL
Possible secondary target of anActionTypesuch as:ActionType.MEMBER_VOICE_MOVEActionType.MESSAGE_PINActionType.MESSAGE_UNPINActionType.MESSAGE_DELETE
Guild.getGuildChannelById(String).Expected type: String
-
USER
Possible secondary target of anActionTypesuch asActionType.CHANNEL_OVERRIDE_CREATE
Use withJDA.getUserById(String)Expected type: String
-
ROLE
Possible secondary target of anActionTypesuch asActionType.CHANNEL_OVERRIDE_CREATE
Use withGuild.getRoleById(String)Expected type: String
-
ROLE_NAME
Possible name of the role if the target type isTargetType.ROLEExpected type: String
-
TYPE
Possible option indicating the type of an entity.
Maybe forActionType.CHANNEL_OVERRIDE_CREATEorActionType.CHANNEL_CREATE.Expected type: String or Integer
This type depends on the action taken place. -
ID
This is sometimes visible forActionTypeswhich create a new entity.
Use with designatedgetXByIdmethod.Expected type: String
-
DELETE_MEMBER_DAYS
Possible option ofActionType.PRUNEdescribing the period of inactivity for that prune.Expected type: int
-
MEMBERS_REMOVED
Possible option ofActionType.PRUNEdescribing the amount of kicked members for that prune.Expected type: int
-
-
Method Details
-
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
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
-
getKey
Key used inAuditLogEntry.getOptionByName(String)- Returns:
- Key for this option
-
toString
- Overrides:
toStringin classEnum<AuditLogOption>
-