Package net.dv8tion.jda.api.entities.channel.attribute

Interface IVoiceStatusChannel

All Superinterfaces:

Channel, Formattable, IMentionable, ISnowflake

All Known Subinterfaces:

VoiceChannel

public interface IVoiceStatusChannel
extends Channel

Channel with a modifiable voice status.
This can be used to indicate what is going on to people outside the channel.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_STATUS_LENGTH	The maximum length of a voice status 500

Fields inherited from interface net.dv8tion.jda.api.entities.channel.Channel

MAX_NAME_LENGTH

Method Summary

Modifier and Type	Method	Description
String	getStatus()	The current voice channel status.
AuditableRestAction<Void>	modifyStatus(String status)	Change the current voice channel status.

Methods inherited from interface net.dv8tion.jda.api.entities.channel.Channel

delete, formatTo, getAsMention, getFlags, getJDA, getName, getType

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Field Details

MAX_STATUS_LENGTH

static final int MAX_STATUS_LENGTH

The maximum length of a voice status 500

See Also:

• Constant Field Values

Method Details

getStatus

@Nonnull
String getStatus()

The current voice channel status.
This can be configured by users who are connected and have the set voice channel status permission.

Returns:

The current voice channel status, or empty string if unset

modifyStatus

@Nonnull
@CheckReturnValue
AuditableRestAction<Void> modifyStatus(@Nonnull
 String status)

Change the current voice channel status.
This can be configured by users who are connected and have the set voice channel status permission.

Parameters:

status - The new status, or empty to unset

Returns:

AuditableRestAction

Throws:

IllegalArgumentException - If the status is null or longer than 500 characters

MissingAccessException - If the currently logged in account does not have Permission.VIEW_CHANNEL in this channel

InsufficientPermissionException -

• If the currently logged in account is not connected and does not have the MANAGE_CHANNEL permission.
• If the currently logged in account is connected and does not have the VOICE_SET_STATUS permission.