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

Class RoleOrderAction

java.lang.Object

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

net.dv8tion.jda.core.requests.restaction.order.OrderAction<Role,RoleOrderAction>

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

public class RoleOrderAction
extends OrderAction<Role,RoleOrderAction>

Implementation of OrderAction designed to modify the order of Roles of the specified Guild.
To apply the changes you must finish the RestAction

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

This uses descending order!

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
RoleOrderAction(Guild guild, boolean useDiscordOrder)	Creates a new RoleOrderAction instance

Method Summary

Modifier and Type	Method	Description
Guild	getGuild()	The Guild which holds the roles 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

RoleOrderAction

public RoleOrderAction(Guild guild,
                       boolean useDiscordOrder)

Creates a new RoleOrderAction instance

Parameters:

guild - The target Guild of which to change the Role order

useDiscordOrder - Defines the ordering of the OrderAction. If true, the OrderAction will be in the ordering defined by Discord for roles, which is Descending. This means that the highest role appears at index 0 and the lowest role at index n - 1. Providing false will result in the ordering being in ascending order, with the lower role at index 0 and the highest at index n - 1.
As a note: Member.getRoles() and Guild.getRoles() are both in descending order.

Method Detail

getGuild

public Guild getGuild()

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

Returns:

The corresponding Guild