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

Class CategoryOrderAction<T extends Channel>

java.lang.Object

net.dv8tion.jda.core.requests.RestAction<java.lang.Void>

net.dv8tion.jda.core.requests.restaction.order.OrderAction<T,ChannelOrderAction<T>>

net.dv8tion.jda.core.requests.restaction.order.ChannelOrderAction<T>

net.dv8tion.jda.core.requests.restaction.order.CategoryOrderAction<T>

Type Parameters:

T - The type of Channel to move using this CategoryOrderAction, either TextChannel, or VoiceChannel.

public class CategoryOrderAction<T extends Channel>
extends ChannelOrderAction<T>

An extension of ChannelOrderAction with similar functionality, but constrained to the bounds of a single Category.
To apply the changes you must finish the RestAction.

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

Author:

Kaidan Gustave

Nested Class Summary

Nested classes/interfaces inherited from class net.dv8tion.jda.core.requests.RestAction

RestAction.EmptyRestAction<T>

Field Summary

Fields inherited from class net.dv8tion.jda.core.requests.RestAction

DEFAULT_FAILURE, DEFAULT_SUCCESS, LOG

Constructor Summary

Constructors

Constructor	Description
CategoryOrderAction(Category category, ChannelType type)	Creates a new CategoryOrderAction for the specified Category

Method Summary

Modifier and Type	Method	Description
Category	getCategory()	Gets the Category controlled by this CategoryOrderAction.

Methods inherited from class net.dv8tion.jda.core.requests.restaction.order.ChannelOrderAction

getChannelType, getGuild

Methods inherited from class java.lang.Object

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

Methods inherited from class net.dv8tion.jda.core.requests.restaction.order.OrderAction

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

Methods inherited from class net.dv8tion.jda.core.requests.RestAction

complete, complete, completeAfter, getJDA, isPassContext, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, setPassContext, submit, submit, submitAfter, submitAfter

Constructor Detail

CategoryOrderAction

public CategoryOrderAction(Category category,
                           ChannelType type)

Creates a new CategoryOrderAction for the specified Category

Parameters:

category - The target Category which the new CategoryOrderAction will order channels from.

type - The ChannelType that matches the returning value of Channel#getType() for the generic Channel type T.

Throws:

java.lang.IllegalArgumentException - If the ChannelType is not one that can be retrieved from a Category. Currently the only two allowed are ChannelType.TEXT and ChannelType.VOICE.

Method Detail

getCategory

@Nonnull
public Category getCategory()

Gets the Category controlled by this CategoryOrderAction.

Returns:

The Category of this CategoryOrderAction.