Package net.dv8tion.jda.core.managers

Class GuildManager

java.lang.Object

net.dv8tion.jda.core.requests.RestAction<T>

net.dv8tion.jda.core.requests.restaction.AuditableRestAction<java.lang.Void>

net.dv8tion.jda.core.managers.impl.ManagerBase

net.dv8tion.jda.core.managers.GuildManager

public class GuildManager
extends net.dv8tion.jda.core.managers.impl.ManagerBase

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()

Nested Class Summary

Nested classes/interfaces inherited from class net.dv8tion.jda.core.requests.restaction.AuditableRestAction

AuditableRestAction.EmptyRestAction<T>

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	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	SPLASH	Used to reset the splash field
static long	SYSTEM_CHANNEL	Used to reset the system channel field
static long	VERIFICATION_LEVEL	Used to reset the verification level field

Fields inherited from class net.dv8tion.jda.core.requests.RestAction

DEFAULT_FAILURE, DEFAULT_SUCCESS, LOG

Constructor Summary

Constructors

Constructor	Description
GuildManager(Guild guild)

Method Summary

Modifier and Type	Method	Description
Guild	getGuild()	The Guild object of this Manager.
GuildManager	reset()	Resets all fields for 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	setDefaultNotificationLevel(Guild.NotificationLevel level)	Sets the Notification Level 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)	Sets the Region of this Guild.
GuildManager	setRequiredMFALevel(Guild.MFALevel level)	Sets the MFA Level 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	setVerificationLevel(Guild.VerificationLevel level)	Sets the Verification Level of this Guild.

Methods inherited from class net.dv8tion.jda.core.requests.restaction.AuditableRestAction

reason, setCheck

Methods inherited from class net.dv8tion.jda.core.managers.impl.ManagerBase

complete, isPermissionChecksEnabled, queue, setPermissionChecksEnabled

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class net.dv8tion.jda.core.requests.RestAction

complete, completeAfter, getJDA, isPassContext, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, setPassContext, submit, submit, submitAfter, submitAfter

Field Detail

NAME

public static final long NAME

Used to reset the name field

See Also:

Constant Field Values

REGION

public static final long REGION

Used to reset the region field

See Also:

Constant Field Values

ICON

public static final long ICON

Used to reset the icon field

See Also:

Constant Field Values

SPLASH

public static final long SPLASH

Used to reset the splash field

See Also:

Constant Field Values

AFK_CHANNEL

public static final long AFK_CHANNEL

Used to reset the afk channel field

See Also:

Constant Field Values

AFK_TIMEOUT

public static final long AFK_TIMEOUT

Used to reset the afk timeout field

See Also:

Constant Field Values

SYSTEM_CHANNEL

public static final long SYSTEM_CHANNEL

Used to reset the system channel field

See Also:

Constant Field Values

MFA_LEVEL

public static final long MFA_LEVEL

Used to reset the mfa level field

See Also:

Constant Field Values

NOTIFICATION_LEVEL

public static final long NOTIFICATION_LEVEL

Used to reset the default notification level field

See Also:

Constant Field Values

EXPLICIT_CONTENT_LEVEL

public static final long EXPLICIT_CONTENT_LEVEL

Used to reset the explicit content level field

See Also:

Constant Field Values

VERIFICATION_LEVEL

public static final long VERIFICATION_LEVEL

Used to reset the verification level field

See Also:

Constant Field Values

Constructor Detail

GuildManager

public GuildManager(Guild guild)

Method Detail

getGuild

public Guild getGuild()

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

Returns:

The Guild of this Manager

reset

@CheckReturnValue
public 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
• MFA_LEVEL
• NOTIFICATION_LEVEL
• EXPLICIT_CONTENT_LEVEL
• VERIFICATION_LEVEL

Overrides:

reset in class net.dv8tion.jda.core.managers.impl.ManagerBase

Parameters:

fields - Integer value containing the flags to reset.

Returns:

GuildManager for chaining convenience

reset

@CheckReturnValue
public 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
• MFA_LEVEL
• NOTIFICATION_LEVEL
• EXPLICIT_CONTENT_LEVEL
• VERIFICATION_LEVEL

Overrides:

reset in class net.dv8tion.jda.core.managers.impl.ManagerBase

Parameters:

fields - Integer values containing the flags to reset.

Returns:

GuildManager for chaining convenience

reset

@CheckReturnValue
public GuildManager reset()

Resets all fields for this manager.

Overrides:

reset in class net.dv8tion.jda.core.managers.impl.ManagerBase

Returns:

GuildManager for chaining convenience

setName

@CheckReturnValue
public GuildManager setName(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

@CheckReturnValue
public GuildManager setRegion(Region region)

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

@CheckReturnValue
public GuildManager setIcon(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

@CheckReturnValue
public GuildManager setSplash(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.IllegalArgumentException - If the guild's features does not include INVITE_SPLASH

setAfkChannel

@CheckReturnValue
public GuildManager setAfkChannel(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

@CheckReturnValue
public GuildManager setSystemChannel(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

setAfkTimeout

@CheckReturnValue
public GuildManager setAfkTimeout(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

@CheckReturnValue
public GuildManager setVerificationLevel(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

@CheckReturnValue
public GuildManager setDefaultNotificationLevel(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

@CheckReturnValue
public GuildManager setRequiredMFALevel(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

@CheckReturnValue
public GuildManager setExplicitContentLevel(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