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

Class ChannelActionImpl<T extends GuildChannel>

java.lang.Object

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

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

net.dv8tion.jda.internal.requests.restaction.ChannelActionImpl<T>

All Implemented Interfaces:

RestAction<T>, AuditableRestAction<T>, ChannelAction<T>, FluentAuditableRestAction<T,ChannelAction<T>>

public class ChannelActionImpl<T extends GuildChannel>
extends AuditableRestActionImpl<T>
implements ChannelAction<T>

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
ChannelActionImpl(Class<T> clazz, String name, Guild guild, ChannelType type)

Method Summary

Modifier and Type	Method	Description
ChannelActionImpl<T>	addMemberPermissionOverride(long userId, long allow, long deny)	Adds a new Member PermissionOverride for the new GuildChannel.
ChannelActionImpl<T>	addRolePermissionOverride(long roleId, long allow, long deny)	Adds a new Role PermissionOverride for the new GuildChannel.
ChannelAction<T>	clearPermissionOverrides()	Removes all currently configured permission overrides
ChannelActionImpl<T>	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 this GuildChannel in
ChannelType	getType()	The ChannelType for the resulting channel
ChannelActionImpl<T>	reason(String reason)	Applies the specified reason as audit-log reason field.
ChannelAction<T>	removePermissionOverride(long id)	Removes any existing override with the provided id.
ChannelAction<T>	setAvailableTags(List<? extends BaseForumTag> tags)	Sets the available tags of the channel.
ChannelActionImpl<T>	setBitrate(Integer bitrate)	Sets the bitrate for the new VoiceChannel
ChannelActionImpl<T>	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
ChannelAction<T>	setDefaultLayout(ForumChannel.Layout layout)	Sets the default layout of the new ForumChannel.
ChannelAction<T>	setDefaultReaction(Emoji emoji)	Sets the default reaction emoji of the channel.
ChannelAction<T>	setDefaultSortOrder(IPostContainer.SortOrder sortOrder)	Sets the default sort order of the channel.
ChannelAction<T>	setDefaultThreadSlowmode(int slowmode)	Sets the slowmode value, which limits the amount of time that individual users must wait between sending messages in the new channel.
ChannelActionImpl<T>	setName(String name)	Sets the name for the new GuildChannel
ChannelActionImpl<T>	setNSFW(boolean nsfw)	Sets the NSFW flag for the channel
ChannelActionImpl<T>	setParent(Category category)	Sets the Category for the new GuildChannel.
ChannelActionImpl<T>	setPosition(Integer position)	Sets the position where the new Channel should be inserted into.
ChannelActionImpl<T>	setRegion(Region region)	Sets the voice region for the new AudioChannel
ChannelActionImpl<T>	setSlowmode(int slowmode)	Sets the slowmode value, which limits the amount of time that individual users must wait between sending messages in the new channel.
ChannelActionImpl<T>	setTopic(String topic)	Sets the topic for the channel
ChannelActionImpl<T>	setUserlimit(Integer userlimit)	Sets the userlimit for the new AudioChannel.
ChannelAction<T>	syncPermissionOverrides()	Syncs the permission overrides of the channel with the category.
ChannelActionImpl<T>	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.ChannelAction

addMemberPermissionOverride, addPermissionOverride, addPermissionOverride, addRolePermissionOverride, removePermissionOverride, removePermissionOverride

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

addCheck

Methods inherited from interface net.dv8tion.jda.api.requests.RestAction

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

ChannelActionImpl

public ChannelActionImpl(Class<T> clazz,
 String name,
 Guild guild,
 ChannelType type)

Method Details

reason

@Nonnull
public ChannelActionImpl<T> reason(@Nullable
 String reason)

Description copied from interface: AuditableRestAction

Applies the specified reason as audit-log reason field.
When the provided reason is empty or null it will be treated as not set. If the provided reason is longer than 512<T> characters, it will be truncated to fit the limit.

Reasons for any AuditableRestAction may be retrieved via AuditLogEntry.getReason() in iterable AuditLogPaginationActions from Guild.retrieveAuditLogs()! For guild bans, this is also accessible via Guild.Ban.getReason().

This will specify the reason via the X-Audit-Log-Reason Request Header.

Specified by:

