Interface GuildManager

All Superinterfaces:

AuditableRestAction<Void>, Manager<GuildManager>, RestAction<Void>

public interface GuildManager
extends Manager<GuildManager>

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

Example

manager.setName("Official JDA Guild")
       .setIcon(null)
       .queue();
manager.reset(GuildManager.NAME | GuildManager.ICON)
       .setName("Minn's Meme Den")
       .setExplicitContentLevel(Guild.ExplicitContentLevel.HIGH)
       .queue();

See Also:

• Guild.getManager()

Field Summary

Fields

Modifier and Type	Field	Description
static final long	AFK_CHANNEL	Used to reset the afk channel field
static final long	AFK_TIMEOUT	Used to reset the afk timeout field
static final long	BANNER	Used to reset the banner field
static final long	BOOST_PROGRESS_BAR_ENABLED	Used to reset the premium progress bar enabled field
static final long	COMMUNITY_UPDATES_CHANNEL	Used to reset the community updates channel field
static final long	DESCRIPTION	Used to reset the description field
static final long	EXPLICIT_CONTENT_LEVEL	Used to reset the explicit content level field
static final long	FEATURES	Used to add or remove modifiable features (such as "INVITES_DISABLED")
static final long	ICON	Used to reset the icon field
static final long	NAME	Used to reset the name field
static final long	NOTIFICATION_LEVEL	Used to reset the default notification level field
static final long	RULES_CHANNEL	Used to reset the rules channel field
static final long	SAFETY_ALERTS_CHANNEL	Used to rest the safety alerts channel field
static final long	SPLASH	Used to reset the splash field
static final long	SYSTEM_CHANNEL	Used to reset the system channel field
static final long	SYSTEM_CHANNEL_FLAGS	Used to reset the system channel flag fields
static final long	VERIFICATION_LEVEL	Used to reset the verification level field

Fields inherited from interface AuditableRestAction

MAX_REASON_LENGTH

Method Summary

Modifier and Type	Method	Description
default GuildManager	addFeatures(String... features)	Adds a Guild Feature to the list of features.
GuildManager	addFeatures(Collection<String> features)	Adds a Guild Feature to the list of features.
GuildManager	disableSystemChannelFlags(Collection<SystemChannelFlag> flags)	Disables the given system channel flags.
default GuildManager	disableSystemChannelFlags(SystemChannelFlag... flags)	Disables the given system channel flags.
GuildManager	enableSystemChannelFlags(Collection<SystemChannelFlag> flags)	Enables the given system channel flags.
default GuildManager	enableSystemChannelFlags(SystemChannelFlag... flags)	Enables the given system channel flags.
Guild	getGuild()	The Guild object of this Manager.
default GuildManager	removeFeatures(String... features)	Removes a Guild Feature from the list of features.
GuildManager	removeFeatures(Collection<String> features)	Removes a Guild Feature from the list of features.
GuildManager	reset(long fields)	Resets the fields specified by the provided bit-flag pattern.
GuildManager	reset(long... fields)	Resets the fields specified by the provided bit-flag patterns.
GuildManager	setAfkChannel(VoiceChannel afkChannel)	Sets the AFK VoiceChannel of this Guild.
GuildManager	setAfkTimeout(Guild.Timeout timeout)	Sets the afk Timeout of this Guild.
GuildManager	setBanner(Icon banner)	Sets the Banner Icon of this Guild.
GuildManager	setBoostProgressBarEnabled(boolean boostProgressBarEnabled)	Sets whether this Guild should have its boost progress bar shown.
GuildManager	setCommunityUpdatesChannel(TextChannel communityUpdatesChannel)	Sets the community updates TextChannel of this Guild.
GuildManager	setDefaultNotificationLevel(Guild.NotificationLevel level)	Sets the Notification Level of this Guild.
GuildManager	setDescription(String description)	Sets the Description Icon of this Guild.
GuildManager	setExplicitContentLevel(Guild.ExplicitContentLevel level)	Sets the Explicit Content Level of this Guild.
GuildManager	setFeatures(Collection<String> features)	Configures the new features of the Guild.
GuildManager	setIcon(Icon icon)	Sets the Icon of this Guild.
default GuildManager	setInvitesDisabled(boolean disabled)	Configures the INVITES_DISABLED feature flag of this guild.
GuildManager	setName(String name)	Sets the name of this Guild.
GuildManager	setRulesChannel(TextChannel rulesChannel)	Sets the rules TextChannel of this Guild.
GuildManager	setSafetyAlertsChannel(TextChannel safetyAlertsChannel)	Sets the safety alerts TextChannel of this Guild.
GuildManager	setSplash(Icon splash)	Sets the Splash Icon of this Guild.
GuildManager	setSystemChannel(TextChannel systemChannel)	Sets the system TextChannel of this Guild.
GuildManager	setSystemChannelFlags(Collection<SystemChannelFlag> flags)	Configures the new system channel flags of the Guild.
default GuildManager	setSystemChannelFlags(SystemChannelFlag... flags)	Configures the new system channel flags of the Guild.
GuildManager	setVerificationLevel(Guild.VerificationLevel level)	Sets the Verification Level of this Guild.

