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

Class GuildActionImpl

java.lang.Object

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

net.dv8tion.jda.internal.requests.restaction.GuildActionImpl

All Implemented Interfaces:

RestAction<Void>, GuildAction

public class GuildActionImpl
extends RestActionImpl<Void>
implements GuildAction

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.requests.restaction.GuildAction

GuildAction.ChannelData, GuildAction.RoleData

Field Summary

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

LOG

Constructor Summary

Constructors

Constructor	Description
GuildActionImpl(JDA api, String name)

Method Summary

Modifier and Type	Method	Description
GuildActionImpl	addChannel(GuildAction.ChannelData channel)	Adds a GuildChannel to the resulting Guild.
GuildActionImpl	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
GuildAction.ChannelData	getChannel(int index)	Gets the ChannelData of the specified index.
GuildAction.RoleData	getPublicRole()	Retrieves the RoleData for the public role (Guild.getPublicRole()) for the resulting Guild.
GuildAction.RoleData	getRole(int index)	Retrieves the RoleData for the provided index.
GuildAction.ChannelData	newChannel(ChannelType type, String name)	Creates a new ChannelData instance and adds it to this GuildAction.
GuildAction.RoleData	newRole()	Creates and add a new RoleData object representing a Role for the resulting Guild.
GuildAction.ChannelData	removeChannel(int index)	Removes the ChannelData at the specified index and returns the removed object.
GuildActionImpl	removeChannel(GuildAction.ChannelData data)	Removes the provided ChannelData from this GuildAction if present.
GuildActionImpl	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
GuildActionImpl	setExplicitContentLevel(Guild.ExplicitContentLevel level)	Sets the ExplicitContentLevel for the resulting Guild
GuildActionImpl	setIcon(Icon icon)	Sets the Icon for the resulting Guild
GuildActionImpl	setName(String name)	Sets the name for the resulting Guild
GuildActionImpl	setNotificationLevel(Guild.NotificationLevel level)	Sets the NotificationLevel for the resulting Guild
GuildActionImpl	setVerificationLevel(Guild.VerificationLevel level)	Sets the VerificationLevel for the resulting Guild
GuildActionImpl	timeout(long timeout, TimeUnit unit)	Timeout for this RestAction instance.

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

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

Constructor Details

GuildActionImpl

public GuildActionImpl(JDA api,
 String name)

Method Details

setCheck

@Nonnull
public GuildActionImpl 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 GuildAction

Specified by:

setCheck in interface RestAction<Void>

Overrides:

setCheck in class RestActionImpl<Void>

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 GuildActionImpl timeout(long timeout,
 @Nonnull
 TimeUnit unit)

Description copied from interface: RestAction

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 GuildAction

Specified by:

timeout in interface RestAction<Void>

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 GuildActionImpl 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 GuildAction

Specified by:

deadline in interface RestAction<Void>

Overrides:

deadline in class RestActionImpl<Void>

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)

setIcon

@Nonnull
@CheckReturnValue
public GuildActionImpl setIcon(Icon icon)

Description copied from interface: GuildAction

Sets the Icon for the resulting Guild

Specified by:

setIcon in interface GuildAction

Parameters:

icon - The Icon to use

Returns:

The current GuildAction for chaining convenience

setName

@Nonnull
@CheckReturnValue
public GuildActionImpl setName(@Nonnull
 String name)

Description copied from interface: GuildAction

Sets the name for the resulting Guild

Specified by:

setName in interface GuildAction

Parameters:

name - The name to use

Returns:

The current GuildAction for chaining convenience

setVerificationLevel

@Nonnull
@CheckReturnValue
public GuildActionImpl setVerificationLevel(Guild.VerificationLevel level)

Description copied from interface: GuildAction

Sets the VerificationLevel for the resulting Guild

Specified by:

setVerificationLevel in interface GuildAction

Parameters:

level - The VerificationLevel to use

Returns:

The current GuildAction for chaining convenience

setNotificationLevel

