discord4j.core.object.entity

Class VoiceChannel

java.lang.Object

discord4j.core.object.entity.VoiceChannel

All Implemented Interfaces:

DiscordObject, Channel, Entity, GuildChannel, Categorizable, Invitable

public final class VoiceChannel
extends Object
implements Categorizable, Invitable

A Discord voice channel.

Nested Class Summary

Nested classes/interfaces inherited from interface discord4j.core.object.entity.Channel

Channel.Type

Constructor Summary

Constructors

Constructor and Description
VoiceChannel(ServiceMediator serviceMediator, ChannelBean data) Constructs an VoiceChannel with an associated ServiceMediator and Discord data.

Method Summary

Modifier and Type	Method and Description
Mono<Void>	addMemberOverwrite(Snowflake memberId, PermissionOverwrite overwrite, String reason) Requests to add a permission overwrite for the given member while optionally specifying a reason.
Mono<Void>	addRoleOverwrite(Snowflake roleId, PermissionOverwrite overwrite, String reason) Requests to add a permission overwrite for the given role while optionally specifying a reason.
Mono<ExtendedInvite>	createInvite(Consumer<? super InviteCreateSpec> spec) Requests to create an invite.
Mono<Void>	delete(String reason) Requests to delete this channel while optionally specifying a reason.
Mono<VoiceChannel>	edit(Consumer<? super VoiceChannelEditSpec> spec) Requests to edit a voice channel.
boolean	equals(Object obj)
int	getBitrate() Gets the bitrate (in bits) for this voice channel.
Mono<Category>	getCategory() Requests to retrieve the category for this channel, if present.
Optional<Snowflake>	getCategoryId() Gets the ID of the category for this channel, if present.
DiscordClient	getClient() Gets the DiscordClient associated to this object.
Mono<PermissionSet>	getEffectivePermissions(Snowflake memberId) Gets the permissions for the given member, taking into account permission overwrites in this channel.
Mono<Guild>	getGuild() Requests to retrieve the guild this channel is associated to.
Snowflake	getGuildId() Gets the ID of the guild this channel is associated to.
Snowflake	getId() Gets the Snowflake that uniquely identifies this entity.
Flux<ExtendedInvite>	getInvites() Requests to retrieve this channel's invites.
String	getName() Gets the name of the channel.
Optional<ExtendedPermissionOverwrite>	getOverwriteForMember(Snowflake memberId) Gets the permission overwrite targeting the given member.
Optional<ExtendedPermissionOverwrite>	getOverwriteForRole(Snowflake roleId) Gets the permission overwrite targeting the given role.
Set<ExtendedPermissionOverwrite>	getPermissionOverwrites() Gets the permission overwrites for this channel.
Mono<Integer>	getPosition() Requests to retrieve the position of the channel relative to other channels in the guild.
int	getRawPosition() Gets the raw position of the channel as exposed by Discord.
Channel.Type	getType() Gets the type of channel.
int	getUserLimit() Gets the user limit of this voice channel.
Flux<VoiceState>	getVoiceStates() Requests to retrieve the voice states of this voice channel.
int	hashCode()
Mono<VoiceConnection>	join(Consumer<? super VoiceChannelJoinSpec> spec) Requests to the join this voice channel.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface discord4j.core.object.entity.GuildChannel

addMemberOverwrite, addRoleOverwrite

Methods inherited from interface discord4j.core.object.entity.Channel

delete, delete, getMention, getType

Methods inherited from interface discord4j.core.object.entity.Entity

getId

Methods inherited from interface discord4j.core.object.DiscordObject

getClient

Constructor Detail

VoiceChannel

public VoiceChannel(ServiceMediator serviceMediator,
                    ChannelBean data)

Constructs an VoiceChannel with an associated ServiceMediator and Discord data.

Parameters:

serviceMediator - The ServiceMediator associated to this object, must be non-null.

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