Methods inherited from interface AuditableRestAction

reason

Methods inherited from interface Manager

deadline, reset, setCheck, timeout

Methods inherited from interface 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

Field Details

NAME

static final long NAME

Used to reset the name field

See Also:

• Constant Field Values

ICON

static final long ICON

Used to reset the icon field

See Also:

• Constant Field Values

SPLASH

static final long SPLASH

Used to reset the splash field

See Also:

• Constant Field Values

AFK_CHANNEL

static final long AFK_CHANNEL

Used to reset the afk channel field

See Also:

• Constant Field Values

AFK_TIMEOUT

static final long AFK_TIMEOUT

Used to reset the afk timeout field

See Also:

• Constant Field Values

SYSTEM_CHANNEL

static final long SYSTEM_CHANNEL

Used to reset the system channel field

See Also:

• Constant Field Values

NOTIFICATION_LEVEL

static final long NOTIFICATION_LEVEL

Used to reset the default notification level field

See Also:

• Constant Field Values

EXPLICIT_CONTENT_LEVEL

static final long EXPLICIT_CONTENT_LEVEL

Used to reset the explicit content level field

See Also:

• Constant Field Values

VERIFICATION_LEVEL

static final long VERIFICATION_LEVEL

Used to reset the verification level field

See Also:

• Constant Field Values

BANNER

static final long BANNER

Used to reset the banner field

See Also:

• Constant Field Values

DESCRIPTION

static final long DESCRIPTION

Used to reset the description field

See Also:

• Constant Field Values

RULES_CHANNEL

static final long RULES_CHANNEL

Used to reset the rules channel field

See Also:

• Constant Field Values

COMMUNITY_UPDATES_CHANNEL

static final long COMMUNITY_UPDATES_CHANNEL

Used to reset the community updates channel field

See Also:

• Constant Field Values

BOOST_PROGRESS_BAR_ENABLED

static final long BOOST_PROGRESS_BAR_ENABLED

Used to reset the premium progress bar enabled field

See Also:

• Constant Field Values

FEATURES

static final long FEATURES

Used to add or remove modifiable features (such as "INVITES_DISABLED")

See Also:

• Constant Field Values

SAFETY_ALERTS_CHANNEL

static final long SAFETY_ALERTS_CHANNEL

Used to rest the safety alerts channel field

See Also:

• Constant Field Values

SYSTEM_CHANNEL_FLAGS

static final long SYSTEM_CHANNEL_FLAGS

Used to reset the system channel flag fields

See Also:

• Constant Field Values

Method Details

reset

@Nonnull
@CheckReturnValue
GuildManager 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(GuildManager.NAME | GuildManager.ICON);

Flag Constants:

• NAME
• ICON
• SPLASH
• AFK_CHANNEL
• AFK_TIMEOUT
• SYSTEM_CHANNEL
• RULES_CHANNEL
• COMMUNITY_UPDATES_CHANNEL
• NOTIFICATION_LEVEL
• EXPLICIT_CONTENT_LEVEL
• VERIFICATION_LEVEL
• BOOST_PROGRESS_BAR_ENABLED
• FEATURES
• SYSTEM_CHANNEL_FLAGS

Specified by:

reset in interface Manager<GuildManager>

Parameters:

fields - Integer value containing the flags to reset.

Returns:

GuildManager for chaining convenience

reset

@Nonnull
@CheckReturnValue
GuildManager reset(@Nonnull
 long... fields)

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

Flag Constants:

• NAME
• ICON
• SPLASH
• AFK_CHANNEL
• AFK_TIMEOUT
• SYSTEM_CHANNEL
• RULES_CHANNEL
• COMMUNITY_UPDATES_CHANNEL
• NOTIFICATION_LEVEL
• EXPLICIT_CONTENT_LEVEL
• VERIFICATION_LEVEL
• BOOST_PROGRESS_BAR_ENABLED
• FEATURES
• SYSTEM_CHANNEL_FLAGS

Specified by:

reset in interface Manager<GuildManager>

Parameters:

fields - Integer values containing the flags to reset.

Returns:

GuildManager for chaining convenience

getGuild

@Nonnull
Guild getGuild()

The Guild object of this Manager. Useful if this Manager was returned via a create function

Returns:

The Guild of this Manager

setName

