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

Class GenericGuildVoiceUpdateEvent

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

All Implemented Interfaces:

GenericEvent, GuildVoiceUpdateEvent, UpdateEvent<Member,VoiceChannel>

Direct Known Subclasses:

GuildVoiceJoinEvent, GuildVoiceLeaveEvent, GuildVoiceMoveEvent

public class GenericGuildVoiceUpdateEvent
extends GenericGuildVoiceEvent
implements GuildVoiceUpdateEvent

Requirements

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

Additionally, these events require 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 specific events like these we need to have the old member cached to compare against.

Field Summary

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

IDENTIFIER

Constructor Summary

Constructors

Constructor	Description
GenericGuildVoiceUpdateEvent(JDA api, long responseNumber, Member member, VoiceChannel left, VoiceChannel joined)

Method Summary

Modifier and Type	Method	Description
VoiceChannel	getChannelJoined()	The VoiceChannel that was joined
VoiceChannel	getChannelLeft()	The VoiceChannel that the Member is moved from
Member	getEntity()	The affected entity
VoiceChannel	getNewValue()	The new value
VoiceChannel	getOldValue()	The old value
java.lang.String	getPropertyIdentifier()	The field name for the updated property
java.lang.String	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

GenericGuildVoiceUpdateEvent

public GenericGuildVoiceUpdateEvent(@Nonnull
                                    JDA api,
                                    long responseNumber,
                                    @Nonnull
                                    Member member,
                                    @Nullable
                                    VoiceChannel left,
                                    @Nullable
                                    VoiceChannel joined)

Method Detail

getChannelLeft

@Nullable
public VoiceChannel getChannelLeft()

Description copied from interface: GuildVoiceUpdateEvent

The VoiceChannel that the Member is moved from

Specified by:

getChannelLeft in interface GuildVoiceUpdateEvent

Returns:

The VoiceChannel

getChannelJoined

@Nullable
public VoiceChannel getChannelJoined()

Description copied from interface: GuildVoiceUpdateEvent

The VoiceChannel that was joined

Specified by:

getChannelJoined in interface GuildVoiceUpdateEvent

Returns:

The VoiceChannel

getPropertyIdentifier

@Nonnull
public java.lang.String getPropertyIdentifier()

Description copied from interface: UpdateEvent

The field name for the updated property

Example

 @Override
 public void onGenericRoleUpdate(GenericRoleUpdateEvent event)
 {
     switch (event.getPropertyIdentifier())
     {
     case RoleUpdateColorEvent.IDENTIFIER:
         System.out.printf("Updated color for role: %s%n", event);
         break;
     case RoleUpdatePositionEvent.IDENTIFIER:
         RoleUpdatePositionEvent update = (RoleUpdatePositionEvent) event;
         System.out.printf("Updated position for role: %s raw(%s->%s)%n", event, update.getOldPositionRaw(), update.getNewPositionRaw());
         break;
     default: return;
     }
 }
 

Specified by:

getPropertyIdentifier in interface UpdateEvent<Member,VoiceChannel>

Returns:

The name of the updated property

getEntity

@Nonnull
public Member getEntity()

Description copied from interface: UpdateEvent

The affected entity

Specified by:

getEntity in interface UpdateEvent<Member,VoiceChannel>

Returns:

The affected entity

getOldValue

@Nullable
public VoiceChannel getOldValue()

Description copied from interface: UpdateEvent

The old value

Specified by:

getOldValue in interface UpdateEvent<Member,VoiceChannel>

Returns:

The old value

getNewValue

@Nullable
public VoiceChannel getNewValue()

Description copied from interface: UpdateEvent

The new value

Specified by:

getNewValue in interface UpdateEvent<Member,VoiceChannel>

Returns:

The new value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object