Interface ChannelOrderAction
-
- All Superinterfaces:
OrderAction<GuildChannel,ChannelOrderAction>
,RestAction<Void>
- All Known Subinterfaces:
CategoryOrderAction
public interface ChannelOrderAction extends OrderAction<GuildChannel,ChannelOrderAction>
Implementation ofOrderAction
to modify the order ofChannels
for aGuild
.
To apply the changes you must finish theRestAction
.Before you can use any of the
move
methods you must use eitherselectPosition(GuildChannel)
orOrderAction.selectPosition(int)
!
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default EnumSet<ChannelType>
getChannelTypes()
TheChannelTypes
for thesorting bucket
.Guild
getGuild()
TheGuild
which holds the channels fromOrderAction.getCurrentOrder()
int
getSortBucket()
The sorting bucket for this order action.-
Methods inherited from interface net.dv8tion.jda.api.requests.restaction.order.OrderAction
getCurrentOrder, getSelectedEntity, getSelectedPosition, isAscendingOrder, moveDown, moveTo, moveUp, reverseOrder, selectPosition, selectPosition, setCheck, shuffleOrder, sortOrder, swapPosition, swapPosition
-
Methods inherited from interface net.dv8tion.jda.api.requests.RestAction
complete, complete, completeAfter, getJDA, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter
-
-
-
-
Method Detail
-
getGuild
@Nonnull Guild getGuild()
TheGuild
which holds the channels fromOrderAction.getCurrentOrder()
- Returns:
- The corresponding
Guild
-
getSortBucket
int getSortBucket()
The sorting bucket for this order action.
Multiple differentChannelTypes
can share a common sorting bucket.- Returns:
- The sorting bucket
-
getChannelTypes
@Nonnull default EnumSet<ChannelType> getChannelTypes()
TheChannelTypes
for thesorting bucket
.- Returns:
- The channel types
- See Also:
ChannelType.fromSortBucket(int)
-
-