Interface GuildVoiceUpdateEvent
-
- All Superinterfaces:
GenericEvent
,UpdateEvent<Member,AudioChannel>
- All Known Implementing Classes:
GenericGuildVoiceUpdateEvent
,GuildVoiceJoinEvent
,GuildVoiceLeaveEvent
,GuildVoiceMoveEvent
public interface GuildVoiceUpdateEvent extends UpdateEvent<Member,AudioChannel>
Indicates that aMember
joined or left anAudioChannel
.
Generic event that combinesGuildVoiceLeaveEvent
,GuildVoiceJoinEvent
, andGuildVoiceMoveEvent
for convenience.Can be used to detect when a Member leaves/joins an AudioChannel
Requirements
This event requires the
VOICE_STATE
CacheFlag to be enabled, which requires theGUILD_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.Identifier:
voice-channel
-
-
Field Summary
Fields Modifier and Type Field Description static String
IDENTIFIER
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AudioChannel
getChannelJoined()
TheAudioChannel
that was joinedAudioChannel
getChannelLeft()
TheAudioChannel
that theMember
is moved fromGuild
getGuild()
TheGuild
Member
getMember()
The affectedMember
-
Methods inherited from interface net.dv8tion.jda.api.events.GenericEvent
getJDA, getResponseNumber
-
Methods inherited from interface net.dv8tion.jda.api.events.UpdateEvent
getEntity, getEntityType, getNewValue, getOldValue, getPropertyIdentifier
-
-
-
-
Field Detail
-
IDENTIFIER
static final String IDENTIFIER
- See Also:
- Constant Field Values
-
-
Method Detail
-
getChannelLeft
@Nullable AudioChannel getChannelLeft()
TheAudioChannel
that theMember
is moved from- Returns:
- The
AudioChannel
-
getChannelJoined
@Nullable AudioChannel getChannelJoined()
TheAudioChannel
that was joined- Returns:
- The
AudioChannel
-
-