Package net.dv8tion.jda.api.managers

Interface ChannelManager

All Superinterfaces:

AuditableRestAction<java.lang.Void>, Manager<ChannelManager>, RestAction<java.lang.Void>

public interface ChannelManager
extends Manager<ChannelManager>

Manager providing functionality to update one or more fields for a GuildChannel.

Example

 manager.setName("github-log")
        .setTopic("logs for github commits")
        .setNSFW(false)
        .queue();
 manager.reset(ChannelManager.TOPIC | ChannelManager.NAME)
        .setName("nsfw-commits")
        .setTopic(null)
        .setNSFW(true)
        .queue();
 

See Also:

GuildChannel.getManager()

Field Summary

Fields

Modifier and Type	Field	Description
static long	BITRATE	Used to reset the bitrate field
static long	NAME	Used to reset the name field
static long	NEWS	Used to reset the channel type field
static long	NSFW	Used to reset the nsfw field
static long	PARENT	Used to reset the parent field
static long	PERMISSION	Used to reset the permission field
static long	POSITION	Used to reset the position field
static long	REGION	Used to reset the region field
static long	SLOWMODE	Used to reset the rate-limit per user field
static long	TOPIC	Used to reset the topic field
static long	USERLIMIT	Used to reset the userlimit field

Method Summary

Modifier and Type	Method	Description
ChannelManager	clearOverridesAdded()	Clears the overrides added via putPermissionOverride(IPermissionHolder, Collection, Collection).
ChannelManager	clearOverridesRemoved()	Clears the overrides removed via removePermissionOverride(IPermissionHolder).
GuildChannel	getChannel()	The GuildChannel that will be modified by this Manager instance
default Guild	getGuild()	The Guild this Manager's GuildChannel is in.
default ChannelType	getType()	The ChannelType
ChannelManager	putMemberPermissionOverride(long memberId, long allow, long deny)	Adds an override for the specified member with the provided raw bitmasks as allowed and denied permissions.
default ChannelManager	putMemberPermissionOverride(long memberId, java.util.Collection<Permission> allow, java.util.Collection<Permission> deny)	Adds an override for the specified member with the provided permission sets as allowed and denied permissions.
ChannelManager	putPermissionOverride(IPermissionHolder permHolder, long allow, long deny)	Adds an override for the specified IPermissionHolder with the provided raw bitmasks as allowed and denied permissions.
default ChannelManager	putPermissionOverride(IPermissionHolder permHolder, java.util.Collection<Permission> allow, java.util.Collection<Permission> deny)	Adds an override for the specified IPermissionHolder with the provided permission sets as allowed and denied permissions.
ChannelManager	putRolePermissionOverride(long roleId, long allow, long deny)	Adds an override for the specified role with the provided raw bitmasks as allowed and denied permissions.
default ChannelManager	putRolePermissionOverride(long roleId, java.util.Collection<Permission> allow, java.util.Collection<Permission> deny)	Adds an override for the specified role with the provided permission sets as allowed and denied permissions.
ChannelManager	removePermissionOverride(long id)	Removes the PermissionOverride for the specified member or role ID.
ChannelManager	removePermissionOverride(IPermissionHolder permHolder)	Removes the PermissionOverride for the specified IPermissionHolder.
ChannelManager	reset(long fields)	Resets the fields specified by the provided bit-flag pattern.
ChannelManager	reset(long... fields)	Resets the fields specified by the provided bit-flag patterns.
ChannelManager	setBitrate(int bitrate)	Sets the bitrate of the selected VoiceChannel.
ChannelManager	setName(java.lang.String name)	Sets the name of the selected GuildChannel.
ChannelManager	setNews(boolean news)	Sets the news flag of the selected TextChannel.
ChannelManager	setNSFW(boolean nsfw)	Sets the nsfw flag of the selected TextChannel.
ChannelManager	setParent(Category category)	Sets the Parent Category of the selected GuildChannel.
ChannelManager	setPosition(int position)	Sets the position of the selected GuildChannel.
ChannelManager	setRegion(Region region)	Sets the Region of the selected VoiceChannel.
ChannelManager	setSlowmode(int slowmode)	Sets the slowmode of the selected TextChannel.
ChannelManager	setTopic(java.lang.String topic)	Sets the topic of the selected TextChannel or StageChannel.
ChannelManager	setUserLimit(int userLimit)	Sets the user-limit of the selected VoiceChannel.
default ChannelManager	sync()	Syncs all PermissionOverrides of this GuildChannel with its parent (Category).
ChannelManager	sync(GuildChannel syncSource)	Syncs all PermissionOverrides of this GuildChannel with the given (GuildChannel).

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

