Package net.dv8tion.jda.api.managers.channel

Interface ChannelManager<T extends GuildChannel,M extends ChannelManager<T,M>>

All Superinterfaces:

AuditableRestAction<Void>, Manager<M>, RestAction<Void>

All Known Subinterfaces:

AudioChannelManager<T,M>, BaseGuildMessageChannelManager<T,M>, CategoryManager, ICategorizableChannelManager<T,M>, IPermissionContainerManager<T,M>, IPositionableChannelManager<T,M>, NewsChannelManager, StageChannelManager, StoreChannelManager, TextChannelManager, ThreadChannelManager, VoiceChannelManager

public interface ChannelManager<T extends GuildChannel,M extends ChannelManager<T,M>>
extends Manager<M>

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	ARCHIVED	Used to reset the archived field
static long	AUTO_ARCHIVE_DURATION	Used to reset the auto-archive-duration field
static long	BITRATE	Used to reset the bitrate field
static long	INVITEABLE	Used to reset the invitable field
static long	LOCKED	Used to reset the locked field
static long	NAME	Used to reset the name 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	TYPE	Used to reset the channel type field
static long	USERLIMIT	Used to reset the userlimit field

Method Summary

Modifier and Type	Method	Description
T	getChannel()	The GuildChannel that will be modified by this Manager instance
default Guild	getGuild()	The Guild this Manager's GuildChannel is in.
M	reset(long fields)	Resets the fields specified by the provided bit-flag pattern.
M	reset(long... fields)	Resets the fields specified by the provided bit-flag patterns.
M	setName(String name)	Sets the name of the selected 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

TYPE

static final long TYPE

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

AUTO_ARCHIVE_DURATION

static final long AUTO_ARCHIVE_DURATION

Used to reset the auto-archive-duration field

See Also:

Constant Field Values

ARCHIVED

static final long ARCHIVED

Used to reset the archived field

See Also:

Constant Field Values

LOCKED

static final long LOCKED

Used to reset the locked field

See Also:

Constant Field Values

INVITEABLE

static final long INVITEABLE

Used to reset the invitable field

See Also:

Constant Field Values

Method Detail

reset

@Nonnull
M 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
• TYPE
• REGION

Specified by:

reset in interface Manager<T extends GuildChannel>

Parameters:

fields - Integer value containing the flags to reset.

Returns:

ChannelManager for chaining convenience

reset

@Nonnull
M 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
• TYPE
• REGION

Specified by:

reset in interface Manager<T extends GuildChannel>

Parameters:

fields - Integer values containing the flags to reset.

Returns:

ChannelManager for chaining convenience

getChannel

@Nonnull
T getChannel()

The GuildChannel that will be modified by this Manager instance

Returns:

The GuildChannel

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

setName

@Nonnull
@CheckReturnValue
M setName(@Nonnull
          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:

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