Package net.dv8tion.jda.internal.entities

Class GuildVoiceStateImpl

java.lang.Object

net.dv8tion.jda.internal.entities.GuildVoiceStateImpl

All Implemented Interfaces:

GuildVoiceState, ISnowflake

public class GuildVoiceStateImpl
extends Object
implements GuildVoiceState

Constructor Summary

Constructors

Constructor	Description
GuildVoiceStateImpl(Member member)

Method Summary

Modifier and Type	Method	Description
RestAction<Void>	approveSpeaker()	Promote the member to speaker.
RestAction<Void>	declineSpeaker()	Reject this members request to speak or moves a speaker back to the audience.
boolean	equals(Object obj)
AudioChannelUnion	getChannel()	Returns the current AudioChannelUnion that the Member is in.
Guild	getGuild()	Returns the Guild for the Member that this GuildVoiceState belongs to.
long	getIdLong()	The Snowflake id of this entity.
JDA	getJDA()	Returns the JDA instance of this VoiceState
Member	getMember()	Returns the Member corresponding to this GuildVoiceState instance
long	getRequestToSpeak()
OffsetDateTime	getRequestToSpeakTimestamp()	The time at which the user requested to speak.
String	getSessionId()	The Session-Id for this VoiceState
int	hashCode()
boolean	inAudioChannel()	Used to determine if the Member is currently connected to an AudioChannel in the Guild returned from GuildVoiceState.getGuild().
RestAction<Void>	inviteSpeaker()	Invite this member to become a speaker.
boolean	isDeafened()	Returns whether the Member is deafened, either by choice GuildVoiceState.isSelfDeafened() or deafened by an admin GuildVoiceState.isGuildDeafened()
boolean	isGuildDeafened()	Returns whether the Member got deafened by an Admin
boolean	isGuildMuted()	Returns whether the Member got muted by an Admin
boolean	isMuted()	Returns whether the Member is muted, either by choice GuildVoiceState.isSelfMuted() or muted by an admin GuildVoiceState.isGuildMuted()
boolean	isSelfDeafened()	Returns whether the Member deafened themselves.
boolean	isSelfMuted()	Returns whether the Member muted themselves.
boolean	isSendingVideo()	Returns true if this Member has their camera turned on.
boolean	isStream()	Returns true if this Member is currently streaming with Go Live.
boolean	isSuppressed()	Returns true if this Member is unable to speak because the channel is actively suppressing audio communication.
GuildVoiceStateImpl	setGuildDeafened(boolean guildDeafened)
GuildVoiceStateImpl	setGuildMuted(boolean guildMuted)
void	setMember(Member member)
GuildVoiceStateImpl	setRequestToSpeak(OffsetDateTime timestamp)
GuildVoiceStateImpl	setSelfDeafened(boolean selfDeafened)
GuildVoiceStateImpl	setSelfMuted(boolean selfMuted)
GuildVoiceStateImpl	setSessionId(String sessionId)
GuildVoiceStateImpl	setStream(boolean stream)
GuildVoiceStateImpl	setSuppressed(boolean suppressed)
GuildVoiceStateImpl	setVideo(boolean video)
String	toString()
GuildVoiceStateImpl	updateConnectedChannel(AudioChannel connectedChannel)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getTimeCreated

Constructor Details

GuildVoiceStateImpl

public GuildVoiceStateImpl(Member member)

Method Details

isSelfMuted

public boolean isSelfMuted()

Description copied from interface: GuildVoiceState

Returns whether the Member muted themselves.

Specified by:

isSelfMuted in interface GuildVoiceState

Returns:

The User's self-mute status, or false if the member is not connected to an audio channel

isSelfDeafened

public boolean isSelfDeafened()

Description copied from interface: GuildVoiceState

Returns whether the Member deafened themselves.

Specified by:

isSelfDeafened in interface GuildVoiceState

Returns:

The User's self-deaf status, or false if the member is not connected to an audio channel

getJDA

@Nonnull
public JDA getJDA()

Description copied from interface: GuildVoiceState

Returns the JDA instance of this VoiceState

Specified by:

getJDA in interface GuildVoiceState

Returns:

The corresponding JDA instance

getSessionId

public String getSessionId()

Description copied from interface: GuildVoiceState

The Session-Id for this VoiceState

Specified by:

getSessionId in interface GuildVoiceState

Returns:

The Session-Id, or null if the member is not connected to an audio channel.

getRequestToSpeak

public long getRequestToSpeak()

getRequestToSpeakTimestamp

public OffsetDateTime getRequestToSpeakTimestamp()

Description copied from interface: GuildVoiceState

The time at which the user requested to speak.
This is used for StageChannels and can only be approved by members with Permission.VOICE_MUTE_OTHERS on the channel.

Specified by:

getRequestToSpeakTimestamp in interface GuildVoiceState

Returns:

The request to speak timestamp, or null if this user didn't request to speak

approveSpeaker

@Nonnull
public RestAction<Void> approveSpeaker()

Description copied from interface: GuildVoiceState

Promote the member to speaker.

This requires a non-null GuildVoiceState.getRequestToSpeakTimestamp(). 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.

Specified by:

approveSpeaker in interface GuildVoiceState

Returns:

RestAction

declineSpeaker

@Nonnull
public RestAction<Void> declineSpeaker()

Description copied from interface: GuildVoiceState