@Nonnull
@CheckReturnValue
GuildManager setName(@Nonnull
 String name)

Sets the name of this Guild.

Parameters:

name - The new name for this Guild

Returns:

GuildManager for chaining convenience

Throws:

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

setIcon

@Nonnull
@CheckReturnValue
GuildManager setIcon(@Nullable
 Icon icon)

Sets the Icon of this Guild.

Parameters:

icon - The new icon for this Guild or null to reset

Returns:

GuildManager for chaining convenience

setSplash

@Nonnull
@CheckReturnValue
GuildManager setSplash(@Nullable
 Icon splash)

Sets the Splash Icon of this Guild.

Parameters:

splash - The new splash for this Guild or null to reset

Returns:

GuildManager for chaining convenience

Throws:

IllegalStateException - If the guild's features do not include INVITE_SPLASH

setAfkChannel

@Nonnull
@CheckReturnValue
GuildManager setAfkChannel(@Nullable
 VoiceChannel afkChannel)

Sets the AFK VoiceChannel of this Guild.

Parameters:

afkChannel - The new afk channel for this Guild or null to reset

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If the provided channel is not from this guild

setSystemChannel

@Nonnull
@CheckReturnValue
GuildManager setSystemChannel(@Nullable
 TextChannel systemChannel)

Sets the system TextChannel of this Guild.

Parameters:

systemChannel - The new system channel for this Guild or null to reset

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If the provided channel is not from this guild

setRulesChannel

@Nonnull
@CheckReturnValue
GuildManager setRulesChannel(@Nullable
 TextChannel rulesChannel)

Sets the rules TextChannel of this Guild.

Parameters:

rulesChannel - The new rules channel for this Guild or null to reset

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If the provided channel is not from this guild

setCommunityUpdatesChannel

@Nonnull
@CheckReturnValue
GuildManager setCommunityUpdatesChannel(@Nullable
 TextChannel communityUpdatesChannel)

Sets the community updates TextChannel of this Guild.

Parameters:

communityUpdatesChannel - The new community updates channel for this Guild or null to reset

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If the provided channel is not from this guild

setSafetyAlertsChannel

@Nonnull
@CheckReturnValue
GuildManager setSafetyAlertsChannel(@Nullable
 TextChannel safetyAlertsChannel)

Sets the safety alerts TextChannel of this Guild.

Parameters:

safetyAlertsChannel - The new safety alerts channel for this Guild or null to reset

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If the provided channel is not from this guild

setAfkTimeout

@Nonnull
@CheckReturnValue
GuildManager setAfkTimeout(@Nonnull
 Guild.Timeout timeout)

Sets the afk Timeout of this Guild.

Parameters:

timeout - The new afk timeout for this Guild

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If the provided timeout is null

setVerificationLevel

@Nonnull
@CheckReturnValue
GuildManager setVerificationLevel(@Nonnull
 Guild.VerificationLevel level)

Sets the Verification Level of this Guild.

Parameters:

level - The new Verification Level for this Guild

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If the provided level is null or UNKNOWN

setDefaultNotificationLevel

@Nonnull
@CheckReturnValue
GuildManager setDefaultNotificationLevel(@Nonnull
 Guild.NotificationLevel level)

Sets the Notification Level of this Guild.

Parameters:

level - The new Notification Level for this Guild

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If the provided level is null or UNKNOWN

setExplicitContentLevel

@Nonnull
@CheckReturnValue
GuildManager setExplicitContentLevel(@Nonnull
 Guild.ExplicitContentLevel level)

Sets the Explicit Content Level of this Guild.

Parameters:

level - The new MFA Level for this Guild

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If the provided level is null or UNKNOWN

setBanner

@Nonnull
@CheckReturnValue
GuildManager setBanner(@Nullable
 Icon banner)

Sets the Banner Icon of this Guild.

Parameters:

banner - The new banner for this Guild or null to reset

Returns:

GuildManager for chaining convenience

Throws:

IllegalStateException - If the guild's features do not include BANNER

setDescription

@Nonnull
@CheckReturnValue
GuildManager setDescription(@Nullable
 String description)

Sets the Description Icon of this Guild.

Parameters:

description - The new description for this Guild or null to reset

Returns:

GuildManager for chaining convenience

Throws:

IllegalStateException - If the guild's features do not include VERIFIED

setBoostProgressBarEnabled

@Nonnull
@CheckReturnValue
GuildManager setBoostProgressBarEnabled(boolean boostProgressBarEnabled)

Sets whether this Guild should have its boost progress bar shown.

Parameters:

boostProgressBarEnabled - Whether the boost progress bar should be shown for this Guild

Returns:

GuildManager for chaining convenience

setFeatures

@Nonnull
@CheckReturnValue
GuildManager setFeatures(@Nonnull
 Collection<String> features)

