net.dv8tion.jda.api.events.guild.voice.GenericGuildVoiceEvent 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.voice;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.GuildVoiceState;
import net.dv8tion.jda.api.entities.Member;
import net.dv8tion.jda.api.events.guild.GenericGuildEvent;
import javax.annotation.Nonnull;
/**
* Indicates that a {@link net.dv8tion.jda.api.entities.Guild Guild} voice event is fired.
*
Every GuildVoiceEvent is an instance of this event and can be casted.
*
* Can be used to detect any GuildVoiceEvent.
*
*
Requirements
*
*
These events require the {@link net.dv8tion.jda.api.utils.cache.CacheFlag#VOICE_STATE VOICE_STATE} CacheFlag to be enabled, which requires
* the {@link net.dv8tion.jda.api.requests.GatewayIntent#GUILD_VOICE_STATES GUILD_VOICE_STATES} intent.
*
*
{@link net.dv8tion.jda.api.JDABuilder#createLight(String) createLight(String)} disables that CacheFlag 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 specific events like these we
* need to have the old member cached to compare against.
*/
public abstract class GenericGuildVoiceEvent extends GenericGuildEvent
{
protected final Member member;
public GenericGuildVoiceEvent(@Nonnull JDA api, long responseNumber, @Nonnull Member member)
{
super(api, responseNumber, member.getGuild());
this.member = member;
}
/**
* The affected {@link net.dv8tion.jda.api.entities.Member Member}
*
* @return The affected Member
*/
@Nonnull
public Member getMember()
{
return member;
}
/**
* The {@link net.dv8tion.jda.api.entities.GuildVoiceState GuildVoiceState} of the member
*
Shortcut for {@code getMember().getVoiceState()}
*
* @return The {@link net.dv8tion.jda.api.entities.GuildVoiceState GuildVoiceState} of the member
*/
@Nonnull
public GuildVoiceState getVoiceState()
{
return member.getVoiceState();
}
}