Package net.dv8tion.jda.internal.managers

Class GuildWelcomeScreenManagerImpl

java.lang.Object

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

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

net.dv8tion.jda.internal.managers.ManagerBase<GuildWelcomeScreenManager>

net.dv8tion.jda.internal.managers.GuildWelcomeScreenManagerImpl

All Implemented Interfaces:

GuildWelcomeScreenManager, Manager<GuildWelcomeScreenManager>, RestAction<Void>, AuditableRestAction<Void>

public class GuildWelcomeScreenManagerImpl
extends ManagerBase<GuildWelcomeScreenManager>
implements GuildWelcomeScreenManager

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

Fields inherited from interface net.dv8tion.jda.api.managers.GuildWelcomeScreenManager

CHANNELS, DESCRIPTION, ENABLED

Constructor Summary

Constructors

Constructor	Description
GuildWelcomeScreenManagerImpl(Guild guild)

Method Summary

Modifier and Type	Method	Description
GuildWelcomeScreenManager	clearWelcomeChannels()	Removes all welcome channels.
Guild	getGuild()	The Guild this Manager's GuildWelcomeScreen is in.
List<GuildWelcomeScreen.Channel>	getWelcomeChannels()	Returns an immutable list of the welcome channels These channels are those which are being modified, not the ones currently shown on Discord
GuildWelcomeScreenManagerImpl	reset()	Resets all fields for this Manager
GuildWelcomeScreenManagerImpl	reset(long fields)	Resets the fields specified by the provided bit-flag pattern.
GuildWelcomeScreenManagerImpl	reset(long... fields)	Resets the specified fields.
GuildWelcomeScreenManager	setDescription(String description)	Sets the description of the welcome screen.
GuildWelcomeScreenManager	setEnabled(boolean enabled)	Sets the enabled state of the welcome screen.
GuildWelcomeScreenManager	setWelcomeChannels(Collection<? extends GuildWelcomeScreen.Channel> channels)	Sets the welcome channels of the welcome screen.

Methods inherited from class net.dv8tion.jda.internal.managers.ManagerBase

complete, deadline, isPermissionChecksEnabled, queue, setCheck, setPermissionChecksEnabled, timeout

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

reason

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

getCheck, getDefaultFailure, getDefaultSuccess, getDefaultTimeout, getJDA, handleResponse, isPassContext, priority, 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.managers.GuildWelcomeScreenManager

setWelcomeChannels

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

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

Constructor Details

GuildWelcomeScreenManagerImpl

public GuildWelcomeScreenManagerImpl(Guild guild)

Method Details

getGuild

@Nonnull
public Guild getGuild()

Description copied from interface: GuildWelcomeScreenManager

The Guild this Manager's GuildWelcomeScreen is in.

Specified by:

getGuild in interface GuildWelcomeScreenManager

Returns:

The parent Guild

reset

@Nonnull
@CheckReturnValue
public GuildWelcomeScreenManagerImpl reset(long fields)

Description copied from interface: GuildWelcomeScreenManager

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(GuildWelcomeScreenManager.DESCRIPTION | GuildWelcomeScreenManager.CHANNELS);

Flag Constants:

• GuildWelcomeScreenManager.ENABLED
• GuildWelcomeScreenManager.DESCRIPTION
• GuildWelcomeScreenManager.CHANNELS

Specified by:

reset in interface GuildWelcomeScreenManager

Specified by:

reset in interface Manager<GuildWelcomeScreenManager>

Overrides:

reset in class ManagerBase<GuildWelcomeScreenManager>

Parameters:

fields - Integer value containing the flags to reset.

Returns:

GuildWelcomeScreenManager for chaining convenience

reset

@Nonnull
@CheckReturnValue
public GuildWelcomeScreenManagerImpl reset(long... fields)

Description copied from interface: GuildWelcomeScreenManager

Resets the specified fields.
Example: manager.reset(GuildWelcomeScreenManager.DESCRIPTION, GuildWelcomeScreenManager.CHANNELS);

Flag Constants:

• GuildWelcomeScreenManager.ENABLED
• GuildWelcomeScreenManager.DESCRIPTION
• GuildWelcomeScreenManager.CHANNELS

Specified by:

reset in interface GuildWelcomeScreenManager

Specified by:

reset in interface Manager<GuildWelcomeScreenManager>

Overrides:

reset in class ManagerBase<GuildWelcomeScreenManager>

Parameters:

fields - Integer value containing the flags to reset.

Returns:

GuildWelcomeScreenManager for chaining convenience

reset

@Nonnull
@CheckReturnValue
public GuildWelcomeScreenManagerImpl reset()

Description copied from interface: Manager

Resets all fields for this Manager

Specified by:

reset in interface Manager<GuildWelcomeScreenManager>

Overrides:

reset in class ManagerBase<GuildWelcomeScreenManager>

Returns:

The current Manager with all settings reset to default

setEnabled

@Nonnull
public GuildWelcomeScreenManager setEnabled(boolean enabled)

Description copied from interface: GuildWelcomeScreenManager

Sets the enabled state of the welcome screen.

Specified by:

setEnabled in interface GuildWelcomeScreenManager

Parameters:

enabled - True if the welcome screen should be enabled

Returns:

GuildWelcomeScreenManager for chaining convenience

setDescription

@Nonnull
public GuildWelcomeScreenManager setDescription(@Nullable
 String description)

Description copied from interface: GuildWelcomeScreenManager

Sets the description of the welcome screen.

The description must not be longer than 140

Specified by:

setDescription in interface GuildWelcomeScreenManager

Parameters:

description - The new description of the welcome screen, or null to remove the description

Returns:

GuildWelcomeScreenManager for chaining convenience

getWelcomeChannels

@Nonnull
public List<GuildWelcomeScreen.Channel> getWelcomeChannels()

Description copied from interface: GuildWelcomeScreenManager

Returns an immutable list of the welcome channels
These channels are those which are being modified, not the ones currently shown on Discord

Specified by:

getWelcomeChannels in interface GuildWelcomeScreenManager

Returns:

An immutable list of the welcome channels to be set by the manager

clearWelcomeChannels

@Nonnull
public GuildWelcomeScreenManager clearWelcomeChannels()

Description copied from interface: GuildWelcomeScreenManager

Removes all welcome channels.

Specified by:

clearWelcomeChannels in interface GuildWelcomeScreenManager

Returns:

GuildWelcomeScreenManager for chaining convenience

setWelcomeChannels

@Nonnull
public GuildWelcomeScreenManager setWelcomeChannels(@Nonnull
 Collection<? extends GuildWelcomeScreen.Channel> channels)

Description copied from interface: GuildWelcomeScreenManager

Sets the welcome channels of the welcome screen.

The order of the Collection defines in what order the channels appear on Discord.

Specified by:

setWelcomeChannels in interface GuildWelcomeScreenManager

Parameters:

channels - The new welcome channels to use, can be an empty list to remove all welcome channels.

Returns:

GuildWelcomeScreenManager for chaining convenience

See Also:

• GuildWelcomeScreenManager.setWelcomeChannels(GuildWelcomeScreen.Channel...)