reason

Methods inherited from interface net.dv8tion.jda.api.managers.Manager

deadline, reset, setCheck, timeout

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

Field Detail

NAME

static final long NAME

Used to reset the name field

See Also:

Constant Field Values

PARENT

static final long PARENT

Used to reset the parent field

See Also:

Constant Field Values

TOPIC

static final long TOPIC

Used to reset the topic field

See Also:

Constant Field Values

POSITION

static final long POSITION

Used to reset the position field

See Also:

Constant Field Values

NSFW

static final long NSFW

Used to reset the nsfw field

See Also:

Constant Field Values

USERLIMIT

static final long USERLIMIT

Used to reset the userlimit field

See Also:

Constant Field Values

BITRATE

static final long BITRATE

Used to reset the bitrate field

See Also:

Constant Field Values

PERMISSION

static final long PERMISSION

Used to reset the permission field

See Also:

Constant Field Values

SLOWMODE

static final long SLOWMODE

Used to reset the rate-limit per user field

See Also:

Constant Field Values

NEWS

static final long NEWS

Used to reset the channel type field

See Also:

Constant Field Values

REGION

static final long REGION

Used to reset the region field

See Also:

Constant Field Values

Method Detail

reset

@Nonnull
ChannelManager reset(long fields)

Resets the fields specified by the provided bit-flag pattern. You can specify a combination by using a bitwise OR concat of the flag constants.
Example: manager.reset(ChannelManager.NAME | ChannelManager.PARENT);

Flag Constants:

• NAME
• PARENT
• TOPIC
• POSITION
• NSFW
• SLOWMODE
• USERLIMIT
• BITRATE
• PERMISSION
• NEWS
• REGION

Specified by:

reset in interface Manager<ChannelManager>

Parameters:

fields - Integer value containing the flags to reset.

Returns:

ChannelManager for chaining convenience

reset

@Nonnull
ChannelManager reset(long... fields)

Resets the fields specified by the provided bit-flag patterns.
Example: manager.reset(ChannelManager.NAME, ChannelManager.PARENT);

Flag Constants:

• NAME
• PARENT
• TOPIC
• POSITION
• NSFW
• USERLIMIT
• BITRATE
• PERMISSION
• NEWS
• REGION

Specified by:

reset in interface Manager<ChannelManager>

Parameters:

fields - Integer values containing the flags to reset.

Returns:

ChannelManager for chaining convenience

getChannel

@Nonnull
GuildChannel getChannel()

The GuildChannel that will be modified by this Manager instance

Returns:

The GuildChannel

getType

@Nonnull
default ChannelType getType()

The ChannelType

Returns:

The ChannelType

getGuild

@Nonnull
default Guild getGuild()

The Guild this Manager's GuildChannel is in.
This is logically the same as calling getChannel().getGuild()

Returns:

The parent Guild

clearOverridesAdded

@Nonnull
@CheckReturnValue
ChannelManager clearOverridesAdded()

Clears the overrides added via putPermissionOverride(IPermissionHolder, Collection, Collection).

Returns:

ChannelManager for chaining convenience

clearOverridesRemoved

@Nonnull
@CheckReturnValue
ChannelManager clearOverridesRemoved()

Clears the overrides removed via removePermissionOverride(IPermissionHolder).

Returns:

ChannelManager for chaining convenience

putPermissionOverride

@Nonnull
@CheckReturnValue
ChannelManager putPermissionOverride(@Nonnull
                                     IPermissionHolder permHolder,
                                     long allow,
                                     long deny)

Adds an override for the specified IPermissionHolder with the provided raw bitmasks as allowed and denied permissions. If the permission holder already had an override on this channel it will be replaced instead.

