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

Class ChannelOrderAction<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>

Type Parameters:

T - The type of Channel defining which channels to order

Direct Known Subclasses:

CategoryOrderAction

public class ChannelOrderAction<T extends Channel>
extends OrderAction<T,ChannelOrderAction<T>>

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(Channel) or OrderAction.selectPosition(int)!

Since:

3.0

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
ChannelOrderAction(Guild guild, ChannelType type)	Creates a new ChannelOrderAction instance
ChannelOrderAction(Guild guild, ChannelType type, java.util.Collection<T> channels)	Creates a new ChannelOrderAction instance using the provided Guild, as well as the provided list of Channels.

Method Summary

Modifier and Type	Method	Description
ChannelType	getChannelType()	The ChannelType of all channels that are ordered by this ChannelOrderAction
Guild	getGuild()	The Guild which holds the channels from OrderAction.getCurrentOrder()

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

ChannelOrderAction

public ChannelOrderAction(Guild guild,
                          ChannelType type)

Creates a new ChannelOrderAction instance

Parameters:

guild - The target Guild of which to order the channels defined by the specified type

type - The ChannelType corresponding to the generic type of Channel which defines the type of channel that will be ordered.

Throws:

java.lang.IllegalArgumentException - If one of the specified Guild has no channels of the ChannelType.

ChannelOrderAction

public ChannelOrderAction(Guild guild,
                          ChannelType type,
                          java.util.Collection<T> channels)

Creates a new ChannelOrderAction instance using the provided Guild, as well as the provided list of Channels.

Parameters:

guild - The target Guild of which to order the channels defined by the specified type

type - The ChannelType corresponding to the generic type of Channel which defines the type of channel that will be ordered.

channels - The Channels to order, all of which are on the same Guild specified, and all of which are of the same generic type of Channel corresponding to the the ChannelType specified.

Throws:

java.lang.IllegalArgumentException - If the channels are null, an empty collection, or any of them do not have the same ChannelType as the one provided.

Method Detail

getGuild

public Guild getGuild()

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

Returns:

The corresponding Guild

getChannelType

public ChannelType getChannelType()

The ChannelType of all channels that are ordered by this ChannelOrderAction

Returns:

The corresponding ChannelType