discord4j.core.object

Class VoiceState

java.lang.Object

discord4j.core.object.VoiceState

All Implemented Interfaces:

DiscordObject

public final class VoiceState
extends Object
implements DiscordObject

A Discord voice state.

See Also:

Voice Resource

Constructor Summary

Constructors

Constructor and Description
VoiceState(GatewayDiscordClient gateway, discord4j.discordjson.json.VoiceStateData data) Constructs a VoiceState with an associated ServiceMediator and Discord data.

Method Summary

Modifier and Type	Method and Description
Mono<VoiceChannel>	getChannel() Requests to retrieve the channel this user is connected to, if present.
Mono<VoiceChannel>	getChannel(EntityRetrievalStrategy retrievalStrategy) Requests to retrieve the channel this user is connected to, if present, using the given retrieval strategy.
Optional<Snowflake>	getChannelId() Gets the channel ID this user is connected to, if present.
GatewayDiscordClient	getClient() Returns the GatewayDiscordClient that created this object.
Mono<Guild>	getGuild() Requests to retrieve the guild this voice state is for.
Mono<Guild>	getGuild(EntityRetrievalStrategy retrievalStrategy) Requests to retrieve the guild this voice state is for, using the given retrieval strategy.
Snowflake	getGuildId() Gets the guild ID this voice state is for.
Mono<Member>	getMember() Requests to retrieve the member this voice state is for.
Mono<Member>	getMember(EntityRetrievalStrategy retrievalStrategy) Requests to retrieve the member this voice state is for, using the given retrieval strategy.
String	getSessionId() Gets the session ID for this voice state.
Mono<User>	getUser() Requests to retrieve the user this voice state is for.
Mono<User>	getUser(EntityRetrievalStrategy retrievalStrategy) Requests to retrieve the user this voice state is for, using the given retrieval strategy.
Snowflake	getUserId() Gets the user ID this voice state is for.
boolean	isDeaf() Gets whether this user is deafened by the server.
boolean	isMuted() Gets whether this user is muted by the server.
boolean	isSelfDeaf() Gets whether this user is locally deafened.
boolean	isSelfMuted() Gets whether this user is locally muted.
boolean	isSelfStreaming() Gets whether this user is streaming using "Go Live".
boolean	isSelfVideoEnabled() Gets whether this user's camera is enabled.
boolean	isSuppressed() Gets whether this user is muted by the current user.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VoiceState

public VoiceState(GatewayDiscordClient gateway,
                  discord4j.discordjson.json.VoiceStateData data)

Constructs a VoiceState with an associated ServiceMediator and Discord data.

Parameters:

gateway - The GatewayDiscordClient associated to this object, must be non-null.

data - The raw data as represented by Discord, must be non-null.

Method Detail

getClient

public GatewayDiscordClient getClient()

Description copied from interface: DiscordObject

Returns the GatewayDiscordClient that created this object. Methods in it are exclusively based on the entity cache or Store in use. Refer to calling getClient().rest() to access a DiscordClient that is capable of requesting entities directly from the REST API.

Specified by:

getClient in interface DiscordObject

Returns:

The GatewayDiscordClient associated to this object.

getGuildId

public Snowflake getGuildId()

Gets the guild ID this voice state is for.

Returns:

The guild ID this voice state is for.

getGuild

public Mono<Guild> getGuild()

Requests to retrieve the guild this voice state is for.

Returns:

A Mono where, upon successful completion, emits the Guild this voice state is for. If an error is received, it is emitted through the Mono.

getGuild

public Mono<Guild> getGuild(EntityRetrievalStrategy retrievalStrategy)

Requests to retrieve the guild this voice state is for, using the given retrieval strategy.

Parameters:

retrievalStrategy - the strategy to use to get the guild

Returns:

A Mono where, upon successful completion, emits the Guild this voice state is for. If an error is received, it is emitted through the Mono.

getChannelId

public Optional<Snowflake> getChannelId()

Gets the channel ID this user is connected to, if present.

Returns:

The channel ID this user is connected to, if present.

getChannel

public Mono<VoiceChannel> getChannel()

Requests to retrieve the channel this user is connected to, if present.

Returns:

A Mono where, upon successful completion, emits the VoiceChannel this user is connected to, if present. If an error is received, it is emitted through the Mono.

getChannel

public Mono<VoiceChannel> getChannel(EntityRetrievalStrategy retrievalStrategy)

Requests to retrieve the channel this user is connected to, if present, using the given retrieval strategy.

Parameters:

retrievalStrategy - the strategy to use to get the channel

Returns:

A Mono where, upon successful completion, emits the VoiceChannel this user is connected to, if present. If an error is received, it is emitted through the Mono.

getUserId

public Snowflake getUserId()

Gets the user ID this voice state is for.

Returns:

The user ID this voice state is for.

getUser

public Mono<User> getUser()

Requests to retrieve the user this voice state is for.

Returns:

A Mono where, upon successful completion, emits the User this voice state is for. If an error is received, it is emitted through the Mono.

getUser

public Mono<User> getUser(EntityRetrievalStrategy retrievalStrategy)

Requests to retrieve the user this voice state is for, using the given retrieval strategy.

Parameters:

retrievalStrategy - the strategy to use to get the user

Returns:

A Mono where, upon successful completion, emits the User this voice state is for. If an error is received, it is emitted through the Mono.

getMember

public Mono<Member> getMember()

Requests to retrieve the member this voice state is for.

Returns:

A Mono where, upon successful completion, emits the Member this voice state is for. If an error is received, it is emitted through the Mono.

getMember

public Mono<Member> getMember(EntityRetrievalStrategy retrievalStrategy)

Requests to retrieve the member this voice state is for, using the given retrieval strategy.

Parameters:

retrievalStrategy - the strategy to use to get the member

Returns:

A Mono where, upon successful completion, emits the Member this voice state is for. If an error is received, it is emitted through the Mono.

getSessionId

public String getSessionId()

Gets the session ID for this voice state.

Returns:

The session ID for this voice state.

isDeaf

public boolean isDeaf()

Gets whether this user is deafened by the server.

Returns:

true if the user is deafened by the server, false otherwise.

isMuted

public boolean isMuted()

Gets whether this user is muted by the server.

Returns:

true if the user is deafened by the server, false otherwise.

isSelfDeaf

public boolean isSelfDeaf()

Gets whether this user is locally deafened.

Returns:

true if this user is locally deafened, false otherwise.

isSelfMuted

public boolean isSelfMuted()

Gets whether this user is locally muted.

Returns:

true if this user is locally muted, false otherwise.

isSelfStreaming

public boolean isSelfStreaming()

Gets whether this user is streaming using "Go Live".

Returns:

true if this user is streaming using "Go Live", false otherwise.

isSelfVideoEnabled

public boolean isSelfVideoEnabled()

Gets whether this user's camera is enabled.

Returns:

true if this user's camera is enabled, false otherwise.

isSuppressed

public boolean isSuppressed()

Gets whether this user is muted by the current user.

Returns:

true if this user is muted by the current user, false otherwise.

toString

public String toString()

Overrides:

toString in class Object