Parameters:

permHolder - The permission holder

allow - The bitmask to grant

deny - The bitmask to deny

Returns:

ChannelManager for chaining convenience

Throws:

java.lang.IllegalArgumentException - If the provided permission holder is null

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel, or tries to set permissions it does not have without having Permission.MANAGE_PERMISSIONS explicitly for this channel through an override.

See Also:

putPermissionOverride(IPermissionHolder, Collection, Collection), Permission.getRaw(Permission...)

putPermissionOverride

@Nonnull
@CheckReturnValue
default ChannelManager putPermissionOverride(@Nonnull
                                             IPermissionHolder permHolder,
                                             @Nullable
                                             java.util.Collection<Permission> allow,
                                             @Nullable
                                             java.util.Collection<Permission> deny)

Adds an override for the specified IPermissionHolder with the provided permission sets as allowed and denied permissions. If the permission holder already had an override on this channel it will be replaced instead.
Example: putPermissionOverride(guild.getSelfMember(), EnumSet.of(Permission.MESSAGE_WRITE, Permission.MESSAGE_READ), null)

Parameters:

permHolder - The permission holder

allow - The permissions to grant, or null

deny - The permissions to deny, or null

Returns:

ChannelManager for chaining convenience

Throws:

java.lang.IllegalArgumentException - If the provided permission holder is null

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel, or tries to set permissions it does not have without having Permission.MANAGE_PERMISSIONS explicitly for this channel through an override.

See Also:

putPermissionOverride(IPermissionHolder, long, long), EnumSet

putRolePermissionOverride

@Nonnull
@CheckReturnValue
ChannelManager putRolePermissionOverride(long roleId,
                                         long allow,
                                         long deny)

Adds an override for the specified role with the provided raw bitmasks as allowed and denied permissions. If the role already had an override on this channel it will be replaced instead.

Parameters:

roleId - The ID of the role to set permissions for

allow - The bitmask to grant

deny - The bitmask to deny

Returns:

ChannelManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel, or tries to set permissions it does not have without having Permission.MANAGE_PERMISSIONS explicitly for this channel through an override.

See Also:

putRolePermissionOverride(long, Collection, Collection), Permission.getRaw(Permission...)

putRolePermissionOverride

@Nonnull
@CheckReturnValue
default ChannelManager putRolePermissionOverride(long roleId,
                                                 @Nullable
                                                 java.util.Collection<Permission> allow,
                                                 @Nullable
                                                 java.util.Collection<Permission> deny)

Adds an override for the specified role with the provided permission sets as allowed and denied permissions. If the role already had an override on this channel it will be replaced instead.

Parameters:

roleId - The ID of the role to set permissions for

allow - The permissions to grant, or null

deny - The permissions to deny, or null

Returns:

ChannelManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel, or tries to set permissions it does not have without having Permission.MANAGE_PERMISSIONS explicitly for this channel through an override.

See Also:

putRolePermissionOverride(long, long, long), EnumSet

putMemberPermissionOverride

@Nonnull
@CheckReturnValue
ChannelManager putMemberPermissionOverride(long memberId,
                                           long allow,
                                           long deny)

Adds an override for the specified member with the provided raw bitmasks as allowed and denied permissions. If the member already had an override on this channel it will be replaced instead.

Parameters:

memberId - The ID of the member to set permissions for

allow - The bitmask to grant

deny - The bitmask to deny

Returns:

ChannelManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel, or tries to set permissions it does not have without having Permission.MANAGE_PERMISSIONS explicitly for this channel through an override.

See Also:

putMemberPermissionOverride(long, Collection, Collection), Permission.getRaw(Permission...)

putMemberPermissionOverride

@Nonnull
@CheckReturnValue
default ChannelManager putMemberPermissionOverride(long memberId,
                                                   @Nullable
                                                   java.util.Collection<Permission> allow,
                                                   @Nullable
                                                   java.util.Collection<Permission> deny)

Adds an override for the specified member with the provided permission sets as allowed and denied permissions. If the member already had an override on this channel it will be replaced instead.

Parameters:

