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,AudioChannel>
public class GuildVoiceLeaveEvent extends GenericGuildVoiceUpdateEvent
Indicates that aMemberdisconnected from aAudioChannel.When the
Memberis moved aGuildVoiceMoveEventis fired insteadCan be used to detect when a member leaves a voice channel completely.
Requirements
This event requires the
VOICE_STATECacheFlag to be enabled, which requires theGUILD_VOICE_STATESintent.createLight(String)disables that CacheFlag by default!Additionally, this event requires the
MemberCachePolicyto 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, AudioChannel channelLeft)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AudioChannelgetChannelLeft()TheAudioChannelthat theMemberis moved fromAudioChannelgetOldValue()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
-
-
-
-
Method Detail
-
getChannelLeft
@Nonnull public AudioChannel getChannelLeft()
Description copied from interface:GuildVoiceUpdateEventTheAudioChannelthat theMemberis moved from- Specified by:
getChannelLeftin interfaceGuildVoiceUpdateEvent- Overrides:
getChannelLeftin classGenericGuildVoiceUpdateEvent- Returns:
- The
AudioChannel
-
getOldValue
@Nonnull public AudioChannel getOldValue()
Description copied from interface:UpdateEventThe old value- Specified by:
getOldValuein interfaceUpdateEvent<Member,AudioChannel>- Overrides:
getOldValuein classGenericGuildVoiceUpdateEvent- Returns:
- The old value
-
-