Package net.dv8tion.jda.api.entities
Interface GuildVoiceState
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description VoiceChannel
getChannel()
Returns the currentVoiceChannel
that theMember
is in.Guild
getGuild()
JDA
getJDA()
Returns theJDA
instance of this VoiceStateMember
getMember()
Returns theMember
corresponding to this GuildVoiceState instance (Backreference)String
getSessionId()
The Session-Id for this VoiceStateboolean
inVoiceChannel()
Used to determine if theMember
is currently in aVoiceChannel
in theGuild
returned fromgetGuild()
.
If this isfalse
,getChannel()
will returnnull
.boolean
isDeafened()
Returns whether theMember
is deafened, either by choiceisSelfDeafened()
or deafened by an adminisGuildDeafened()
boolean
isGuildDeafened()
Returns whether theMember
got deafened by an Adminboolean
isGuildMuted()
Returns whether theMember
got muted by an Adminboolean
isMuted()
Returns whether theMember
is muted, either by choiceisSelfMuted()
or deafened by an adminisGuildMuted()
boolean
isSelfDeafened()
Returns whether theMember
deafened themselves.boolean
isSelfMuted()
Returns whether theMember
muted themselves.boolean
isSuppressed()
Returns true if thisMember
is unable to speak because the channel is actively suppressing audio communication.
-
-
-
Method Detail
-
getJDA
@Nonnull JDA getJDA()
Returns theJDA
instance of this VoiceState- Returns:
- The corresponding JDA instance
-
isSelfMuted
boolean isSelfMuted()
Returns whether theMember
muted themselves.- Returns:
- The User's self-mute status
-
isSelfDeafened
boolean isSelfDeafened()
Returns whether theMember
deafened themselves.- Returns:
- The User's self-deaf status
-
isMuted
boolean isMuted()
Returns whether theMember
is muted, either by choiceisSelfMuted()
or deafened by an adminisGuildMuted()
- Returns:
- the Member's mute status
-
isDeafened
boolean isDeafened()
Returns whether theMember
is deafened, either by choiceisSelfDeafened()
or deafened by an adminisGuildDeafened()
- Returns:
- the Member's deaf status
-
isGuildMuted
boolean isGuildMuted()
Returns whether theMember
got muted by an Admin- Returns:
- the Member's guild-mute status
-
isGuildDeafened
boolean isGuildDeafened()
Returns whether theMember
got deafened by an Admin- Returns:
- the Member's guild-deaf status
-
isSuppressed
boolean isSuppressed()
Returns true if thisMember
is unable to speak because the channel is actively suppressing audio communication. This occurs only inVoiceChannels
where the Member either doesn't havePermission#VOICE_SPEAK
or if the channel is the designated AFK channel.- Returns:
- True, if this
Member's
audio is being suppressed.
-
getChannel
@Nullable VoiceChannel getChannel()
Returns the currentVoiceChannel
that theMember
is in. If theMember
is currently not in aVoiceChannel
, this returns null.- Returns:
- The VoiceChannel that the Member is in, or null.
-
getGuild
@Nonnull Guild getGuild()
Returns the currentGuild
of theMember's
VoiceChannel
. If theMember
is currently not in aVoiceChannel
, this returns null- Returns:
- the Member's Guild
-
getMember
@Nonnull Member getMember()
Returns theMember
corresponding to this GuildVoiceState instance (Backreference)- Returns:
- the Member that holds this GuildVoiceState
-
inVoiceChannel
boolean inVoiceChannel()
Used to determine if theMember
is currently in aVoiceChannel
in theGuild
returned fromgetGuild()
.
If this isfalse
,getChannel()
will returnnull
.- Returns:
- True, if the
Member
is currently in aVoiceChannel
in thisGuild
.
-
-