Package net.dv8tion.jda.api.managers

Interface GuildManager

All Superinterfaces:

AuditableRestAction<java.lang.Void>, Manager<GuildManager>, RestAction<java.lang.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 long	AFK_CHANNEL	Used to reset the afk channel field
static long	AFK_TIMEOUT	Used to reset the afk timeout field
static long	BANNER	Used to reset the banner field
static long	COMMUNITY_UPDATES_CHANNEL	Used to reset the community updates channel field
static long	DESCRIPTION	Used to reset the description field
static long	EXPLICIT_CONTENT_LEVEL	Used to reset the explicit content level field
static long	ICON	Used to reset the icon field
static long	MFA_LEVEL	Used to reset the mfa level field
static long	NAME	Used to reset the name field
static long	NOTIFICATION_LEVEL	Used to reset the default notification level field
static long	REGION	Used to reset the region field
static long	RULES_CHANNEL	Used to reset the rules channel field
static long	SPLASH	Used to reset the splash field
static long	SYSTEM_CHANNEL	Used to reset the system channel field
static long	VANITY_URL	Used to reset the vanity code field
static long	VERIFICATION_LEVEL	Used to reset the verification level field

Method Summary

Modifier and Type	Method	Description
Guild	getGuild()	The Guild object of this Manager.
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	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(java.lang.String description)	Sets the Description Icon of this Guild.
GuildManager	setExplicitContentLevel(Guild.ExplicitContentLevel level)	Sets the Explicit Content Level of this Guild.
GuildManager	setIcon(Icon icon)	Sets the Icon of this Guild.
GuildManager	setName(java.lang.String name)	Sets the name of this Guild.
GuildManager	setRegion(Region region)	Deprecated. Guilds no longer have the Region option.
GuildManager	setRequiredMFALevel(Guild.MFALevel level)	Sets the MFA Level of this Guild.
GuildManager	setRulesChannel(TextChannel rulesChannel)	Sets the rules 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	setVanityCode(java.lang.String code)	Sets the Vanity Code Icon of this Guild.
GuildManager	setVerificationLevel(Guild.VerificationLevel level)	Sets the Verification Level of this Guild.

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

REGION

static final long REGION

Used to reset the region 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

MFA_LEVEL

static final long MFA_LEVEL

Used to reset the mfa level 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

VANITY_URL

static final long VANITY_URL

Used to reset the vanity code 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

Method Detail

reset

@Nonnull
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
• REGION
• SPLASH
• AFK_CHANNEL
• AFK_TIMEOUT
• SYSTEM_CHANNEL
• RULES_CHANNEL
• COMMUNITY_UPDATES_CHANNEL
• MFA_LEVEL
• NOTIFICATION_LEVEL
• EXPLICIT_CONTENT_LEVEL
• VERIFICATION_LEVEL

Specified by:

reset in interface Manager<GuildManager>

Parameters:

fields - Integer value containing the flags to reset.

Returns:

GuildManager for chaining convenience

reset

@Nonnull
GuildManager reset(long... fields)

Resets the fields specified by the provided bit-flag patterns. 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
• REGION
• SPLASH
• AFK_CHANNEL
• AFK_TIMEOUT
• SYSTEM_CHANNEL
• RULES_CHANNEL
• COMMUNITY_UPDATES_CHANNEL
• MFA_LEVEL
• NOTIFICATION_LEVEL
• EXPLICIT_CONTENT_LEVEL
• VERIFICATION_LEVEL

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
                     java.lang.String name)

Sets the name of this Guild.

Parameters:

name - The new name for this Guild

Returns:

GuildManager for chaining convenience

Throws:

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

setRegion

@Nonnull
@CheckReturnValue
@Deprecated
@ForRemoval(deadline="5.0.0")
@ReplaceWith("ChannelManager.setRegion()")
@DeprecatedSince("4.3.0")
GuildManager setRegion(@Nonnull
                       Region region)

Deprecated.

Guilds no longer have the Region option. Use ChannelManager.setRegion(Region) instead.

Sets the Region of this Guild.

Parameters:

region - The new region for this Guild

Returns:

GuildManager for chaining convenience

Throws:

java.lang.IllegalArgumentException - If the provided region is a VIP Region but the guild does not support VIP regions. Use Guild#getFeatures() to check if VIP regions are supported.

See Also:

Region.isVip(), Guild.getFeatures()

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:

java.lang.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:

java.lang.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:

java.lang.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:

java.lang.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:

java.lang.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:

java.lang.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:

java.lang.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:

java.lang.IllegalArgumentException - If the provided level is null or UNKNOWN

setRequiredMFALevel

@Nonnull
@CheckReturnValue
GuildManager setRequiredMFALevel(@Nonnull
                                 Guild.MFALevel level)

Sets the MFA Level of this Guild.

Parameters:

level - The new MFA Level for this Guild

Returns:

GuildManager for chaining convenience

Throws:

java.lang.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:

java.lang.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:

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

setVanityCode

@Nonnull
@CheckReturnValue
GuildManager setVanityCode(@Nullable
                           java.lang.String code)

Sets the Vanity Code Icon of this Guild.

Parameters:

code - The new vanity code for this Guild or null to reset

Returns:

GuildManager for chaining convenience

Throws:

java.lang.IllegalStateException - If the guild's features do not include VANITY_URL

setDescription

@Nonnull
@CheckReturnValue
GuildManager setDescription(@Nullable
                            java.lang.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:

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