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!

See Also:

Optional Audit Entry Info

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHANNEL	Possible secondary target of an ActionType such as: ActionType.MEMBER_VOICE_MOVE ActionType.MESSAGE_PIN ActionType.MESSAGE_UNPIN ActionType.MESSAGE_DELETE Use with Guild.getGuildChannelById(String).
COUNT	Possible detail for ActionType.MESSAGE_DELETE ActionType.MESSAGE_BULK_DELETE ActionType.MEMBER_VOICE_KICK ActionType.MEMBER_VOICE_MOVE describing the amount of targeted entities.
DELETE_MEMBER_DAYS	Possible option of ActionType.PRUNE describing the period of inactivity for that prune.
ID	This is sometimes visible for ActionTypes which create a new entity.
MEMBERS_REMOVED	Possible option of ActionType.PRUNE describing the amount of kicked members for that prune.
MESSAGE	Possible message id for actions of type ActionType.MESSAGE_PIN and ActionType.MESSAGE_UNPIN.
ROLE	Possible secondary target of an ActionType such as ActionType.CHANNEL_OVERRIDE_CREATE Use with Guild.getRoleById(String)
ROLE_NAME	Possible name of the role if the target type is TargetType.ROLE
TYPE	Possible option indicating the type of an entity.
USER	Possible secondary target of an ActionType such as ActionType.CHANNEL_OVERRIDE_CREATE Use with JDA.getUserById(String)

Method Summary

Modifier and Type	Method	Description
String	getKey()	Key used in AuditLogEntry.getOptionByName(String)
String	toString()
static AuditLogOption	valueOf(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.

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 Detail

COUNT

public static final AuditLogOption COUNT

Possible detail for

• ActionType.MESSAGE_DELETE
• ActionType.MESSAGE_BULK_DELETE
• ActionType.MEMBER_VOICE_KICK
• ActionType.MEMBER_VOICE_MOVE

describing the amount of targeted entities.
Use with Integer.parseInt(String).

Expected type: String

MESSAGE

public static final AuditLogOption MESSAGE

Possible message id for actions of type ActionType.MESSAGE_PIN and ActionType.MESSAGE_UNPIN.
Use with MessageChannel.retrieveMessageById(String).

Expected type: String

CHANNEL

public static final AuditLogOption CHANNEL

Possible secondary target of an ActionType such as:

• ActionType.MEMBER_VOICE_MOVE
• ActionType.MESSAGE_PIN
• ActionType.MESSAGE_UNPIN
• ActionType.MESSAGE_DELETE

Use with Guild.getGuildChannelById(String).

Expected type: String

USER

public static final AuditLogOption USER

Possible secondary target of an ActionType such as ActionType.CHANNEL_OVERRIDE_CREATE
Use with JDA.getUserById(String)

Expected type: String

ROLE

public static final AuditLogOption ROLE

Possible secondary target of an ActionType such as ActionType.CHANNEL_OVERRIDE_CREATE
Use with Guild.getRoleById(String)

Expected type: String

ROLE_NAME

public static final AuditLogOption ROLE_NAME

Possible name of the role if the target type is TargetType.ROLE

Expected type: String

TYPE

public static final AuditLogOption TYPE

Possible option indicating the type of an entity.
Maybe for ActionType.CHANNEL_OVERRIDE_CREATE or ActionType.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 for ActionTypes which create a new entity.
Use with designated getXById method.

Expected type: String

DELETE_MEMBER_DAYS

public static final AuditLogOption DELETE_MEMBER_DAYS

Possible option of ActionType.PRUNE describing the period of inactivity for that prune.

Expected type: int

MEMBERS_REMOVED

public static final AuditLogOption MEMBERS_REMOVED

Possible option of ActionType.PRUNE describing 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 name

NullPointerException - if the argument is null

getKey

public String getKey()

Key used in AuditLogEntry.getOptionByName(String)

Returns:

Key for this option

toString

public String toString()

Overrides:

toString in class Enum<AuditLogOption>