memberId - The ID of the member to set permissions for

allow - The permissions to grant, or null

deny - The permissions to deny, or null

Returns:

ChannelManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel, or tries to set permissions it does not have without having Permission.MANAGE_PERMISSIONS explicitly for this channel through an override.

See Also:

putMemberPermissionOverride(long, long, long), EnumSet

removePermissionOverride

@Nonnull
@CheckReturnValue
ChannelManager removePermissionOverride(@Nonnull
                                        IPermissionHolder permHolder)

Removes the PermissionOverride for the specified IPermissionHolder. If no override existed for this member or role, this does nothing.

Parameters:

permHolder - The permission holder

Returns:

ChannelManager for chaining convenience

Throws:

java.lang.IllegalArgumentException - If the provided permission holder is null

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel

removePermissionOverride

@Nonnull
@CheckReturnValue
ChannelManager removePermissionOverride(long id)

Removes the PermissionOverride for the specified member or role ID. If no override existed for this member or role, this does nothing.

Parameters:

id - The ID of the permission holder

Returns:

ChannelManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel

sync

@Nonnull
@CheckReturnValue
default ChannelManager sync()

Syncs all PermissionOverrides of this GuildChannel with its parent (Category).

After this operation, all PermissionOverrides will be exactly the same as the ones from the parent.
That means that all current PermissionOverrides are lost!

This behaves as if calling sync(net.dv8tion.jda.api.entities.GuildChannel) with this GuildChannel's Parent.

Returns:

ChannelManager for chaining convenience

Throws:

java.lang.IllegalStateException - If this GuildChannel has no parent

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel or IPermissionHolder.canSync(GuildChannel, GuildChannel) is false for the self member.

See Also:

Discord Documentation - Permission Syncing

sync

@Nonnull
@CheckReturnValue
ChannelManager sync(@Nonnull
                    GuildChannel syncSource)

Syncs all PermissionOverrides of this GuildChannel with the given (GuildChannel).

After this operation, all PermissionOverrides will be exactly the same as the ones from the syncSource.
That means that all current PermissionOverrides are lost!

This will only work for Channels of the same Guild!.

Parameters:

syncSource - The GuildChannel from where all PermissionOverrides should be copied from

Returns:

ChannelManager for chaining convenience

Throws:

java.lang.IllegalArgumentException - If the given snySource is null, this GuildChannel or from a different Guild.

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel or IPermissionHolder.canSync(GuildChannel, GuildChannel) is false for the self member.

See Also:

Discord Documentation - Permission Syncing

setName

@Nonnull
@CheckReturnValue
ChannelManager setName(@Nonnull
                       java.lang.String name)

Sets the name of the selected GuildChannel.

A channel name must not be null nor empty or more than 100 characters long!
TextChannel names may only be populated with alphanumeric (with underscore and dash).

Example: mod-only or generic_name
Characters will automatically be lowercased by Discord for text channels!

Parameters:

name - The new name for the selected GuildChannel

Returns:

ChannelManager for chaining convenience

Throws:

java.lang.IllegalArgumentException - If the provided name is null or not between 1-100 characters long

setParent

@Nonnull
@CheckReturnValue
ChannelManager setParent(@Nullable
                         Category category)

Sets the Parent Category of the selected GuildChannel.

Parameters:

category - The new parent for the selected GuildChannel

Returns:

ChannelManager for chaining convenience

Throws:

java.lang.IllegalStateException - If the target is a category itself

java.lang.IllegalArgumentException - If the provided category is not from the same Guild

Since:

3.4.0

setPosition

@Nonnull
@CheckReturnValue
ChannelManager setPosition(int position)

Sets the position of the selected GuildChannel.

To modify multiple channels you should use Guild.modifyTextChannelPositions() instead! This is not the same as looping through channels and using this to update positions!

Parameters:

position - The new position for the selected GuildChannel

Returns:

ChannelManager for chaining convenience

setTopic

@Nonnull
@CheckReturnValue
ChannelManager setTopic(@Nullable
                        java.lang.String topic)

Sets the topic of the selected TextChannel or StageChannel.

A channel topic must not be more than 1024 characters long!
This is only available to TextChannels

