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

Class GuildVoiceRequestToSpeakEvent

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

All Implemented Interfaces:

GenericEvent

public class GuildVoiceRequestToSpeakEvent
extends GenericGuildVoiceEvent

Indicates that a guild member has updated their Request-to-Speak.

If getNewTime() is non-null, this means the member has raised their hand and wants to speak. You can use approveSpeaker() or declineSpeaker() to handle this request if you have Permission.VOICE_MUTE_OTHERS.

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.

Constructor Summary

Constructors

Constructor	Description
GuildVoiceRequestToSpeakEvent(JDA api, long responseNumber, Member member, OffsetDateTime oldTime, OffsetDateTime newTime)

Method Summary

Modifier and Type	Method	Description
RestAction<Void>	approveSpeaker()	Promote the member to speaker.
RestAction<Void>	declineSpeaker()	Reject this members request to speak.
OffsetDateTime	getNewTime()	The new GuildVoiceState.getRequestToSpeakTimestamp()
OffsetDateTime	getOldTime()	The old GuildVoiceState.getRequestToSpeakTimestamp()

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

GuildVoiceRequestToSpeakEvent

public GuildVoiceRequestToSpeakEvent(@Nonnull
 JDA api,
 long responseNumber,
 @Nonnull
 Member member,
 @Nullable
 OffsetDateTime oldTime,
 @Nullable
 OffsetDateTime newTime)

Method Details

getOldTime

@Nullable
public OffsetDateTime getOldTime()

The old GuildVoiceState.getRequestToSpeakTimestamp()

Returns:

The old timestamp, or null if this member did not request to speak before

getNewTime

@Nullable
public OffsetDateTime getNewTime()

The new GuildVoiceState.getRequestToSpeakTimestamp()

Returns:

The new timestamp, or null if the request to speak was declined or cancelled

approveSpeaker

@Nonnull
@CheckReturnValue
public RestAction<Void> approveSpeaker()

Promote the member to speaker.

This requires a non-null getNewTime(). You can use GuildVoiceState.inviteSpeaker() to invite the member to become a speaker if they haven't requested to speak.

This does nothing if the member is not connected to a StageChannel.

Returns:

RestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.VOICE_MUTE_OTHERS in the associated StageChannel

declineSpeaker

@Nonnull
@CheckReturnValue
public RestAction<Void> declineSpeaker()

Reject this members request to speak.

This requires a non-null getNewTime(). The member will have to request to speak again.

This does nothing if the member is not connected to a StageChannel.

Returns:

RestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.VOICE_MUTE_OTHERS in the associated StageChannel