reason in interface AuditableRestAction<T extends GuildChannel>

Specified by:

reason in interface FluentAuditableRestAction<T extends GuildChannel,ChannelAction<T extends GuildChannel>>

Overrides:

reason in class AuditableRestActionImpl<T extends GuildChannel>

Parameters:

reason - The reason for this action which should be logged in the Guild's AuditLogs (up to 512<T> characters)

Returns:

The current AuditableRestAction instance for chaining convenience

See Also:

• ThreadLocalReason

setCheck

@Nonnull
public ChannelActionImpl<T> 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<T extends GuildChannel>

Specified by:

setCheck in interface FluentAuditableRestAction<T extends GuildChannel,ChannelAction<T extends GuildChannel>>

Specified by:

setCheck in interface RestAction<T extends GuildChannel>

Overrides:

setCheck in class AuditableRestActionImpl<T extends GuildChannel>

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 ChannelActionImpl<T> 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<T extends GuildChannel>

Specified by:

timeout in interface FluentAuditableRestAction<T extends GuildChannel,ChannelAction<T extends GuildChannel>>

Specified by:

timeout in interface RestAction<T extends GuildChannel>

Overrides:

timeout in class AuditableRestActionImpl<T extends GuildChannel>

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 ChannelActionImpl<T> 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<T extends GuildChannel>

Specified by:

deadline in interface FluentAuditableRestAction<T extends GuildChannel,ChannelAction<T extends GuildChannel>>

Specified by:

deadline in interface RestAction<T extends GuildChannel>

Overrides:

deadline in class AuditableRestActionImpl<T extends GuildChannel>

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: ChannelAction

The guild to create this GuildChannel in

Specified by:

getGuild in interface ChannelAction<T extends GuildChannel>

Returns:

The guild

getType

@Nonnull
public ChannelType getType()

Description copied from interface: ChannelAction

The ChannelType for the resulting channel

Specified by:

getType in interface ChannelAction<T extends GuildChannel>

Returns:

The channel type

setName

@Nonnull
@CheckReturnValue
public ChannelActionImpl<T> setName(@Nonnull
 String name)

Description copied from interface: ChannelAction

Sets the name for the new GuildChannel

Specified by:

setName in interface ChannelAction<T extends GuildChannel>

Parameters:

name - The not-null name for the new GuildChannel (1-100 characters long)

Returns:

The current ChannelAction, for chaining convenience

setParent

@Nonnull
@CheckReturnValue
public ChannelActionImpl<T> setParent(Category category)

Description copied from interface: ChannelAction

Sets the Category for the new GuildChannel.

You can use ChannelAction.syncPermissionOverrides() to sync the channel with the category.

Specified by:

setParent in interface ChannelAction<T extends GuildChannel>

Parameters:

category - The parent for the new GuildChannel

Returns:

The current ChannelAction, for chaining convenience

See Also:

• ChannelAction.syncPermissionOverrides()

setPosition

@Nonnull
@CheckReturnValue
public ChannelActionImpl<T> setPosition(Integer position)

Description copied from interface: ChannelAction

Sets the position where the new Channel should be inserted into. This refers to the raw position value, not the computed (relative) position.

By default (or by providing this method with null), the position will automatically be computed based on the other Channels (inserted last in its respective group).

Note: This does not shift the position values of existing Channels if the values collide.
As a reminder: The ordering of Channels is determined first by its Category's position, then by its raw position value and finally by its id (younger Channels are below older ones)

Specified by:

setPosition in interface ChannelAction<T extends GuildChannel>

Parameters:

position - The raw position value that should be used for the new Channel

Returns:

The current ChannelAction, for chaining convenience

setTopic

@Nonnull
@CheckReturnValue
public ChannelActionImpl<T> setTopic(String topic)

Description copied from interface: ChannelAction

Sets the topic for the channel

Specified by:

setTopic in interface ChannelAction<T extends GuildChannel>

Parameters:

topic - The topic for the new GuildChannel

Returns:

The current ChannelAction, for chaining convenience

setNSFW

@Nonnull
@CheckReturnValue
public ChannelActionImpl<T> setNSFW(boolean nsfw)

Description copied from interface: ChannelAction

Sets the NSFW flag for the channel

Specified by:

setNSFW in interface ChannelAction<T extends GuildChannel>