@Nonnull
@CheckReturnValue
public GuildActionImpl setNotificationLevel(Guild.NotificationLevel level)

Description copied from interface: GuildAction

Sets the NotificationLevel for the resulting Guild

Specified by:

setNotificationLevel in interface GuildAction

Parameters:

level - The NotificationLevel to use

Returns:

The current GuildAction for chaining convenience

setExplicitContentLevel

@Nonnull
@CheckReturnValue
public GuildActionImpl setExplicitContentLevel(Guild.ExplicitContentLevel level)

Description copied from interface: GuildAction

Sets the ExplicitContentLevel for the resulting Guild

Specified by:

setExplicitContentLevel in interface GuildAction

Parameters:

level - The ExplicitContentLevel to use

Returns:

The current GuildAction for chaining convenience

addChannel

@Nonnull
@CheckReturnValue
public GuildActionImpl addChannel(@Nonnull
 GuildAction.ChannelData channel)

Description copied from interface: GuildAction

Adds a GuildChannel to the resulting Guild. This cannot be of type CATEGORY!

Specified by:

addChannel in interface GuildAction

Parameters:

channel - The ChannelData to use for the construction of the GuildChannel

Returns:

The current GuildAction for chaining convenience

getChannel

@Nonnull
@CheckReturnValue
public GuildAction.ChannelData getChannel(int index)

Description copied from interface: GuildAction

Gets the ChannelData of the specified index. The index is 0 based on insertion order of GuildAction.addChannel(ChannelData)!

Specified by:

getChannel in interface GuildAction

Parameters:

index - The 0 based index of the channel

Returns:

The current GuildAction for chaining convenience

removeChannel

@Nonnull
@CheckReturnValue
public GuildAction.ChannelData removeChannel(int index)

Description copied from interface: GuildAction

Removes the ChannelData at the specified index and returns the removed object.

Specified by:

removeChannel in interface GuildAction

Parameters:

index - The index of the channel

Returns:

The removed object

removeChannel

@Nonnull
@CheckReturnValue
public GuildActionImpl removeChannel(@Nonnull
 GuildAction.ChannelData data)

Description copied from interface: GuildAction

Removes the provided ChannelData from this GuildAction if present.

Specified by:

removeChannel in interface GuildAction

Parameters:

data - The ChannelData to remove

Returns:

The current GuildAction for chaining convenience

newChannel

@Nonnull
@CheckReturnValue
public GuildAction.ChannelData newChannel(@Nonnull
 ChannelType type,
 @Nonnull
 String name)

Description copied from interface: GuildAction

Creates a new ChannelData instance and adds it to this GuildAction.

Specified by:

newChannel in interface GuildAction

Parameters:

type - The ChannelType of the resulting GuildChannel
This may be of type TEXT or VOICE!

name - The name of the channel.

Returns:

The new ChannelData instance

getPublicRole

@Nonnull
@CheckReturnValue
public GuildAction.RoleData getPublicRole()

Description copied from interface: GuildAction

Retrieves the RoleData for the public role (Guild.getPublicRole()) for the resulting Guild.
The public role is also known in the official client as the @everyone role.

You can only change the permissions of the public role!

Specified by:

getPublicRole in interface GuildAction

Returns:

RoleData of the public role

getRole

@Nonnull
@CheckReturnValue
public GuildAction.RoleData getRole(int index)

Description copied from interface: GuildAction

Retrieves the RoleData for the provided index.
The public role is at the index 0 and all others are ordered by insertion order!

Specified by:

getRole in interface GuildAction

Parameters:

index - The index of the role

Returns:

RoleData of the provided index

newRole

@Nonnull
@CheckReturnValue
public GuildAction.RoleData newRole()

Description copied from interface: GuildAction

Creates and add a new RoleData object representing a Role for the resulting Guild.

This can be used in ChannelData.addPermissionOverride(...).
You may change any properties of this RoleData instance!

Specified by:

newRole in interface GuildAction

Returns:

RoleData for the new Role