Parameters:

topic - The new topic for the selected channel, null or empty String to reset

Returns:

ChannelManager for chaining convenience

Throws:

java.lang.UnsupportedOperationException - If the selected GuildChannel's type is not TEXT

java.lang.IllegalArgumentException - If the provided topic is greater than 1024 in length

setNSFW

@Nonnull
@CheckReturnValue
ChannelManager setNSFW(boolean nsfw)

Sets the nsfw flag of the selected TextChannel.

Parameters:

nsfw - The new nsfw flag for the selected TextChannel,

Returns:

ChannelManager for chaining convenience

Throws:

java.lang.IllegalStateException - If the selected GuildChannel's type is not TEXT

setSlowmode

@Nonnull
@CheckReturnValue
ChannelManager setSlowmode(int slowmode)

Sets the slowmode of the selected TextChannel.
Provide 0 to reset the slowmode of the TextChannel

A channel slowmode must not be negative nor greater than TextChannel.MAX_SLOWMODE!
This is only available to TextChannels

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

Parameters:

slowmode - The new slowmode for the selected TextChannel

Returns:

ChannelManager for chaining convenience

Throws:

java.lang.IllegalStateException - If the selected GuildChannel's type is not TEXT

java.lang.IllegalArgumentException - If the provided slowmode is negative or greater than TextChannel.MAX_SLOWMODE

setUserLimit

@Nonnull
@CheckReturnValue
ChannelManager setUserLimit(int userLimit)

Sets the user-limit of the selected VoiceChannel.
Provide 0 to reset the user-limit of the VoiceChannel

A channel user-limit must not be negative nor greater than 99!
This is only available to VoiceChannels

Parameters:

userLimit - The new user-limit for the selected VoiceChannel

Returns:

ChannelManager for chaining convenience

Throws:

java.lang.IllegalStateException - If the selected GuildChannel's type is not VOICE

java.lang.IllegalArgumentException - If the provided user-limit is negative or greater than 99

setBitrate

@Nonnull
@CheckReturnValue
ChannelManager setBitrate(int bitrate)

Sets the bitrate of the selected VoiceChannel.
The default value is 64000

A channel bitrate must not be less than 8000 nor greater than Guild.getMaxBitrate()!
This is only available to VoiceChannels

Parameters:

bitrate - The new bitrate for the selected VoiceChannel

Returns:

ChannelManager for chaining convenience

Throws:

java.lang.IllegalStateException - If the selected GuildChannel's type is not VOICE

java.lang.IllegalArgumentException - If the provided bitrate is less than 8000 or greater than Guild.getMaxBitrate().

See Also:

Guild.getFeatures()

setRegion

@Nonnull
@CheckReturnValue
ChannelManager setRegion(Region region)

Sets the Region of the selected VoiceChannel.
The default value is Region.AUTOMATIC Possible values are:

• Region.AUTOMATIC
• Region.US_WEST
• Region.US_EAST
• Region.US_CENTRAL
• Region.US_SOUTH
• Region.SINGAPORE
• Region.SOUTH_AFRICA
• Region.SYDNEY
• Region.EUROPE
• Region.INDIA
• Region.SOUTH_KOREA
• Region.BRAZIL
• Region.JAPAN
• Region.RUSSIA

This is only available to VoiceChannels!

Parameters:

region - The new Region

Returns:

ChannelManager for chaining convenience

Throws:

java.lang.IllegalStateException - If the selected GuildChannel's type is not VOICE

java.lang.IllegalArgumentException - If the provided Region is not in the list of usable values

setNews

@Nonnull
@CheckReturnValue
ChannelManager setNews(boolean news)

Sets the news flag of the selected TextChannel. Announcement-/News-Channels can be used to crosspost messages to other guilds.

Parameters:

news - The new news flag for the selected TextChannel,

Returns:

ChannelManager for chaining convenience

Throws:

java.lang.IllegalStateException - If the selected GuildChannel's type is not TEXT

java.lang.IllegalStateException - If news is true and the guild doesn't have the NEWS feature

Since:

4.2.1

See Also:

Guild.getFeatures(), TextChannel.isNews()