net.dv8tion.jda.api.events.guild.member.GenericGuildMemberEvent 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;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.Member;
import net.dv8tion.jda.api.entities.User;
import net.dv8tion.jda.api.events.guild.GenericGuildEvent;
import javax.annotation.Nonnull;
/**
* Indicates that a {@link net.dv8tion.jda.api.entities.Guild Guild} member event is fired.
*
Every GuildMemberEvent is an instance of this event and can be casted.
*
* Most of 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!
*
*
Can be used to detect any GuildMemberEvent.
*/
public abstract class GenericGuildMemberEvent extends GenericGuildEvent
{
private final Member member;
public GenericGuildMemberEvent(@Nonnull JDA api, long responseNumber, @Nonnull Member member)
{
super(api, responseNumber, member.getGuild());
this.member = member;
}
/**
* The {@link net.dv8tion.jda.api.entities.User User} instance
*
Shortcut for {@code getMember().getUser()}
*
* @return The User instance
*/
@Nonnull
public User getUser()
{
return getMember().getUser();
}
/**
* The {@link net.dv8tion.jda.api.entities.Member Member} instance
*
* @return The Member instance
*/
@Nonnull
public Member getMember()
{
return member;
}
}