Package net.dv8tion.jda.internal.requests.restaction

Class RoleActionImpl

java.lang.Object

net.dv8tion.jda.internal.requests.RestActionImpl<Role>

net.dv8tion.jda.internal.requests.restaction.AuditableRestActionImpl<Role>

net.dv8tion.jda.internal.requests.restaction.RoleActionImpl

All Implemented Interfaces:

RestAction<Role>, AuditableRestAction<Role>, RoleAction

public class RoleActionImpl
extends AuditableRestActionImpl<Role>
implements RoleAction

Field Summary

Fields inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

LOG

Fields inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction

MAX_REASON_LENGTH

Constructor Summary

Constructors

Constructor	Description
RoleActionImpl(Guild guild)	Creates a new RoleAction instance

Method Summary

Modifier and Type	Method	Description
RoleActionImpl	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
Guild	getGuild()	The guild to create the role in
RoleActionImpl	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
RoleActionImpl	setColor(Integer rgb)	Sets the Color for the new role.
RoleActionImpl	setHoisted(Boolean hoisted)	Sets whether or not the new role should be hoisted
RoleActionImpl	setIcon(String emoji)	Sets the Unicode Emoji of this Role instead of a custom image.
RoleActionImpl	setIcon(Icon icon)	Sets the Icon of this Role.
RoleActionImpl	setMentionable(Boolean mentionable)	Sets whether the new role should be mentionable by members of the parent Guild.
RoleActionImpl	setName(String name)	Sets the name for new role (optional)
RoleActionImpl	setPermissions(Long permissions)	Sets the Permissions the new Role should have.
RoleActionImpl	timeout(long timeout, TimeUnit unit)	Timeout for this RestAction instance.

Methods inherited from class net.dv8tion.jda.internal.requests.restaction.AuditableRestActionImpl

reason

Methods inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

complete, getCheck, getDefaultFailure, getDefaultSuccess, getDefaultTimeout, getJDA, handleResponse, isPassContext, priority, queue, setDefaultFailure, setDefaultSuccess, setDefaultTimeout, setErrorMapper, setPassContext, submit

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction

reason

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, onSuccess, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter, zip

Methods inherited from interface net.dv8tion.jda.api.requests.restaction.RoleAction

setColor, setIcon, setPermissions, setPermissions

Constructor Details

RoleActionImpl

public RoleActionImpl(Guild guild)

Creates a new RoleAction instance

Parameters:

guild - The Guild for which the Role should be created.

Method Details

setCheck

@Nonnull
public RoleActionImpl setCheck(BooleanSupplier checks)

Description copied from interface: RestAction

Sets the last-second checks before finally executing the http request in the queue.
If the provided supplier evaluates to false or throws an exception this will not be finished. When an exception is thrown from the supplier it will be provided to the failure callback.

Specified by:

setCheck in interface AuditableRestAction<Role>

Specified by:

setCheck in interface RestAction<Role>

Specified by:

setCheck in interface RoleAction

Overrides:

setCheck in class AuditableRestActionImpl<Role>

Parameters:

checks - The checks to run before executing the request, or null to run no checks

Returns:

The current RestAction for chaining convenience

See Also:

• RestAction.getCheck()
• RestAction.addCheck(BooleanSupplier)

timeout

@Nonnull
public RoleActionImpl timeout(long timeout,
 @Nonnull
 TimeUnit unit)

Description copied from interface: AuditableRestAction

Timeout for this RestAction instance.
If the request doesn't get executed within the timeout it will fail.

When a RestAction times out, it will fail with a TimeoutException. This is the same as deadline(System.currentTimeMillis() + unit.toMillis(timeout)).

Example

 action.timeout(10, TimeUnit.SECONDS) // 10 seconds from now
       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
 

Specified by:

timeout in interface AuditableRestAction<Role>

Specified by:

timeout in interface RestAction<Role>

Specified by:

timeout in interface RoleAction

Overrides:

timeout in class AuditableRestActionImpl<Role>

Parameters:

timeout - The timeout to use

unit - Unit for the timeout value

Returns:

The same RestAction instance with the applied timeout

See Also:

• RestAction.setDefaultTimeout(long, TimeUnit)

