Package net.dv8tion.jda.api.requests.restaction.order

Interface ChannelOrderAction

All Superinterfaces:

OrderAction<GuildChannel,ChannelOrderAction>, RestAction<Void>

All Known Subinterfaces:

CategoryOrderAction

public interface ChannelOrderAction
extends OrderAction<GuildChannel,ChannelOrderAction>

Implementation of OrderAction to modify the order of Channels for a Guild.
To apply the changes you must finish the RestAction.

Before you can use any of the move methods you must use either selectPosition(GuildChannel) or OrderAction.selectPosition(int)!

Since:

3.0

See Also:

• Guild
• Guild.modifyTextChannelPositions()
• Guild.modifyVoiceChannelPositions()
• Guild.modifyCategoryPositions()
• CategoryOrderAction

Method Summary

Modifier and Type	Method	Description
default EnumSet<ChannelType>	getChannelTypes()	The ChannelTypes for the sorting bucket.
Guild	getGuild()	The Guild which holds the channels from OrderAction.getCurrentOrder()
int	getSortBucket()	The sorting bucket for this order action.

Methods inherited from interface net.dv8tion.jda.api.requests.restaction.order.OrderAction

deadline, getCurrentOrder, getSelectedEntity, getSelectedPosition, isAscendingOrder, moveDown, moveTo, moveUp, reverseOrder, selectPosition, selectPosition, setCheck, shuffleOrder, sortOrder, swapPosition, swapPosition, timeout

Methods inherited from interface net.dv8tion.jda.api.requests.RestAction

addCheck, and, and, complete, complete, completeAfter, delay, delay, delay, delay, flatMap, flatMap, getCheck, getJDA, map, mapToResult, onErrorFlatMap, onErrorFlatMap, onErrorMap, onErrorMap, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter, zip

Method Details

getGuild

@Nonnull
Guild getGuild()

The Guild which holds the channels from OrderAction.getCurrentOrder()

Returns:

The corresponding Guild

getSortBucket

int getSortBucket()

The sorting bucket for this order action.
Multiple different ChannelTypes can share a common sorting bucket.

Returns:

The sorting bucket

getChannelTypes

@Nonnull
default EnumSet<ChannelType> getChannelTypes()

The ChannelTypes for the sorting bucket.

Returns:

The channel types

See Also:

• ChannelType.fromSortBucket(int)