Package net.dv8tion.jda.api.events.guild.voice

Class GuildVoiceLeaveEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.guild.GenericGuildEvent

net.dv8tion.jda.api.events.guild.voice.GenericGuildVoiceEvent

net.dv8tion.jda.api.events.guild.voice.GenericGuildVoiceUpdateEvent

net.dv8tion.jda.api.events.guild.voice.GuildVoiceLeaveEvent

All Implemented Interfaces:

GenericEvent, GuildVoiceUpdateEvent, UpdateEvent<Member,VoiceChannel>

public class GuildVoiceLeaveEvent
extends GenericGuildVoiceUpdateEvent

Indicates that a Member disconnected from a VoiceChannel.

When the Member is moved a GuildVoiceMoveEvent is fired instead

Can be used to detect when a member leaves a voice channel completely.

Requirements

This event requires the VOICE_STATE CacheFlag to be enabled, which requires the GUILD_VOICE_STATES intent.
createLight(String) disables that CacheFlag by default!

Additionally, this event requires the 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.

See Also:

GuildVoiceUpdateEvent

Field Summary

Fields inherited from interface net.dv8tion.jda.api.events.guild.voice.GuildVoiceUpdateEvent

IDENTIFIER

Constructor Summary

Constructors

Constructor	Description
GuildVoiceLeaveEvent(JDA api, long responseNumber, Member member, VoiceChannel channelLeft)

Method Summary

Modifier and Type	Method	Description
VoiceChannel	getChannelLeft()	The VoiceChannel that the Member is moved from
VoiceChannel	getOldValue()	The old value

Methods inherited from class net.dv8tion.jda.api.events.guild.voice.GenericGuildVoiceUpdateEvent

getChannelJoined, getEntity, getNewValue, getPropertyIdentifier, toString

Methods inherited from class net.dv8tion.jda.api.events.guild.voice.GenericGuildVoiceEvent

getMember, getVoiceState

Methods inherited from class net.dv8tion.jda.api.events.guild.GenericGuildEvent

getGuild

Methods inherited from class net.dv8tion.jda.api.events.Event

getJDA, getResponseNumber

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.events.GenericEvent

getJDA, getResponseNumber

Methods inherited from interface net.dv8tion.jda.api.events.guild.voice.GuildVoiceUpdateEvent

getGuild, getMember

Methods inherited from interface net.dv8tion.jda.api.events.UpdateEvent

getEntityType

Constructor Detail

GuildVoiceLeaveEvent

public GuildVoiceLeaveEvent(@Nonnull
                            JDA api,
                            long responseNumber,
                            @Nonnull
                            Member member,
                            @Nonnull
                            VoiceChannel channelLeft)

Method Detail

getChannelLeft

@Nonnull
public VoiceChannel getChannelLeft()

Description copied from interface: GuildVoiceUpdateEvent

The VoiceChannel that the Member is moved from

Specified by:

getChannelLeft in interface GuildVoiceUpdateEvent

Overrides:

getChannelLeft in class GenericGuildVoiceUpdateEvent

Returns:

The VoiceChannel

getOldValue

@Nonnull
public VoiceChannel getOldValue()

Description copied from interface: UpdateEvent

The old value

Specified by:

getOldValue in interface UpdateEvent<Member,VoiceChannel>

Overrides:

getOldValue in class GenericGuildVoiceUpdateEvent

Returns:

The old value