net.dv8tion.jda.api.events.guild.member.update.GenericGuildMemberUpdateEvent 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.events.guild.member.update;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.Member;
import net.dv8tion.jda.api.events.UpdateEvent;
import net.dv8tion.jda.api.events.guild.member.GenericGuildMemberEvent;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/**
* Indicates that a {@link net.dv8tion.jda.api.entities.Guild Guild} member event is fired.
*
Every GuildMemberUpdateEvent is an instance of this event and can be casted.
*
* Can be used to detect any GuildMemberUpdateEvent.
*
*
Requirements
*
*
These events require the {@link net.dv8tion.jda.api.requests.GatewayIntent#GUILD_MEMBERS GUILD_MEMBERS} intent to be enabled.
*
{@link net.dv8tion.jda.api.JDABuilder#createDefault(String) createDefault(String)} and
* {@link net.dv8tion.jda.api.JDABuilder#createLight(String) createLight(String)} disable this by default!
*
*
Additionally, these events require the {@link net.dv8tion.jda.api.utils.MemberCachePolicy MemberCachePolicy}
* to cache the updated members. Discord does not specifically tell us about the updates, but merely tells us the
* member was updated and gives us the updated member object. In order to fire a specific event like this we
* need to have the old member cached to compare against.
*/
public abstract class GenericGuildMemberUpdateEvent extends GenericGuildMemberEvent implements UpdateEvent
{
protected final T previous;
protected final T next;
protected final String identifier;
public GenericGuildMemberUpdateEvent(
@Nonnull JDA api, long responseNumber, @Nonnull Member member,
@Nullable T previous, @Nullable T next, @Nonnull String identifier)
{
super(api, responseNumber, member);
this.previous = previous;
this.next = next;
this.identifier = identifier;
}
@Nonnull
@Override
public String getPropertyIdentifier()
{
return identifier;
}
@Nonnull
@Override
public Member getEntity()
{
return getMember();
}
@Nullable
@Override
public T getOldValue()
{
return previous;
}
@Nullable
@Override
public T getNewValue()
{
return next;
}
}