net.dv8tion.jda.api.audit.AuditLogEntry Maven / Gradle / Ivy
Show all versions of JDA Show documentation
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.api.audit;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.ISnowflake;
import net.dv8tion.jda.api.entities.User;
import net.dv8tion.jda.api.entities.Webhook;
import net.dv8tion.jda.api.events.guild.GuildAuditLogEntryCreateEvent;
import net.dv8tion.jda.internal.entities.GuildImpl;
import net.dv8tion.jda.internal.entities.UserImpl;
import net.dv8tion.jda.internal.entities.WebhookImpl;
import net.dv8tion.jda.internal.utils.Checks;
import net.dv8tion.jda.internal.utils.EntityString;
import org.jetbrains.annotations.Unmodifiable;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
/**
* Single entry for an {@link net.dv8tion.jda.api.requests.restaction.pagination.AuditLogPaginationAction AuditLogPaginationAction}.
*
This entry contains all options/changes and details for the action
* that was logged by the {@link net.dv8tion.jda.api.entities.Guild Guild} audit-logs.
*/
public class AuditLogEntry implements ISnowflake
{
protected final long id;
protected final long targetId;
protected final long userId;
protected final GuildImpl guild;
protected final UserImpl user;
protected final WebhookImpl webhook;
protected final String reason;
protected final Map changes;
protected final Map options;
protected final ActionType type;
protected final int rawType;
public AuditLogEntry(ActionType type, int rawType, long id, long userId, long targetId, GuildImpl guild, UserImpl user, WebhookImpl webhook,
String reason, Map changes, Map options)
{
this.type = type;
this.rawType = rawType;
this.id = id;
this.userId = userId;
this.targetId = targetId;
this.guild = guild;
this.user = user;
this.webhook = webhook;
this.reason = reason;
this.changes = changes != null && !changes.isEmpty()
? Collections.unmodifiableMap(changes)
: Collections.emptyMap();
this.options = options != null && !options.isEmpty()
? Collections.unmodifiableMap(options)
: Collections.emptyMap();
}
@Override
public long getIdLong()
{
return id;
}
/**
* The id for the target entity.
*
This references an entity based on the {@link net.dv8tion.jda.api.audit.TargetType TargetType}
* which is specified by {@link #getTargetType()}!
*
* @return The target id
*/
public long getTargetIdLong()
{
return targetId;
}
/**
* The id for the target entity.
*
This references an entity based on the {@link net.dv8tion.jda.api.audit.TargetType TargetType}
* which is specified by {@link #getTargetType()}!
*
* @return The target id
*/
@Nonnull
public String getTargetId()
{
return Long.toUnsignedString(targetId);
}
/**
* The {@link net.dv8tion.jda.api.entities.Webhook Webhook} that the target id of this audit-log entry refers to
*
* @return Possibly-null Webhook instance
*/
@Nullable
public Webhook getWebhook()
{
return webhook;
}
/**
* The {@link net.dv8tion.jda.api.entities.Guild Guild} this audit-log entry refers to
*
* @return The Guild instance
*/
@Nonnull
public Guild getGuild()
{
return guild;
}
/**
* The id for the user that executed the action.
*
* @return The user id
*/
public long getUserIdLong()
{
return userId;
}
/**
* The id for the user that executed the action.
*
* @return The user id
*/
@Nonnull
public String getUserId()
{
return Long.toUnsignedString(userId);
}
/**
* The {@link User} responsible for this action.
*
* This will not be available for {@link GuildAuditLogEntryCreateEvent}, you can use {@link #getUserIdLong()} instead.
*
* @return Possibly-null User instance
*/
@Nullable
public User getUser()
{
return user;
}
/**
* The optional reason why this action was executed.
*
* @return Possibly-null reason String
*/
@Nullable
public String getReason()
{
return reason;
}
/**
* The corresponding JDA instance of the referring Guild
*
* @return The corresponding JDA instance
*/
@Nonnull
public JDA getJDA()
{
return guild.getJDA();
}
/**
* Key-Value {@link java.util.Map Map} containing all {@link AuditLogChange
* AuditLogChanges} 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 use {@link java.util.Map#values() Map.values()}!
*
* @return Key-Value Map of changes
*/
@Nonnull
public Map getChanges()
{
return changes;
}
/**
* Shortcut to {@link #getChanges() getChanges()}.get(key) lookup!
*
This lookup is case-insensitive!
*
* @param key
* The {@link net.dv8tion.jda.api.audit.AuditLogKey AuditLogKey} to look for
*
* @return Possibly-null value corresponding to the specified key
*/
@Nullable
public AuditLogChange getChangeByKey(@Nullable final AuditLogKey key)
{
return key == null ? null : getChangeByKey(key.getKey());
}
/**
* Shortcut to {@link #getChanges() getChanges()}.get(key) lookup!
*
This lookup is case-insensitive!
*
* @param key
* The key to look for
*
* @return Possibly-null value corresponding to the specified key
*/
@Nullable
public AuditLogChange getChangeByKey(@Nullable final String key)
{
return changes.get(key);
}
/**
* Filters all changes by the specified keys
*
* @param keys
* Varargs {@link net.dv8tion.jda.api.audit.AuditLogKey AuditLogKeys} to look for
*
* @throws java.lang.IllegalArgumentException
* If provided with null array
*
* @return Possibly-empty, never-null immutable list of {@link AuditLogChange AuditLogChanges}
*/
@Nonnull
@Unmodifiable
public List getChangesForKeys(@Nonnull AuditLogKey... keys)
{
Checks.notNull(keys, "Keys");
List changes = new ArrayList<>(keys.length);
for (AuditLogKey key : keys)
{
AuditLogChange change = getChangeByKey(key);
if (change != null)
changes.add(change);
}
return Collections.unmodifiableList(changes);
}
/**
* Key-Value {@link java.util.Map Map} containing 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 use {@link java.util.Map#values() Map.values()}!
*
* Options may include secondary targets or details that do not qualify as "change".
*
An example of that would be the {@code member} option
* for {@link net.dv8tion.jda.api.audit.ActionType#CHANNEL_OVERRIDE_UPDATE CHANNEL_OVERRIDE_UPDATE}
* containing the user_id of a {@link net.dv8tion.jda.api.entities.Member Member}.
*
* @return Key-Value Map of changes
*/
@Nonnull
public Map getOptions()
{
return options;
}
/**
* Shortcut to {@link #getOptions() getOptions()}.get(name) lookup!
*
This lookup is case-insensitive!
*
* @param
* The expected type for this option
Will be used for casting
* @param name
* The field name to look for
*
* @throws java.lang.ClassCastException
* If the type-cast failed for the generic type.
*
* @return Possibly-null value corresponding to the specified key
*/
@Nullable
@SuppressWarnings("unchecked")
public T getOptionByName(@Nullable String name)
{
return (T) options.get(name);
}
/**
* Shortcut to {@link #getOptions() getOptions()}.get(name) lookup!
*
* @param
* The expected type for this option
Will be used for casting
* @param option
* The {@link net.dv8tion.jda.api.audit.AuditLogOption AuditLogOption}
*
* @throws java.lang.ClassCastException
* If the type-cast failed for the generic type.
* @throws java.lang.IllegalArgumentException
* If provided with {@code null} option.
*
* @return Possibly-null value corresponding to the specified option constant
*/
@Nullable
public T getOption(@Nonnull AuditLogOption option)
{
Checks.notNull(option, "Option");
return getOptionByName(option.getKey());
}
/**
* Constructs a filtered, immutable list of options corresponding to
* the provided {@link net.dv8tion.jda.api.audit.AuditLogOption AuditLogOptions}.
*
This will exclude options with {@code null} values!
*
* @param options
* The not-null {@link net.dv8tion.jda.api.audit.AuditLogOption AuditLogOptions}
* which will be used to gather option values via {@link #getOption(AuditLogOption) getOption(AuditLogOption)}!
*
* @throws java.lang.IllegalArgumentException
* If provided with null options
*
* @return Unmodifiable list of representative values
*/
@Nonnull
@Unmodifiable
public List