discord4j.core.spec

Class VoiceChannelEditSpec

java.lang.Object

discord4j.core.spec.VoiceChannelEditSpec

All Implemented Interfaces:

AuditSpec<ChannelModifyRequest>, Spec<ChannelModifyRequest>

public class VoiceChannelEditSpec
extends Object
implements AuditSpec<ChannelModifyRequest>

Spec used to modify a VoiceChannel entity.

See Also:

Modify Channel

Constructor Summary

Constructors

Constructor and Description
VoiceChannelEditSpec()

Method Summary

Modifier and Type	Method and Description
ChannelModifyRequest	asRequest()
String	getReason() Returns the current audit log reason set on the spec.
VoiceChannelEditSpec	setBitrate(int bitrate) Sets the bitrate for the modified VoiceChannel.
VoiceChannelEditSpec	setName(String name) Sets the name for the modified VoiceChannel.
VoiceChannelEditSpec	setParentId(Snowflake parentId) Sets the parent ID for the modified VoiceChannel.
VoiceChannelEditSpec	setPermissionOverwrites(Set<? extends PermissionOverwrite> permissionOverwrites) Sets the permission overwrites for the modified VoiceChannel.
VoiceChannelEditSpec	setPosition(int position) Sets the position for the modified VoiceChannel.
VoiceChannelEditSpec	setReason(String reason) Sets the reason to show in the audit logs when the spec is built.
VoiceChannelEditSpec	setUserLimit(int userLimit) Sets the user limit for the modified VoiceChannel.

Methods inherited from class java.lang.Object

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

Constructor Detail

VoiceChannelEditSpec

public VoiceChannelEditSpec()

Method Detail

setName

public VoiceChannelEditSpec setName(String name)

Sets the name for the modified VoiceChannel.

Parameters:

name - The name of the voice channel.

Returns:

This spec.

setPosition

public VoiceChannelEditSpec setPosition(int position)

Sets the position for the modified VoiceChannel.

Parameters:

position - The raw position for the channel.

Returns:

This spec.

setPermissionOverwrites

public VoiceChannelEditSpec setPermissionOverwrites(Set<? extends PermissionOverwrite> permissionOverwrites)

Sets the permission overwrites for the modified VoiceChannel.

Parameters:

permissionOverwrites - The Set<PermissionOverwrite> which contains overwrites for the channel.

Returns:

This spec.

setParentId

public VoiceChannelEditSpec setParentId(@Nullable
                                        Snowflake parentId)

Sets the parent ID for the modified VoiceChannel.

The parent ID is equivalent to a Category ID.

Parameters:

parentId - The Snowflake of the parent Category.

Returns:

This spec.

setBitrate

public VoiceChannelEditSpec setBitrate(int bitrate)

Sets the bitrate for the modified VoiceChannel.

Parameters:

bitrate - The maximum amount of bits to send per second in the voice channel, related to the quality of audio. A valid bitrate is a number from 8 to 96.

Returns:

This spec.

setUserLimit

public VoiceChannelEditSpec setUserLimit(int userLimit)

Sets the user limit for the modified VoiceChannel.

Users with Permission.MOVE_MEMBERS ignore this limit and can also move other users into the channel past the limit.

Parameters:

userLimit - The maximum number of users that can join the voice channel at once.

Returns:

This spec.

setReason

public VoiceChannelEditSpec setReason(@Nullable
                                      String reason)

Description copied from interface: AuditSpec

Sets the reason to show in the audit logs when the spec is built.

Specified by:

setReason in interface AuditSpec<ChannelModifyRequest>

Parameters:

reason - The audit log reason.

Returns:

This spec.

getReason

@Nullable
public String getReason()

Description copied from interface: AuditSpec

Returns the current audit log reason set on the spec.

Specified by:

getReason in interface AuditSpec<ChannelModifyRequest>

Returns:

The current audit log reason.

asRequest

public ChannelModifyRequest asRequest()

Specified by:

asRequest in interface Spec<ChannelModifyRequest>