Parameters:

nsfw - The NSFW flag for the new GuildChannel

Returns:

The current ChannelAction, for chaining convenience

setSlowmode

@Nonnull
@CheckReturnValue
public ChannelActionImpl<T> setSlowmode(int slowmode)

Description copied from interface: ChannelAction

Sets the slowmode value, which limits the amount of time that individual users must wait between sending messages in the new channel. This is measured in seconds.

Note: Bots are unaffected by this.
Having MESSAGE_MANAGE or MANAGE_CHANNEL permission also grants immunity to slowmode.

Specified by:

setSlowmode in interface ChannelAction<T extends GuildChannel>

Parameters:

slowmode - The number of seconds required to wait between sending messages in the channel.

Returns:

The current ChannelAction, for chaining convenience

setDefaultThreadSlowmode

@Nonnull
public ChannelAction<T> setDefaultThreadSlowmode(int slowmode)

Description copied from interface: ChannelAction

Sets the slowmode value, which limits the amount of time that individual users must wait between sending messages in the new channel. This is measured in seconds.
This is applied to newly created threads by default.

Note: Bots are unaffected by this.
Having MESSAGE_MANAGE or MANAGE_CHANNEL permission also grants immunity to slowmode.

Specified by:

setDefaultThreadSlowmode in interface ChannelAction<T extends GuildChannel>

Parameters:

slowmode - The number of seconds required to wait between sending messages in the channel.

Returns:

The current ChannelAction, for chaining convenience

setDefaultReaction

@Nonnull
public ChannelAction<T> setDefaultReaction(@Nullable
 Emoji emoji)

Description copied from interface: ChannelAction

Sets the default reaction emoji of the channel.
This does not support custom emoji from other guilds.

Specified by:

setDefaultReaction in interface ChannelAction<T extends GuildChannel>

Parameters:

emoji - The new default reaction emoji, or null to unset.

Returns:

The current ChannelAction, for chaining convenience

See Also:

• IPostContainer.getDefaultReaction()

setDefaultLayout

@Nonnull
public ChannelAction<T> setDefaultLayout(@Nonnull
 ForumChannel.Layout layout)

Description copied from interface: ChannelAction

Sets the default layout of the new ForumChannel.

Specified by:

setDefaultLayout in interface ChannelAction<T extends GuildChannel>

Parameters:

layout - The new default layout.

Returns:

The current ChannelAction, for chaining convenience

See Also:

• ForumChannel.getDefaultLayout()

setDefaultSortOrder

@Nonnull
public ChannelAction<T> setDefaultSortOrder(@Nonnull
 IPostContainer.SortOrder sortOrder)

Description copied from interface: ChannelAction

Sets the default sort order of the channel.

Specified by:

setDefaultSortOrder in interface ChannelAction<T extends GuildChannel>

Parameters:

sortOrder - The new default sort order.

Returns:

The current ChannelAction, for chaining convenience

See Also:

• IPostContainer.getDefaultSortOrder()

setAvailableTags

@Nonnull
public ChannelAction<T> setAvailableTags(@Nonnull
 List<? extends BaseForumTag> tags)

Description copied from interface: ChannelAction

Sets the available tags of the channel.
Tags will be ordered based on the provided list order.

You can use ForumTagData to create new tags.

Specified by:

setAvailableTags in interface ChannelAction<T extends GuildChannel>

Parameters:

tags - The new available tags in the desired order.

Returns:

The current ChannelAction, for chaining convenience

See Also:

• IPostContainer.getAvailableTags()

addMemberPermissionOverride

@Nonnull
@CheckReturnValue
public ChannelActionImpl<T> addMemberPermissionOverride(long userId,
 long allow,
 long deny)

Description copied from interface: ChannelAction

Adds a new Member PermissionOverride for the new GuildChannel.

If setting permission overwrites, only permissions your bot has in the guild can be allowed/denied.

Example:

 long userId = user.getIdLong();
 long allow = Permission.VIEW_CHANNEL.getRawValue();
 long deny = Permission.MESSAGE_SEND.getRawValue() | Permission.MESSAGE_ADD_REACTION.getRawValue();
 channelAction.addMemberPermissionOverride(userId, allow, deny);
 

Specified by:

