Package net.dv8tion.jda.api.audit
Class AuditLogEntry
java.lang.Object
net.dv8tion.jda.api.audit.AuditLogEntry
- All Implemented Interfaces:
ISnowflake
Single entry for an
This entry contains all options/changes and details for the action that was logged by the
AuditLogPaginationAction.
This entry contains all options/changes and details for the action that was logged by the
Guild audit-logs.-
Constructor Summary
ConstructorsConstructorDescriptionAuditLogEntry(ActionType type, int rawType, long id, long userId, long targetId, net.dv8tion.jda.internal.entities.GuildImpl guild, net.dv8tion.jda.internal.entities.UserImpl user, net.dv8tion.jda.internal.entities.WebhookImpl webhook, String reason, Map<String, AuditLogChange> changes, Map<String, Object> options) -
Method Summary
Modifier and TypeMethodDescriptionbooleangetChangeByKey(String key) Shortcut tolookup!getChanges().get(key)
This lookup is case-insensitive!Shortcut tolookup!getChanges().get(key)
This lookup is case-insensitive!Key-ValueMapcontaining allAuditLogChangesmade in this entry.@Unmodifiable List<AuditLogChange>getChangesForKeys(AuditLogKey... keys) Filters all changes by the specified keysgetGuild()TheGuildthis audit-log entry refers tolongThe Snowflake id of this entity.getJDA()The corresponding JDA instance of the referring Guild<T> TgetOption(AuditLogOption option) Shortcut tolookup!getOptions().get(name)<T> TgetOptionByName(String name) Shortcut tolookup!getOptions().get(name)
This lookup is case-insensitive!Key-ValueMapcontaining all Options made in this entry.getOptions(AuditLogOption... options) Constructs a filtered, immutable list of options corresponding to the providedAuditLogOptions.The optional reason why this action was executed.The id for the target entity.longThe id for the target entity.TheTargetTypedefining what kind of entity was targeted by this action.getType()TheActionTypedefining what auditable Action is referred to by this entry.intThe raw type value used to derivegetType().getUser()TheUserresponsible for this action.The id for the user that executed the action.longThe id for the user that executed the action.TheWebhookthat the target id of this audit-log entry refers tointhashCode()toString()Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getTimeCreated
-
Constructor Details
-
AuditLogEntry
public AuditLogEntry(ActionType type, int rawType, long id, long userId, long targetId, net.dv8tion.jda.internal.entities.GuildImpl guild, net.dv8tion.jda.internal.entities.UserImpl user, net.dv8tion.jda.internal.entities.WebhookImpl webhook, String reason, Map<String, AuditLogChange> changes, Map<String, Object> options)
-
-
Method Details
-
getIdLong
public long getIdLong()Description copied from interface:ISnowflakeThe Snowflake id of this entity. This is unique to every entity and will never change.- Specified by:
getIdLongin interfaceISnowflake- Returns:
- Long containing the Id.
-
getTargetIdLong
public long getTargetIdLong()The id for the target entity.
This references an entity based on theTargetTypewhich is specified bygetTargetType()!- Returns:
- The target id
-
getTargetId
The id for the target entity.
This references an entity based on theTargetTypewhich is specified bygetTargetType()!- Returns:
- The target id
-
getWebhook
TheWebhookthat the target id of this audit-log entry refers to- Returns:
- Possibly-null Webhook instance
-
getGuild
TheGuildthis audit-log entry refers to- Returns:
- The Guild instance
-
getUserIdLong
public long getUserIdLong()The id for the user that executed the action.- Returns:
- The user id
-
getUserId
The id for the user that executed the action.- Returns:
- The user id
-
getUser
TheUserresponsible for this action.This will not be available for
GuildAuditLogEntryCreateEvent, you can usegetUserIdLong()instead.- Returns:
- Possibly-null User instance
-
getReason
The optional reason why this action was executed.- Returns:
- Possibly-null reason String
-
getJDA
The corresponding JDA instance of the referring Guild- Returns:
- The corresponding JDA instance
-
getChanges
Key-ValueMapcontaining allAuditLogChangesmade in this entry. The keys for the returned map are case-insensitive keys defined in the regarding AuditLogChange value.
To iterate only the changes you can useMap.values()!- Returns:
- Key-Value Map of changes
-
getChangeByKey
Shortcut tolookup!getChanges().get(key)
This lookup is case-insensitive!- Parameters:
key- TheAuditLogKeyto look for- Returns:
- Possibly-null value corresponding to the specified key
-
getChangeByKey
Shortcut tolookup!getChanges().get(key)
This lookup is case-insensitive!- Parameters:
key- The key to look for- Returns:
- Possibly-null value corresponding to the specified key
-
getChangesForKeys
Filters all changes by the specified keys- Parameters:
keys- VarargsAuditLogKeysto look for- Returns:
- Possibly-empty, never-null immutable list of
AuditLogChanges - Throws:
IllegalArgumentException- If provided with null array
-
getOptions
Key-ValueMapcontaining all Options made in this entry. The keys for the returned map are case-insensitive keys defined in the regarding AuditLogChange value.
To iterate only the changes you can useMap.values()!Options may include secondary targets or details that do not qualify as "change".
An example of that would be thememberoption forCHANNEL_OVERRIDE_UPDATEcontaining the user_id of aMember.- Returns:
- Key-Value Map of changes
-
getOptionByName
Shortcut tolookup!getOptions().get(name)
This lookup is case-insensitive!- Type Parameters:
T- The expected type for this option
Will be used for casting- Parameters:
name- The field name to look for- Returns:
- Possibly-null value corresponding to the specified key
- Throws:
ClassCastException- If the type-cast failed for the generic type.
-
getOption
Shortcut tolookup!getOptions().get(name)- Type Parameters:
T- The expected type for this option
Will be used for casting- Parameters:
option- TheAuditLogOption- Returns:
- Possibly-null value corresponding to the specified option constant
- Throws:
ClassCastException- If the type-cast failed for the generic type.IllegalArgumentException- If provided withnulloption.
-
getOptions
Constructs a filtered, immutable list of options corresponding to the providedAuditLogOptions.
This will exclude options withnullvalues!- Parameters:
options- The not-nullAuditLogOptionswhich will be used to gather option values viagetOption(AuditLogOption)!- Returns:
- Unmodifiable list of representative values
- Throws:
IllegalArgumentException- If provided with null options
-
getType
TheActionTypedefining what auditable Action is referred to by this entry.- Returns:
- The
ActionType
-
getTypeRaw
public int getTypeRaw()The raw type value used to derivegetType().
This can be used when a new action type is not yet supported by JDA.- Returns:
- The raw type value
-
getTargetType
TheTargetTypedefining what kind of entity was targeted by this action.
Shortcut forgetType().getTargetType()- Returns:
- The
TargetType
-
hashCode
public int hashCode() -
equals
-
toString
-