Package net.dv8tion.jda.api.audit
Enum AuditLogOption
- java.lang.Object
-
- java.lang.Enum<AuditLogOption>
-
- net.dv8tion.jda.api.audit.AuditLogOption
-
- All Implemented Interfaces:
Serializable,Comparable<AuditLogOption>
public enum AuditLogOption extends Enum<AuditLogOption>
Enum constants for possible options
Providing detailed description of possible occasions and expected types.The expected types are not guaranteed to be accurate!
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CHANNELPossible secondary target of anActionTypesuch asActionType.CHANNEL_OVERRIDE_CREATE
Use withGuild.getTextChannelById(String)or similar method forVoiceChannelsCOUNTPossible detail forActionType.MESSAGE_DELETEdescribing the amount of deleted messages.DELETE_MEMBER_DAYSPossible option ofActionType.PRUNEdescribing the period of inactivity for that prune.IDThis is sometimes visible forActionTypeswhich create a new entity.MEMBERS_REMOVEDPossible option ofActionType.PRUNEdescribing the amount of kicked members for that prune.MESSAGEPossible message id for actions of typeActionType.MESSAGE_PINandActionType.MESSAGE_UNPIN.ROLEPossible secondary target of anActionTypesuch asActionType.CHANNEL_OVERRIDE_CREATE
Use withGuild.getRoleById(String)ROLE_NAMEPossible name of the role if the target type isTargetType.ROLETYPEPossible option indicating the type of an entity.USERPossible secondary target of anActionTypesuch asActionType.CHANNEL_OVERRIDE_CREATE
Use withJDA.getUserById(String)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetKey()Key used inAuditLogEntry.getOptionByName(String)StringtoString()static AuditLogOptionvalueOf(String name)Returns 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 Detail
-
COUNT
public static final AuditLogOption COUNT
Possible detail forActionType.MESSAGE_DELETEdescribing the amount of deleted messages.Expected type: Integer
-
MESSAGE
public static final AuditLogOption MESSAGE
Possible message id for actions of typeActionType.MESSAGE_PINandActionType.MESSAGE_UNPIN.
Use withMessageChannel.retrieveMessageById(String).Expected type: String
-
CHANNEL
public static final AuditLogOption CHANNEL
Possible secondary target of anActionTypesuch asActionType.CHANNEL_OVERRIDE_CREATE
Use withGuild.getTextChannelById(String)or similar method forVoiceChannelsExpected type: String
-
USER
public static final AuditLogOption USER
Possible secondary target of anActionTypesuch asActionType.CHANNEL_OVERRIDE_CREATE
Use withJDA.getUserById(String)Expected type: String
-
ROLE
public static final AuditLogOption ROLE
Possible secondary target of anActionTypesuch asActionType.CHANNEL_OVERRIDE_CREATE
Use withGuild.getRoleById(String)Expected type: String
-
ROLE_NAME
public static final AuditLogOption ROLE_NAME
Possible name of the role if the target type isTargetType.ROLEExpected type: String
-
TYPE
public static final AuditLogOption 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
public static final AuditLogOption ID
This is sometimes visible forActionTypeswhich create a new entity.
Use with designatedgetXByIdmethod.Expected type: String
-
DELETE_MEMBER_DAYS
public static final AuditLogOption DELETE_MEMBER_DAYS
Possible option ofActionType.PRUNEdescribing the period of inactivity for that prune.Expected type: int
-
MEMBERS_REMOVED
public static final AuditLogOption MEMBERS_REMOVED
Possible option ofActionType.PRUNEdescribing the amount of kicked members for that prune.Expected type: int
-
-
Method Detail
-
values
public static AuditLogOption[] 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 (AuditLogOption c : AuditLogOption.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static AuditLogOption 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
-
getKey
public String getKey()
Key used inAuditLogEntry.getOptionByName(String)- Returns:
- Key for this option
-
toString
public String toString()
- Overrides:
toStringin classEnum<AuditLogOption>
-
-