Reject this members request to speak or moves a speaker back to the audience.

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

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

Specified by:

declineSpeaker in interface GuildVoiceState

Returns:

RestAction

inviteSpeaker

@Nonnull
public RestAction<Void> inviteSpeaker()

Description copied from interface: GuildVoiceState

Invite this member to become a speaker.

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

Specified by:

inviteSpeaker in interface GuildVoiceState

Returns:

RestAction

isMuted

public boolean isMuted()

Description copied from interface: GuildVoiceState

Returns whether the Member is muted, either by choice GuildVoiceState.isSelfMuted() or muted by an admin GuildVoiceState.isGuildMuted()

Specified by:

isMuted in interface GuildVoiceState

Returns:

the Member's mute status, or false if the member is not connected to an audio channel

isDeafened

public boolean isDeafened()

Description copied from interface: GuildVoiceState

Returns whether the Member is deafened, either by choice GuildVoiceState.isSelfDeafened() or deafened by an admin GuildVoiceState.isGuildDeafened()

Specified by:

isDeafened in interface GuildVoiceState

Returns:

the Member's deaf status, or false if the member is not connected to an audio channel

isGuildMuted

public boolean isGuildMuted()

Description copied from interface: GuildVoiceState

Returns whether the Member got muted by an Admin

Specified by:

isGuildMuted in interface GuildVoiceState

Returns:

the Member's guild-mute status, or false if the member is not connected to an audio channel

isGuildDeafened

public boolean isGuildDeafened()

Description copied from interface: GuildVoiceState

Returns whether the Member got deafened by an Admin

Specified by:

isGuildDeafened in interface GuildVoiceState

Returns:

the Member's guild-deaf status, or false if the member is not connected to an audio channel

isSuppressed

public boolean isSuppressed()

Description copied from interface: GuildVoiceState

Returns true if this Member is unable to speak because the channel is actively suppressing audio communication. This occurs in VoiceChannels where the Member either doesn't have Permission#VOICE_SPEAK or if the channel is the designated AFK channel.
This is also used by StageChannels for listeners without speaker approval.

Specified by:

isSuppressed in interface GuildVoiceState

Returns:

True, if this Member's audio is being suppressed.

See Also:

• GuildVoiceState.getRequestToSpeakTimestamp()

isStream

public boolean isStream()

Description copied from interface: GuildVoiceState

Returns true if this Member is currently streaming with Go Live.

Specified by:

isStream in interface GuildVoiceState

Returns:

True, if this member is streaming

isSendingVideo

public boolean isSendingVideo()

Description copied from interface: GuildVoiceState

Returns true if this Member has their camera turned on.
This does not include streams! See GuildVoiceState.isStream()

Specified by:

isSendingVideo in interface GuildVoiceState

Returns:

True, if this member has their camera turned on.

getChannel

public AudioChannelUnion getChannel()

Description copied from interface: GuildVoiceState

Returns the current AudioChannelUnion that the Member is in. If the Member is currently not connected to a AudioChannel, this returns null.

Specified by:

getChannel in interface GuildVoiceState

Returns:

The AudioChannelUnion that the Member is connected to, or null if the member is not connected to an audio channel.

getGuild

@Nonnull
public Guild getGuild()

Description copied from interface: GuildVoiceState

Returns the Guild for the Member that this GuildVoiceState belongs to.

Specified by:

getGuild in interface GuildVoiceState

Returns:

the Member's Guild

getMember

@Nonnull
public Member getMember()

Description copied from interface: GuildVoiceState

Returns the Member corresponding to this GuildVoiceState instance

Specified by:

getMember in interface GuildVoiceState

Returns:

The member related to this voice state, might not be cached and thus have outdated information.

inAudioChannel

public boolean inAudioChannel()

Description copied from interface: GuildVoiceState

Used to determine if the Member is currently connected to an AudioChannel in the Guild returned from GuildVoiceState.getGuild().
If this is false, GuildVoiceState.getChannel() will return null.

Specified by:

inAudioChannel in interface GuildVoiceState

Returns:

True, if the Member is currently connected to an AudioChannel in this Guild

getIdLong

public long getIdLong()

Description copied from interface: ISnowflake

The Snowflake id of this entity. This is unique to every entity and will never change.

Specified by:

getIdLong in interface ISnowflake

Returns:

Long containing the Id.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

setMember

public void setMember(Member member)

updateConnectedChannel

public GuildVoiceStateImpl updateConnectedChannel(AudioChannel connectedChannel)

setSessionId

public GuildVoiceStateImpl setSessionId(String sessionId)

setSelfMuted

public GuildVoiceStateImpl setSelfMuted(boolean selfMuted)

setSelfDeafened

public GuildVoiceStateImpl setSelfDeafened(boolean selfDeafened)

setGuildMuted

public GuildVoiceStateImpl setGuildMuted(boolean guildMuted)

setGuildDeafened

public GuildVoiceStateImpl setGuildDeafened(boolean guildDeafened)

setSuppressed

public GuildVoiceStateImpl setSuppressed(boolean suppressed)

setStream

public GuildVoiceStateImpl setStream(boolean stream)

setVideo

public GuildVoiceStateImpl setVideo(boolean video)

setRequestToSpeak

public GuildVoiceStateImpl setRequestToSpeak(OffsetDateTime timestamp)