Method Detail

getCategoryId

public Optional<Snowflake> getCategoryId()

Description copied from interface: Categorizable

Gets the ID of the category for this channel, if present.

Specified by:

getCategoryId in interface Categorizable

Returns:

The ID of the category for this channel, if present.

getCategory

public Mono<Category> getCategory()

Description copied from interface: Categorizable

Requests to retrieve the category for this channel, if present.

Specified by:

getCategory in interface Categorizable

Returns:

A Mono where, upon successful completion, emits the category this channel, if present. If an error is received, it is emitted through the Mono.

createInvite

public Mono<ExtendedInvite> createInvite(Consumer<? super InviteCreateSpec> spec)

Description copied from interface: Invitable

Requests to create an invite.

Specified by:

createInvite in interface Invitable

Parameters:

spec - A Consumer that provides a "blank" InviteCreateSpec to be operated on.

Returns:

A Mono where, upon successful completion, emits the created ExtendedInvite. If an error is received, it is emitted through the Mono.

getInvites

public Flux<ExtendedInvite> getInvites()

Description copied from interface: Invitable

Requests to retrieve this channel's invites.

Specified by:

getInvites in interface Invitable

Returns:

A Flux that continually emits this channel's invites. If an error is received, it is emitted through the Flux.

getBitrate

public int getBitrate()

Gets the bitrate (in bits) for this voice channel.

Returns:

Gets the bitrate (in bits) for this voice channel.

getUserLimit

public int getUserLimit()

Gets the user limit of this voice channel.

Returns:

The user limit of this voice channel.

edit

public Mono<VoiceChannel> edit(Consumer<? super VoiceChannelEditSpec> spec)

Requests to edit a voice channel.

Parameters:

spec - A Consumer that provides a "blank" VoiceChannelEditSpec to be operated on.

Returns:

A Mono where, upon successful completion, emits the edited VoiceChannel. If an error is received, it is emitted through the Mono.

getVoiceStates

public Flux<VoiceState> getVoiceStates()

Requests to retrieve the voice states of this voice channel.

Returns:

A Flux that continually emits the voice states of this voice channel. If an error is received, it is emitted through the Flux.

Implementation Note:

If the underlying store does not save VoiceStateBean instances OR the bot is currently not logged in then the returned Flux will always be empty.

join

public Mono<VoiceConnection> join(Consumer<? super VoiceChannelJoinSpec> spec)

Requests to the join this voice channel.

Parameters:

spec - A Consumer that provides a "blank" VoiceChannelJoinSpec to be operated on.

Returns:

A Mono where, upon successful completion, emits a VoiceConnection, indicating a connection to the channel has been established. If an error is received, it is emitted through the Mono.

toString

public String toString()

getGuildId

public final Snowflake getGuildId()

Description copied from interface: GuildChannel

Gets the ID of the guild this channel is associated to.

Specified by:

getGuildId in interface GuildChannel

Returns:

The ID of the guild this channel is associated to.

getGuild

public final Mono<Guild> getGuild()

Description copied from interface: GuildChannel

Requests to retrieve the guild this channel is associated to.

Specified by:

getGuild in interface GuildChannel

Returns:

A Mono where, upon successful completion, emits the guild this channel is associated to. If an error is received, it is emitted through the Mono.

getPermissionOverwrites

public final Set<ExtendedPermissionOverwrite> getPermissionOverwrites()

Description copied from interface: GuildChannel

Gets the permission overwrites for this channel.

Specified by:

getPermissionOverwrites in interface GuildChannel

Returns:

The permission overwrites for this channel.

getOverwriteForMember

public Optional<ExtendedPermissionOverwrite> getOverwriteForMember(Snowflake memberId)

Description copied from interface: GuildChannel

Gets the permission overwrite targeting the given member.

Specified by:

getOverwriteForMember in interface GuildChannel

Parameters:

memberId - The ID of the member to get the overwrite for.