addMemberPermissionOverride in interface ChannelAction<T extends GuildChannel>

Parameters:

userId - The id for the member

allow - The granted Permissions for the override. Use Permission.getRawValue() to retrieve these Permissions.

deny - The denied Permissions for the override. Use Permission.getRawValue() to retrieve these Permissions.

Returns:

The current ChannelAction, for chaining convenience

See Also:

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

addRolePermissionOverride

@Nonnull
@CheckReturnValue
public ChannelActionImpl<T> addRolePermissionOverride(long roleId,
 long allow,
 long deny)

Description copied from interface: ChannelAction

Adds a new Role PermissionOverride for the new GuildChannel.

If setting permission overwrites, only permissions your bot has in the guild can be allowed/denied.

Example:

 long roleId = role.getIdLong();
 long allow = Permission.VIEW_CHANNEL.getRawValue();
 long deny = Permission.MESSAGE_SEND.getRawValue() | Permission.MESSAGE_ADD_REACTION.getRawValue();
 channelAction.addMemberPermissionOverride(roleId, allow, deny);
 

Specified by:

addRolePermissionOverride in interface ChannelAction<T extends GuildChannel>

Parameters:

roleId - The id for the role

allow - The granted Permissions for the override. Use Permission.getRawValue() to retrieve these Permissions.

deny - The denied Permissions for the override. Use Permission.getRawValue() to retrieve these Permissions.

Returns:

The current ChannelAction, for chaining convenience

See Also:

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

removePermissionOverride

@Nonnull
public ChannelAction<T> removePermissionOverride(long id)

Description copied from interface: ChannelAction

Removes any existing override with the provided id.
If no override with the provided id exists, this method does nothing.

Specified by:

removePermissionOverride in interface ChannelAction<T extends GuildChannel>

Parameters:

id - The member or role id of the override

Returns:

The current ChannelAction, for chaining convenience

clearPermissionOverrides

@Nonnull
public ChannelAction<T> clearPermissionOverrides()

Description copied from interface: ChannelAction

Removes all currently configured permission overrides

Specified by:

clearPermissionOverrides in interface ChannelAction<T extends GuildChannel>

Returns:

The current ChannelAction, for chaining convenience

syncPermissionOverrides

@Nonnull
public ChannelAction<T> syncPermissionOverrides()

Description copied from interface: ChannelAction

Syncs the permission overrides of the channel with the category.

If setting permission overwrites, only permissions your bot has in the guild can be allowed/denied. In order to properly sync permissions the currently logged in account must have all allowed/denied permissions or Permission.MANAGE_ROLES in the parent category.

Specified by:

syncPermissionOverrides in interface ChannelAction<T extends GuildChannel>

Returns:

The current ChannelAction, for chaining convenience

setBitrate

@Nonnull
@CheckReturnValue
public ChannelActionImpl<T> setBitrate(Integer bitrate)

Description copied from interface: ChannelAction

Sets the bitrate for the new VoiceChannel

Specified by:

setBitrate in interface ChannelAction<T extends GuildChannel>

Parameters:

bitrate - The bitrate for the new VoiceChannel in bps (limits 8000 <= bitrate <= Guild.getMaxBitrate()) or null to use the default 64kbps.

Returns:

The current ChannelAction, for chaining convenience

setUserlimit

@Nonnull
@CheckReturnValue
public ChannelActionImpl<T> setUserlimit(Integer userlimit)

Description copied from interface: ChannelAction

Sets the userlimit for the new AudioChannel.
The limit maximum varies by type.

• ChannelType.VOICE - 99
• ChannelType.STAGE - 10000

Specified by:

setUserlimit in interface ChannelAction<T extends GuildChannel>

Parameters:

userlimit - The userlimit for the new AudioChannel or null/0 to use no limit

Returns:

The current ChannelAction, for chaining convenience

setRegion

@Nonnull
@CheckReturnValue
public ChannelActionImpl<T> setRegion(@Nullable
 Region region)

Description copied from interface: ChannelAction

Sets the voice region for the new AudioChannel

Specified by:

setRegion in interface ChannelAction<T extends GuildChannel>

Parameters:

region - The region for the new AudioChannel, or null to set to Region.AUTOMATIC

Returns:

The current ChannelAction, for chaining convenience