Package org.javacord.api.entity.channel

Class ServerVoiceChannelUpdater

java.lang.Object

org.javacord.api.entity.channel.ServerChannelUpdater

org.javacord.api.entity.channel.ServerVoiceChannelUpdater

public class ServerVoiceChannelUpdater
extends ServerChannelUpdater

This class can be used to update server voice channels.

Constructor Summary

Constructors

Constructor	Description
ServerVoiceChannelUpdater(ServerVoiceChannel channel)	Creates a new server voice channel updater.

Method Summary

Modifier and Type	Method	Description
<T extends Permissionable & DiscordEntity> ServerVoiceChannelUpdater	addPermissionOverwrite(T permissionable, Permissions permissions)	Adds a permission overwrite for the given entity.
ServerVoiceChannelUpdater	removeCategory()	Queues the category to be removed.
<T extends Permissionable & DiscordEntity> ServerVoiceChannelUpdater	removePermissionOverwrite(T permissionable)	Removes a permission overwrite for the given entity.
ServerVoiceChannelUpdater	removeUserLimit()	Queues the user limit to be removed.
ServerVoiceChannelUpdater	setAuditLogReason(String reason)	Sets the reason for this update.
ServerVoiceChannelUpdater	setBitrate(int bitrate)	Queues the bitrate to be updated.
ServerVoiceChannelUpdater	setCategory(ChannelCategory category)	Queues the category to be updated.
ServerVoiceChannelUpdater	setName(String name)	Queues the name to be updated.
ServerVoiceChannelUpdater	setRawPosition(int rawPosition)	Queues the raw position to be updated.
ServerVoiceChannelUpdater	setUserLimit(int userLimit)	Queues the user limit to be updated.
CompletableFuture<Void>	update()	Performs the queued updates.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerVoiceChannelUpdater

public ServerVoiceChannelUpdater(ServerVoiceChannel channel)

Creates a new server voice channel updater.

Parameters:

channel - The channel to update.

Method Detail

setBitrate

public ServerVoiceChannelUpdater setBitrate(int bitrate)

Queues the bitrate to be updated.

Parameters:

bitrate - The new bitrate of the channel.

Returns:

The current instance in order to chain call methods.

setUserLimit

public ServerVoiceChannelUpdater setUserLimit(int userLimit)

Queues the user limit to be updated.

Parameters:

userLimit - The new user limit of the channel.

Returns:

The current instance in order to chain call methods.

removeUserLimit

public ServerVoiceChannelUpdater removeUserLimit()

Queues the user limit to be removed.

Returns:

The current instance in order to chain call methods.

setCategory

public ServerVoiceChannelUpdater setCategory(ChannelCategory category)

Queues the category to be updated.

Parameters:

category - The new category of the channel.

Returns:

The current instance in order to chain call methods.

removeCategory

public ServerVoiceChannelUpdater removeCategory()

Queues the category to be removed.

Returns:

The current instance in order to chain call methods.

setAuditLogReason

public ServerVoiceChannelUpdater setAuditLogReason(String reason)

Description copied from class: ServerChannelUpdater

Sets the reason for this update. This reason will be visible in the audit log entry(s).

Overrides:

setAuditLogReason in class ServerChannelUpdater

Parameters:

reason - The reason for this update.

Returns:

The current instance in order to chain call methods.

setName

public ServerVoiceChannelUpdater setName(String name)

Description copied from class: ServerChannelUpdater

Queues the name to be updated.

Overrides:

setName in class ServerChannelUpdater

Parameters:

name - The new name of the channel.

Returns:

The current instance in order to chain call methods.

setRawPosition

public ServerVoiceChannelUpdater setRawPosition(int rawPosition)

Description copied from class: ServerChannelUpdater

Queues the raw position to be updated.

Overrides:

setRawPosition in class ServerChannelUpdater

Parameters:

rawPosition - The new position of the channel. If you want to update the position based on other channels, make sure to use ServerChannel.getRawPosition() instead of ServerChannel.getPosition()!

Returns:

The current instance in order to chain call methods.

addPermissionOverwrite

public <T extends Permissionable & DiscordEntity> ServerVoiceChannelUpdater addPermissionOverwrite(T permissionable,
                                                                                                   Permissions permissions)

Description copied from class: ServerChannelUpdater

Adds a permission overwrite for the given entity.

Overrides:

addPermissionOverwrite in class ServerChannelUpdater

Type Parameters:

T - The type of entity to hold the permission, usually User or Role

Parameters:

permissionable - The entity whose permissions should be overwritten.

permissions - The permission overwrites.

Returns:

The current instance in order to chain call methods.

removePermissionOverwrite

public <T extends Permissionable & DiscordEntity> ServerVoiceChannelUpdater removePermissionOverwrite(T permissionable)

Description copied from class: ServerChannelUpdater

Removes a permission overwrite for the given entity.

Overrides:

removePermissionOverwrite in class ServerChannelUpdater

Type Parameters:

T - The type of entity to hold the permission, usually User or Role

Parameters:

permissionable - The entity which permission overwrite should be removed.

Returns:

The current instance in order to chain call methods.

update

public CompletableFuture<Void> update()

Description copied from class: ServerChannelUpdater

Performs the queued updates.

Overrides:

update in class ServerChannelUpdater

Returns:

A future to check if the update was successful.