deadline

@Nonnull
public RoleActionImpl deadline(long timestamp)

Description copied from interface: RestAction

Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
If the deadline is reached, the request will fail with a TimeoutException.

This does not mean that the request will immediately timeout when the deadline is reached. JDA will check the deadline right before executing the request or within intervals in a worker thread. This only means the request will timeout if the deadline has passed.

Example

 action.deadline(System.currentTimeMillis() + 10000) // 10 seconds from now
       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
 

Specified by:

deadline in interface AuditableRestAction<Role>

Specified by:

deadline in interface RestAction<Role>

Specified by:

deadline in interface RoleAction

Overrides:

deadline in class AuditableRestActionImpl<Role>

Parameters:

timestamp - Millisecond timestamp at which the request will timeout

Returns:

The same RestAction with the applied deadline

See Also:

• RestAction.timeout(long, TimeUnit)
• RestAction.setDefaultTimeout(long, TimeUnit)

getGuild

@Nonnull
public Guild getGuild()

Description copied from interface: RoleAction

The guild to create the role in

Specified by:

getGuild in interface RoleAction

Returns:

The guild

setName

@Nonnull
@CheckReturnValue
public RoleActionImpl setName(String name)

Description copied from interface: RoleAction

Sets the name for new role (optional)

Specified by:

setName in interface RoleAction

Parameters:

name - The name for the new role, null to use default name

Returns:

The current RoleAction, for chaining convenience

setHoisted

@Nonnull
@CheckReturnValue
public RoleActionImpl setHoisted(Boolean hoisted)

Description copied from interface: RoleAction

Sets whether or not the new role should be hoisted

Specified by:

setHoisted in interface RoleAction

Parameters:

hoisted - Whether the new role should be hoisted (grouped). Default is false

Returns:

The current RoleAction, for chaining convenience

setMentionable

@Nonnull
@CheckReturnValue
public RoleActionImpl setMentionable(Boolean mentionable)

Description copied from interface: RoleAction

Sets whether the new role should be mentionable by members of the parent Guild.

Specified by:

setMentionable in interface RoleAction

Parameters:

mentionable - Whether the new role should be mentionable. Default is false

Returns:

The current RoleAction, for chaining convenience

setColor

@Nonnull
@CheckReturnValue
public RoleActionImpl setColor(Integer rgb)

Description copied from interface: RoleAction

Sets the Color for the new role. This accepts colors from the range 0x000 to 0xFFFFFF. The provided value will be ranged using rbg & 0xFFFFFF

Specified by:

setColor in interface RoleAction

Parameters:

rgb - The color for the new role in integer form, null to use default white/black

Returns:

The current RoleAction, for chaining convenience

setPermissions

@Nonnull
@CheckReturnValue
public RoleActionImpl setPermissions(Long permissions)

Description copied from interface: RoleAction

Sets the Permissions the new Role should have. This will only allow permissions that the current account already holds unless the account is owner or admin of the parent Guild.

Specified by:

setPermissions in interface RoleAction

Parameters:

permissions - The raw Permissions value for the new role. To retrieve this use Permission.getRawValue()

Returns:

The current RoleAction, for chaining convenience

See Also:

• Permission.getRawValue()
• Permission.getRaw(java.util.Collection)
• Permission.getRaw(net.dv8tion.jda.api.Permission...)

setIcon

@Nonnull
@CheckReturnValue
public RoleActionImpl setIcon(Icon icon)

Description copied from interface: RoleAction

Sets the Icon of this Role. This icon will be displayed next to the role's name in the members tab and in chat.

Specified by:

setIcon in interface RoleAction

Parameters:

icon - The new icon for this Role or null to reset

Returns:

The current RoleAction, for chaining convenience

setIcon

@Nonnull
@CheckReturnValue
public RoleActionImpl setIcon(String emoji)

Description copied from interface: RoleAction

Sets the Unicode Emoji of this Role instead of a custom image. This emoji will be displayed next to the role's name in the members tab and in chat.

Specified by:

setIcon in interface RoleAction

Parameters:

emoji - The new Unicode emoji for this Role or null to reset

Returns:

The current RoleAction, for chaining convenience