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

Class GuildVoiceGuildMuteEvent

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

All Implemented Interfaces:

GenericEvent

public class GuildVoiceGuildMuteEvent
extends GenericGuildVoiceEvent

Indicates that a Member was (un-)muted by a moderator.

Can be used to detect when a member is muted or un-muted by a moderator.

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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	isGuildMuted()	Whether the member was muted by a moderator 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 Details

GuildVoiceGuildMuteEvent

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

Method Details

isGuildMuted

public boolean isGuildMuted()

Whether the member was muted by a moderator in this event

Returns:

True, if a moderator muted this member,
False, if a moderator un-muted this member