Configures the new features of the Guild.
The list of available features, including which ones can be configured, is available in the Official Discord API Documentation.

Example

List<String> features = new ArrayList<>(guild.getFeatures());
features.add("INVITES_DISABLED");
guild.getManager().setFeatures(features).queue();

Parameters:

features - The new features to use

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If the provided list is null

addFeatures

@Nonnull
@CheckReturnValue
GuildManager addFeatures(@Nonnull
 Collection<String> features)

Adds a Guild Feature to the list of features.
The list of available features, including which ones can be configured, is available in the Official Discord API Documentation.

Parameters:

features - The features to add

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If any of the provided features is null

addFeatures

@Nonnull
@CheckReturnValue
default GuildManager addFeatures(@Nonnull
 String... features)

Adds a Guild Feature to the list of features.
The list of available features, including which ones can be configured, is available in the Official Discord API Documentation.

Parameters:

features - The features to add

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If any of the provided features is null

removeFeatures

@Nonnull
@CheckReturnValue
GuildManager removeFeatures(@Nonnull
 Collection<String> features)

Removes a Guild Feature from the list of features.
The list of available features, including which ones can be configured, is available in the Official Discord API Documentation.

Parameters:

features - The features to remove

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If any of the provided features is null

removeFeatures

@Nonnull
@CheckReturnValue
default GuildManager removeFeatures(@Nonnull
 String... features)

Removes a Guild Feature from the list of features.
The list of available features, including which ones can be configured, is available in the Official Discord API Documentation.

Parameters:

features - The features to remove

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If any of the provided features is null

setSystemChannelFlags

@Nonnull
@CheckReturnValue
GuildManager setSystemChannelFlags(@Nonnull
 Collection<SystemChannelFlag> flags)

Configures the new system channel flags of the Guild.
The list of available system channel flags, is available in the Official Discord API Documentation.

Example

List<SystemChannelFlag> flags = new ArrayList<>(guild.getSystemChannelFlags());
flags.add(SystemChannelFlag.SUPPRESS_JOIN_NOTIFICATIONS);
guild.getManager().setSystemChannelFlags(flags).queue();

Parameters:

flags - Collection of the new flags to use, flags not included in the collection will be disabled

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If any of the flags in the provided collection is null, or if the collection itself is null

See Also:

• SystemChannelFlag

setSystemChannelFlags

@Nonnull
@CheckReturnValue
default GuildManager setSystemChannelFlags(@Nonnull
 SystemChannelFlag... flags)

Configures the new system channel flags of the Guild. A system channel flag in the corresponding guild will be enabled if and only if it is in the method input.
The list of available system channel flags, is available in the Official Discord API Documentation.

Parameters:

flags - The system channel flags to set

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If the array is null

See Also:

• SystemChannelFlag

enableSystemChannelFlags

@Nonnull
@CheckReturnValue
GuildManager enableSystemChannelFlags(@Nonnull
 Collection<SystemChannelFlag> flags)

Enables the given system channel flags.
The list of available system channel flags, is available in the Official Discord API Documentation.

Parameters:

flags - A collection of the system channel flags to enable

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If any of the flags in the provided collection are null, or if the collection itself is null

enableSystemChannelFlags

@Nonnull
@CheckReturnValue
default GuildManager enableSystemChannelFlags(@Nonnull
 SystemChannelFlag... flags)

Enables the given system channel flags.
The list of available system channel flags, is available in the Official Discord API Documentation.

Parameters:

flags - The system channel flags to enable

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If the array is null

disableSystemChannelFlags

@Nonnull
@CheckReturnValue
GuildManager disableSystemChannelFlags(@Nonnull
 Collection<SystemChannelFlag> flags)

Disables the given system channel flags.
The list of available system channel flags, is available in the Official Discord API Documentation.

Parameters:

flags - The system channel flags to disable

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If any of the flags in the provided collection are null, or if the collection itself is null

disableSystemChannelFlags

@Nonnull
@CheckReturnValue
default GuildManager disableSystemChannelFlags(@Nonnull
 SystemChannelFlag... flags)

Disables the given system channel flags.
The list of available system channel flags, is available in the Official Discord API Documentation.

Parameters:

flags - The system channel flags to disable

Returns:

GuildManager for chaining convenience

Throws:

IllegalArgumentException - If the array is null

setInvitesDisabled

@Nonnull
@CheckReturnValue
default GuildManager setInvitesDisabled(boolean disabled)

Configures the INVITES_DISABLED feature flag of this guild.
This is equivalent to adding or removing the feature INVITES_DISABLED via setFeatures(Collection).

Parameters:

disabled - True, to pause/disable all invites to the guild

Returns:

GuildManager for chaining convenience