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

Class GuildVoiceSuppressEvent

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.GuildVoiceSuppressEvent

All Implemented Interfaces:

GenericEvent

public class GuildVoiceSuppressEvent
extends GenericGuildVoiceEvent

Indicates that a Member was (un-)suppressed.

Can be used to detect when a member is suppressed or un-suppressed.

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:

GuildVoiceState.isSuppressed()

Constructor Summary

Constructors

Constructor	Description
GuildVoiceSuppressEvent(JDA api, long responseNumber, Member member)

Method Summary

Modifier and Type	Method	Description
boolean	isSuppressed()	Whether the member was suppressed in this event

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, toString, wait, wait, wait

Constructor Detail

GuildVoiceSuppressEvent

public GuildVoiceSuppressEvent(@Nonnull
                               JDA api,
                               long responseNumber,
                               @Nonnull
                               Member member)

Method Detail

isSuppressed

public boolean isSuppressed()

Whether the member was suppressed in this event

Returns:

True, if the member was suppressed,
False, if the member was un-suppressed