Package discord4j.core.spec.legacy
Class LegacyVoiceChannelCreateSpec
- java.lang.Object
-
- discord4j.core.spec.legacy.LegacyVoiceChannelCreateSpec
-
- All Implemented Interfaces:
LegacyAuditSpec<discord4j.discordjson.json.ChannelCreateRequest>
,LegacySpec<discord4j.discordjson.json.ChannelCreateRequest>
public class LegacyVoiceChannelCreateSpec extends Object implements LegacyAuditSpec<discord4j.discordjson.json.ChannelCreateRequest>
A spec used to configure and create aVoiceChannel
.
-
-
Constructor Summary
Constructors Constructor Description LegacyVoiceChannelCreateSpec()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description discord4j.discordjson.json.ChannelCreateRequest
asRequest()
String
getReason()
Returns the current audit log reason set on the spec.LegacyVoiceChannelCreateSpec
setBitrate(int bitrate)
Sets the bitrate for the createdVoiceChannel
.LegacyVoiceChannelCreateSpec
setName(String name)
Sets the name for the createdVoiceChannel
.LegacyVoiceChannelCreateSpec
setParentId(Snowflake parentId)
Sets the parent ID for the createdVoiceChannel
.LegacyVoiceChannelCreateSpec
setPermissionOverwrites(Set<? extends PermissionOverwrite> permissionOverwrites)
Sets the permission overwrites for the createdVoiceChannel
.LegacyVoiceChannelCreateSpec
setPosition(int position)
Sets the position for the createdVoiceChannel
.LegacyVoiceChannelCreateSpec
setReason(String reason)
Sets the reason to show in the audit logs when the spec is built.LegacyVoiceChannelCreateSpec
setUserLimit(int userLimit)
Sets the user limit for the createdVoiceChannel
.
-
-
-
Method Detail
-
setName
public LegacyVoiceChannelCreateSpec setName(String name)
Sets the name for the createdVoiceChannel
.- Parameters:
name
- The name of the voice channel.- Returns:
- This spec.
-
setBitrate
public LegacyVoiceChannelCreateSpec setBitrate(int bitrate)
Sets the bitrate for the createdVoiceChannel
.- 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 LegacyVoiceChannelCreateSpec setUserLimit(int userLimit)
Sets the user limit for the createdVoiceChannel
.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.
-
setPosition
public LegacyVoiceChannelCreateSpec setPosition(int position)
Sets the position for the createdVoiceChannel
.- Parameters:
position
- The raw position for the channel.- Returns:
- This spec.
-
setPermissionOverwrites
public LegacyVoiceChannelCreateSpec setPermissionOverwrites(Set<? extends PermissionOverwrite> permissionOverwrites)
Sets the permission overwrites for the createdVoiceChannel
.- Parameters:
permissionOverwrites
- TheSet<PermissionOverwrite>
which contains overwrites for the channel.- Returns:
- This spec.
-
setParentId
public LegacyVoiceChannelCreateSpec setParentId(@Nullable Snowflake parentId)
Sets the parent ID for the createdVoiceChannel
.The parent ID is equivalent to a
Category
ID.- Parameters:
parentId
- TheSnowflake
of the parentCategory
.- Returns:
- This spec.
-
setReason
public LegacyVoiceChannelCreateSpec setReason(@Nullable String reason)
Description copied from interface:LegacyAuditSpec
Sets the reason to show in the audit logs when the spec is built.- Specified by:
setReason
in interfaceLegacyAuditSpec<discord4j.discordjson.json.ChannelCreateRequest>
- Parameters:
reason
- The audit log reason.- Returns:
- This spec.
-
getReason
@Nullable public String getReason()
Description copied from interface:LegacyAuditSpec
Returns the current audit log reason set on the spec.- Specified by:
getReason
in interfaceLegacyAuditSpec<discord4j.discordjson.json.ChannelCreateRequest>
- Returns:
- The current audit log reason.
-
asRequest
public discord4j.discordjson.json.ChannelCreateRequest asRequest()
- Specified by:
asRequest
in interfaceLegacySpec<discord4j.discordjson.json.ChannelCreateRequest>
-
-