Returns:

The permission overwrite targeting the given member.

getOverwriteForRole

public Optional<ExtendedPermissionOverwrite> getOverwriteForRole(Snowflake roleId)

Description copied from interface: GuildChannel

Gets the permission overwrite targeting the given role.

Specified by:

getOverwriteForRole in interface GuildChannel

Parameters:

roleId - The ID of the role to get the overwrite for.

Returns:

The permission overwrite targeting the given role.

getEffectivePermissions

public Mono<PermissionSet> getEffectivePermissions(Snowflake memberId)

Description copied from interface: GuildChannel

Gets the permissions for the given member, taking into account permission overwrites in this channel.

Specified by:

getEffectivePermissions in interface GuildChannel

Parameters:

memberId - The ID of the member to get permissions for.

Returns:

The permissions for the given member.

getName

public final String getName()

Description copied from interface: GuildChannel

Gets the name of the channel.

Specified by:

getName in interface GuildChannel

Returns:

The name of the channel.

getRawPosition

public int getRawPosition()

Description copied from interface: GuildChannel

Gets the raw position of the channel as exposed by Discord. This may or may not be accurate with relativity to other channels in the guild.

Specified by:

getRawPosition in interface GuildChannel

Returns:

The raw position of the channel.

getPosition

public final Mono<Integer> getPosition()

Description copied from interface: GuildChannel

Requests to retrieve the position of the channel relative to other channels in the guild.

Specified by:

getPosition in interface GuildChannel

Returns:

A Mono where, upon successful completion, emits the position of the channel. If an error is received, it is emitted through the Mono.

addMemberOverwrite

public Mono<Void> addMemberOverwrite(Snowflake memberId,
                                     PermissionOverwrite overwrite,
                                     @Nullable
                                     String reason)

Description copied from interface: GuildChannel

Requests to add a permission overwrite for the given member while optionally specifying a reason.

Specified by:

addMemberOverwrite in interface GuildChannel

Parameters:

memberId - The ID of the member to add the overwrite for.

overwrite - The overwrite to add.

reason - The reason, if present.

Returns:

A Mono where, upon successful completion, emits nothing; indicating the guild has been deleted. If an error is received, it is emitted through the Mono.

addRoleOverwrite

public Mono<Void> addRoleOverwrite(Snowflake roleId,
                                   PermissionOverwrite overwrite,
                                   @Nullable
                                   String reason)

Description copied from interface: GuildChannel

Requests to add a permission overwrite for the given role while optionally specifying a reason.

Specified by:

addRoleOverwrite in interface GuildChannel

Parameters:

roleId - The ID of the role to add the overwrite for.

overwrite - The overwrite to add.

reason - The reason, if present.

Returns:

A Mono where, upon successful completion, emits nothing; indicating the guild has been deleted. If an error is received, it is emitted through the Mono.

getClient

public final DiscordClient getClient()

Description copied from interface: DiscordObject

Gets the DiscordClient associated to this object.

Specified by:

getClient in interface DiscordObject

Returns:

The DiscordClient associated to this object.

getId

public final Snowflake getId()

Description copied from interface: Entity

Gets the Snowflake that uniquely identifies this entity.

Specified by:

getId in interface Entity

Returns:

The Snowflake that uniquely identifies this entity.

getType

public final Channel.Type getType()

Description copied from interface: Channel

Gets the type of channel.

Specified by:

getType in interface Channel

Returns:

The type of channel.

delete

public final Mono<Void> delete(@Nullable
                               String reason)

Description copied from interface: Channel

Requests to delete this channel while optionally specifying a reason.

Specified by:

delete in interface Channel

Parameters:

reason - The reason, if present.

Returns:

A Mono where, upon successful completion, emits nothing; indicating the channel has been deleted. If an error is received, it is emitted through the Mono.

equals

public final boolean equals(@Nullable
                            Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object