net.dv8tion.jda.entities.impl

Class VoiceStatusImpl

java.lang.Object

net.dv8tion.jda.entities.impl.VoiceStatusImpl

All Implemented Interfaces:

VoiceStatus

public class VoiceStatusImpl
extends java.lang.Object
implements VoiceStatus

Constructor Summary

Constructors

Constructor and Description
VoiceStatusImpl(User user, Guild guild)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
VoiceChannel	getChannel() Returns the current VoiceChannel of the User If the User is currently not in a VoiceChannel, this returns null
Guild	getGuild() Returns the current Guild of the User's VoiceChannel If the User is currently not in a VoiceChannel, this returns null
java.lang.String	getSessionId()
User	getUser() Returns the User corresponding to this VoiceStatus Object (Backreference)
int	hashCode()
boolean	inVoiceChannel() Used to determine if the User is currently in a VoiceChannel in the Guild returned from getGuild(). If this is false, getChannel() will return null.
boolean	isDeaf() Returns whether the User deafened himself
boolean	isMuted() Returns whether the User muted himself
boolean	isServerDeaf() Returns whether the User got deafened by an Admin (server side)
boolean	isServerMuted() Returns whether the User got muted by an Admin (server side)
boolean	isSuppressed() Returns true if this User is unable to speak because the channel is actively suppressing audio communication.
VoiceStatusImpl	setChannel(VoiceChannel channel)
VoiceStatusImpl	setDeaf(boolean deaf)
VoiceStatusImpl	setMute(boolean mute)
VoiceStatusImpl	setServerDeaf(boolean serverDeaf)
VoiceStatusImpl	setServerMute(boolean serverMute)
VoiceStatusImpl	setSessionId(java.lang.String sessionId)
VoiceStatusImpl	setSuppressed(boolean suppressed)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VoiceStatusImpl

public VoiceStatusImpl(User user,
                       Guild guild)

Method Detail

isMuted

public boolean isMuted()

Description copied from interface: VoiceStatus

Returns whether the User muted himself

Specified by:

isMuted in interface VoiceStatus

Returns:

the User's self-mute status

isServerMuted

public boolean isServerMuted()

Description copied from interface: VoiceStatus

Returns whether the User got muted by an Admin (server side)

Specified by:

isServerMuted in interface VoiceStatus

Returns:

the User's server-mute status

isDeaf

public boolean isDeaf()

Description copied from interface: VoiceStatus

Returns whether the User deafened himself

Specified by:

isDeaf in interface VoiceStatus

Returns:

the User's self-deaf status

isServerDeaf

public boolean isServerDeaf()

Description copied from interface: VoiceStatus

Returns whether the User got deafened by an Admin (server side)

Specified by:

isServerDeaf in interface VoiceStatus

Returns:

the User's server-deaf status

isSuppressed

public boolean isSuppressed()

Description copied from interface: VoiceStatus

Returns true if this User is unable to speak because the channel is actively suppressing audio communication. This occurs only in AFK channels, where no one is allowed to send audio.

Specified by:

isSuppressed in interface VoiceStatus

Returns:

True if this User's audio is being suppressed.

getChannel

public VoiceChannel getChannel()

Description copied from interface: VoiceStatus

Returns the current VoiceChannel of the User If the User is currently not in a VoiceChannel, this returns null

Specified by:

getChannel in interface VoiceStatus

Returns:

the User's VoiceChannel or null

getGuild

public Guild getGuild()

Description copied from interface: VoiceStatus

Returns the current Guild of the User's VoiceChannel If the User is currently not in a VoiceChannel, this returns null

Specified by:

getGuild in interface VoiceStatus

Returns:

the User's VoiceChannel's Guild or null

getUser

public User getUser()

Description copied from interface: VoiceStatus

Returns the User corresponding to this VoiceStatus Object (Backreference)

Specified by:

getUser in interface VoiceStatus

Returns:

the User that holds this VoiceStatus

getSessionId

public java.lang.String getSessionId()

Specified by:

getSessionId in interface VoiceStatus

inVoiceChannel

public boolean inVoiceChannel()

Description copied from interface: VoiceStatus

Used to determine if the User is currently in a VoiceChannel in the Guild returned from getGuild().
If this is false, getChannel() will return null.

Specified by:

inVoiceChannel in interface VoiceStatus

Returns:

True if the User is currently in a VoiceChannel in this Guild.

setMute

public VoiceStatusImpl setMute(boolean mute)

setServerMute

public VoiceStatusImpl setServerMute(boolean serverMute)

setDeaf

public VoiceStatusImpl setDeaf(boolean deaf)

setServerDeaf

public VoiceStatusImpl setServerDeaf(boolean serverDeaf)

setChannel

public VoiceStatusImpl setChannel(VoiceChannel channel)

setSessionId

public VoiceStatusImpl setSessionId(java.lang.String sessionId)

setSuppressed

public VoiceStatusImpl setSuppressed(boolean suppressed)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object