Package net.dv8tion.jda.internal.entities

Class GuildImpl

java.lang.Object

net.dv8tion.jda.internal.entities.GuildImpl

All Implemented Interfaces:

IGuildChannelContainer<GuildChannel>, IDetachableEntity, Guild, ISnowflake

public class GuildImpl
extends Object
implements Guild

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.Guild

Guild.Ban, Guild.BoostTier, Guild.ExplicitContentLevel, Guild.MetaData, Guild.MFALevel, Guild.NotificationLevel, Guild.NSFWLevel, Guild.Timeout, Guild.VerificationLevel

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.Guild

BANNER_URL, ICON_URL, SPLASH_URL

Constructor Summary

Constructors

Constructor	Description
GuildImpl(JDAImpl api, long id)

Method Summary

Modifier and Type	Method	Description
MemberAction	addMember(String accessToken, UserSnowflake user)	Adds the user to this guild as a member.
AuditableRestAction<Void>	addRoleToMember(UserSnowflake user, Role role)	Atomically assigns the provided Role to the specified Member.
AuditableRestAction<BulkBanResponse>	ban(Collection<? extends UserSnowflake> users, Duration deletionTime)	Bans up to 200 of the provided users.
AuditableRestAction<Void>	ban(UserSnowflake user, int duration, TimeUnit unit)	Bans the user specified by the provided UserSnowflake and deletes messages sent by the user based on the deletionTimeframe.
Task<Void>	cancelRequestToSpeak()	Cancels the Request-to-Speak.
AuditableRestAction<AutoModRule>	createAutoModRule(AutoModRuleData rule)	Creates a new AutoModRule for this guild.
ChannelAction<Category>	createCategory(String name)	Creates a new Category in this Guild.
AuditableRestAction<RichCustomEmoji>	createEmoji(String name, Icon icon, Role... roles)	Creates a new RichCustomEmoji in this Guild.
ChannelAction<ForumChannel>	createForumChannel(String name, Category parent)	Creates a new ForumChannel in this Guild.
ChannelAction<MediaChannel>	createMediaChannel(String name, Category parent)	Creates a new MediaChannel in this Guild.
ChannelAction<NewsChannel>	createNewsChannel(String name, Category parent)	Creates a new NewsChannel in this Guild.
RoleAction	createRole()	Creates a new Role in this Guild.
ScheduledEventAction	createScheduledEvent(String name, String location, OffsetDateTime startTime, OffsetDateTime endTime)	Creates a new ScheduledEvent.
ScheduledEventAction	createScheduledEvent(String name, GuildChannel channel, OffsetDateTime startTime)	Creates a new ScheduledEvent.
ChannelAction<StageChannel>	createStageChannel(String name, Category parent)	Creates a new StageChannel in this Guild.
AuditableRestAction<GuildSticker>	createSticker(String name, String description, FileUpload file, Collection<String> tags)	Creates a new GuildSticker in this Guild.
RestAction<Template>	createTemplate(String name, String description)	Used to create a new Template for this Guild.
ChannelAction<TextChannel>	createTextChannel(String name, Category parent)	Creates a new TextChannel in this Guild.
ChannelAction<VoiceChannel>	createVoiceChannel(String name, Category parent)	Creates a new VoiceChannel in this Guild.
AuditableRestAction<Void>	deafen(UserSnowflake user, boolean deafen)	Sets the Guild Deafened state of the Member based on the provided boolean.
RestAction<Void>	delete()	Used to completely delete a Guild.
RestAction<Void>	delete(String mfaCode)	Used to completely delete a guild.
AuditableRestAction<Void>	deleteAutoModRuleById(String id)	Deletes the AutoModRule for the provided id.
RestAction<Void>	deleteCommandById(String commandId)	Delete the command for this id.
AuditableRestAction<Void>	deleteSticker(StickerSnowflake id)	Deletes a sticker from the guild.
CommandEditAction	editCommandById(Command.Type type, String id)	Edit an existing command by id.
GuildStickerManager	editSticker(StickerSnowflake sticker)	Modify a sticker using GuildStickerManager.
boolean	equals(Object o)
VoiceChannel	getAfkChannel()	Provides the VoiceChannel that has been set as the channel which Members will be moved to after they have been inactive in a VoiceChannel for longer than Guild.getAfkTimeout().
Guild.Timeout	getAfkTimeout()	The Timeout set for this Guild representing the amount of time that must pass for a Member to have had no activity in a VoiceChannel to be considered AFK.
AudioManager	getAudioManager()	The AudioManager that represents the audio connection for this Guild.
String	getBannerId()	The guild banner id.
int	getBoostCount()	The amount of boosts this server currently has.
List<Member>	getBoosters()	Sorted list of Members that boost this guild.
Guild.BoostTier	getBoostTier()	The boost tier for this guild.
SortedSnowflakeCacheView<Category>	getCategoryCache()	Sorted SnowflakeCacheView of Category.
SortedChannelCacheViewImpl<GuildChannel>	getChannelCache()	SortedChannelCacheView of GuildChannel.
List<GuildChannel>	getChannels(boolean includeHidden)	Populated list of channels for this guild.
SortedChannelCacheViewImpl<GuildChannel>	getChannelView()
TextChannel	getCommunityUpdatesChannel()	Provides the TextChannel that receives community updates.
List<Member>	getConnectedMembers(GuildChannel channel)
DefaultGuildChannelUnion	getDefaultChannel()	The default StandardGuildChannel for a Guild.
Guild.NotificationLevel	getDefaultNotificationLevel()	Returns the default message Notification-Level of this Guild.
String	getDescription()	The description for this guild.
SnowflakeCacheView<RichCustomEmoji>	getEmojiCache()	SnowflakeCacheView of all cached Custom Emojis of this Guild.
SnowflakeCacheViewImpl<RichCustomEmoji>	getEmojisView()
Guild.ExplicitContentLevel	getExplicitContentLevel()	The level of content filtering enabled in this Guild.
Set<String>	getFeatures()	The Features of the Guild.
SortedSnowflakeCacheView<ForumChannel>	getForumChannelCache()	SnowflakeCacheView of ForumChannel.
GuildChannel	getGuildChannelById(long id)	Get GuildChannel for the provided ID.
GuildChannel	getGuildChannelById(ChannelType type, long id)	Get GuildChannel for the provided ID.
String	getIconId()	The Discord hash-id of the Guild icon image.
long	getIdLong()	The Snowflake id of this entity.
JDAImpl	getJDA()	Returns the JDA instance of this Guild
DiscordLocale	getLocale()	The preferred locale for this guild.
GuildManager	getManager()	Returns the GuildManager for this Guild, used to modify all properties and settings of the Guild.
int	getMaxMembers()	The maximum amount of members that can join this guild.
int	getMaxPresences()	The maximum amount of connected members this guild can have at a time.
SnowflakeCacheView<MediaChannel>	getMediaChannelCache()	SnowflakeCacheView of MediaChannel.
Member	getMember(UserSnowflake user)	Gets the Guild specific Member object for the provided UserSnowflake.
MemberCacheView	getMemberCache()	MemberCacheView for all cached Members of this Guild.
int	getMemberCount()	The expected member count for this guild.
MemberCacheViewImpl	getMembersView()
String	getName()	The human readable name of the Guild.
SortedSnowflakeCacheView<NewsChannel>	getNewsChannelCache()	Sorted SnowflakeCacheView of NewsChannel.
Guild.NSFWLevel	getNSFWLevel()	Returns the NSFW Level that this guild is classified with.
Member	getOwner()	The Member object for the owner of this Guild.
long	getOwnerIdLong()	The ID for the current owner of this guild.
CacheView.SimpleCacheView<MemberPresenceImpl>	getPresenceView()
Role	getPublicRole()	The @everyone Role of this Guild.
Guild.MFALevel	getRequiredMFALevel()	Returns the level of multifactor authentication required to execute administrator restricted functions in this guild.
SortedSnowflakeCacheView<Role>	getRoleCache()	Sorted SnowflakeCacheView of all cached Roles of this Guild.
SortedSnowflakeCacheViewImpl<Role>	getRolesView()
TextChannel	getRulesChannel()	Provides the TextChannel that lists the rules of the guild.
TextChannel	getSafetyAlertsChannel()	Provides the TextChannel that receives discord safety alerts.
SortedSnowflakeCacheView<ScheduledEvent>	getScheduledEventCache()	Sorted SnowflakeCacheView of all cached ScheduledEvents of this Guild.
SortedSnowflakeCacheViewImpl<ScheduledEvent>	getScheduledEventsView()
SecurityIncidentActions	getSecurityIncidentActions()	The current guild security incident actions.
SecurityIncidentDetections	getSecurityIncidentDetections()	The current security incident detections.
Member	getSelfMember()	Gets the Member object of the currently logged in account in this guild.
String	getSplashId()	The Discord hash-id of the splash image for this Guild.
SortedSnowflakeCacheView<StageChannel>	getStageChannelCache()	Sorted SnowflakeCacheView of StageChannel.
SnowflakeCacheView<GuildSticker>	getStickerCache()	SnowflakeCacheView of all cached GuildStickers of this Guild.
SnowflakeCacheViewImpl<GuildSticker>	getStickersView()
TextChannel	getSystemChannel()	Provides the TextChannel that has been set as the channel which newly joined Members will be announced in.
SortedSnowflakeCacheView<TextChannel>	getTextChannelCache()	Sorted SnowflakeCacheView of TextChannel.
SortedSnowflakeCacheView<ThreadChannel>	getThreadChannelCache()	SnowflakeCacheView of ThreadChannel.
String	getVanityCode()	The vanity url code for this Guild.
Guild.VerificationLevel	getVerificationLevel()	Returns the verification-Level of this Guild.
SortedSnowflakeCacheView<VoiceChannel>	getVoiceChannelCache()	Sorted SnowflakeCacheView of VoiceChannel.
GuildVoiceStateImpl	getVoiceState(Member member)
List<GuildVoiceState>	getVoiceStates()	A list containing the cached GuildVoiceState of every Member connected to an audio channel in this guild.
SnowflakeCacheViewImpl<GuildVoiceStateImpl>	getVoiceStateView()
void	handleVoiceStateUpdate(GuildVoiceStateImpl voiceState)
int	hashCode()
void	invalidate()
boolean	isBoostProgressBarEnabled()	Returns whether this Guild has its boost progress bar shown.
boolean	isDetached()	Whether this entity is detached.
boolean	isLoaded()	Whether this guild has loaded members.
boolean	isMember(UserSnowflake user)	Used to determine if the provided UserSnowflake is a member of this Guild.
AuditableRestAction<Void>	kick(UserSnowflake user)	Kicks a Member from the Guild.
RestAction<Void>	leave()	Used to leave a Guild.
Task<Void>	loadMembers(Consumer<Member> callback)	Retrieves all members of this guild.
AutoModRuleManager	modifyAutoModRuleById(String id)	Returns an AutoModRuleManager, which can be used to modify the rule for the provided id.
ChannelOrderAction	modifyCategoryPositions()	Modifies the positional order of Guild.getCategories() using a specific RestAction extension to allow moving Channels up/down or to a specific position.
AuditableRestAction<Void>	modifyMemberRoles(Member member, Collection<Role> roles)	Modifies the complete Role set of the specified Member The provided roles will replace all current Roles of the specified Member.
AuditableRestAction<Void>	modifyMemberRoles(Member member, Collection<Role> rolesToAdd, Collection<Role> rolesToRemove)	Modifies the Roles of the specified Member by adding and removing a collection of roles.
AuditableRestAction<Void>	modifyNickname(Member member, String nickname)	Changes the Member's nickname in this guild.
RoleOrderAction	modifyRolePositions(boolean useAscendingOrder)	Modifies the positional order of Guild.getRoles() using a specific RestAction extension to allow moving Roles up/down or to a specific position.
AuditableRestAction<Void>	modifySecurityIncidents(SecurityIncidentActions incidents)	Update the current guild security incident actions.
ChannelOrderAction	modifyTextChannelPositions()	Modifies the positional order of Guild.getTextChannels() using a specific RestAction extension to allow moving Channels up/down or to a specific position.
CategoryOrderAction	modifyTextChannelPositions(Category category)	Modifies the positional order of Category#getTextChannels() using an extension of ChannelOrderAction specialized for ordering the nested TextChannels of this Category.
ChannelOrderAction	modifyVoiceChannelPositions()	Modifies the positional order of Guild.getVoiceChannels() using a specific RestAction extension to allow moving Channels up/down or to a specific position.
CategoryOrderAction	modifyVoiceChannelPositions(Category category)	Modifies the positional order of Category#getVoiceChannels() using an extension of ChannelOrderAction specialized for ordering the nested VoiceChannels of this Category.
GuildWelcomeScreenManager	modifyWelcomeScreen()	The Manager for this guild's welcome screen, used to modify properties of the welcome screen like if the welcome screen is enabled, the description and welcome channels.
RestAction<Void>	moveVoiceMember(UserSnowflake user, AudioChannel audioChannel)	Used to move a Member from one AudioChannel to another AudioChannel.
AuditableRestAction<Void>	mute(UserSnowflake user, boolean mute)	Sets the Guild Muted state of the Member based on the provided boolean.
void	onMemberAdd()
void	onMemberRemove(long memberId)
AuditableRestAction<Integer>	prune(int days, boolean wait, Role... roles)	This method will prune (kick) all members who were offline for at least days days.
void	pruneMemberCache()	Re-apply the MemberCachePolicy of this session to all Members of this Guild.
AuditableRestAction<Void>	removeRoleFromMember(UserSnowflake user, Role role)	Atomically removes the provided Role from the specified Member.
AuditableRestAction<Void>	removeTimeout(UserSnowflake user)	Removes a time out from the specified Member in this Guild.
Task<Void>	requestToSpeak()	Once the currently logged in account is connected to a StageChannel, this will trigger a Request-to-Speak (aka raise your hand).
RestAction<List<ThreadChannel>>	retrieveActiveThreads()	Retrieves the active threads in this guild.
AuditLogPaginationAction	retrieveAuditLogs()	A PaginationAction implementation that allows to iterate over all AuditLogEntries of this Guild.
RestAction<AutoModRule>	retrieveAutoModRuleById(String id)	Retrieves the AutoModRule for the provided id.
RestAction<List<AutoModRule>>	retrieveAutoModRules()	Retrieves all current AutoModRules for this guild.
RestAction<Guild.Ban>	retrieveBan(UserSnowflake user)	Retrieves a Ban of the provided UserSnowflake.
BanPaginationActionImpl	retrieveBanList()	Retrieves an immutable list of the currently banned Users.
RestAction<Command>	retrieveCommandById(String id)	Retrieves the existing Command instance by id.
RestAction<PrivilegeConfig>	retrieveCommandPrivileges()	Retrieves the IntegrationPrivileges for the commands in this guild.
RestAction<List<Command>>	retrieveCommands(boolean withLocalizations)	Retrieves the list of guild commands.
RestAction<RichCustomEmoji>	retrieveEmojiById(String id)	Retrieves a custom emoji together with its respective creator.
RestAction<List<RichCustomEmoji>>	retrieveEmojis()	Retrieves an immutable list of Custom Emojis together with their respective creators.
RestAction<List<IntegrationPrivilege>>	retrieveIntegrationPrivilegesById(String targetId)	Retrieves the IntegrationPrivileges for the target with the specified ID.
RestAction<List<Invite>>	retrieveInvites()	Retrieves all Invites for this guild.
CacheRestAction<Member>	retrieveMemberById(long id)	Load the member for the specified user.
Task<List<Member>>	retrieveMembersByIds(boolean includePresence, long... ids)	Retrieves a list of members by their user id.
Task<List<Member>>	retrieveMembersByPrefix(String prefix, int limit)	Queries a list of members using a radix tree based on the provided name prefix.
CacheRestAction<GuildVoiceState>	retrieveMemberVoiceStateById(long id)	Load the member's voice state for the specified user.
RestAction<Guild.MetaData>	retrieveMetaData()	Loads Guild.MetaData for this guild instance.
RestAction<Integer>	retrievePrunableMemberCount(int days)	The method calculates the amount of Members that would be pruned if Guild.prune(int, Role...) was executed.
RestAction<EnumSet<Region>>	retrieveRegions(boolean includeDeprecated)	Retrieves the available regions for this Guild
CacheRestAction<ScheduledEvent>	retrieveScheduledEventById(long id)	Retrieves a ScheduledEvent by its ID.
CacheRestAction<ScheduledEvent>	retrieveScheduledEventById(String id)	Retrieves a ScheduledEvent by its ID.
RestAction<List<ScheduledEvent>>	retrieveScheduledEvents(boolean includeUserCount)	Retrieves all ScheduledEvents for this guild.
RestAction<GuildSticker>	retrieveSticker(StickerSnowflake sticker)	Attempts to retrieve a GuildSticker object for this guild based on the provided snowflake reference.
RestAction<List<GuildSticker>>	retrieveStickers()	Retrieves all the stickers from this guild.
RestAction<List<Template>>	retrieveTemplates()	Retrieves all Templates for this guild.
RestAction<VanityInvite>	retrieveVanityInvite()	Retrieves the Vanity Invite meta data for this guild.
RestAction<List<Webhook>>	retrieveWebhooks()	Retrieves all Webhooks for this Guild.
RestAction<GuildWelcomeScreen>	retrieveWelcomeScreen()	Retrieves the welcome screen for this Guild.
GuildImpl	setAfkChannel(VoiceChannel afkChannel)
GuildImpl	setAfkTimeout(Guild.Timeout afkTimeout)
GuildImpl	setBannerId(String bannerId)
GuildImpl	setBoostCount(int count)
GuildImpl	setBoostProgressBarEnabled(boolean enabled)
GuildImpl	setBoostTier(int tier)
GuildImpl	setCommunityUpdatesChannel(TextChannel communityUpdatesChannel)
GuildImpl	setDefaultNotificationLevel(Guild.NotificationLevel level)
GuildImpl	setDescription(String description)
GuildImpl	setExplicitContentLevel(Guild.ExplicitContentLevel level)
GuildImpl	setFeatures(Set<String> features)
GuildImpl	setIconId(String iconId)
GuildImpl	setLocale(DiscordLocale locale)
GuildImpl	setMaxMembers(int maxMembers)
GuildImpl	setMaxPresences(int maxPresences)
GuildImpl	setMemberCount(int count)
GuildImpl	setName(String name)
GuildImpl	setNSFWLevel(Guild.NSFWLevel nsfwLevel)
GuildImpl	setOwner(Member owner)
GuildImpl	setOwnerId(long ownerId)
GuildImpl	setPublicRole(Role publicRole)
GuildImpl	setRequiredMFALevel(Guild.MFALevel level)
GuildImpl	setRulesChannel(TextChannel rulesChannel)
GuildImpl	setSafetyAlertsChannel(TextChannel safetyAlertsChannel)
GuildImpl	setSecurityIncidentActions(SecurityIncidentActions actions)
GuildImpl	setSecurityIncidentDetections(SecurityIncidentDetections detections)
GuildImpl	setSplashId(String splashId)
GuildImpl	setSystemChannel(TextChannel systemChannel)
GuildImpl	setVanityCode(String code)
GuildImpl	setVerificationLevel(Guild.VerificationLevel level)
boolean	shouldCacheVoiceState(long userId)
AuditableRestAction<Void>	timeoutUntil(UserSnowflake user, TemporalAccessor temporal)	Puts the specified Member in time out in this Guild until the specified date.
String	toString()
AuditableRestAction<Void>	transferOwnership(Member newOwner)	Transfers the Guild ownership to the specified Member Only available if the currently logged in account is the owner of this Guild
AuditableRestAction<Void>	unban(UserSnowflake user)	Unbans the specified UserSnowflake from this Guild.
void	uncacheChannel(GuildChannel channel, boolean keepThreads)
boolean	unloadMember(long userId)	Attempts to remove the user with the provided id from the member cache.
void	updateCacheVoiceStateMember(MemberImpl member)
CommandListUpdateAction	updateCommands()	Configures the complete list of guild commands.
void	updateRequestToSpeak()
CommandCreateAction	upsertCommand(CommandData command)	Creates or updates a command.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.entities.Guild

ban, createCopyOfChannel, createCopyOfRole, createForumChannel, createMediaChannel, createNewsChannel, createStageChannel, createSticker, createTextChannel, createVoiceChannel, deleteAutoModRuleById, deleteCommandById, editCommandById, findMembers, findMembersWithRoles, findMembersWithRoles, getBanner, getBannerUrl, getBoostRole, getBotRole, getChannels, getEmojiById, getEmojiById, getEmojis, getEmojisByName, getIcon, getIconUrl, getMaxBitrate, getMaxEmojis, getMaxFileSize, getMemberById, getMemberById, getMemberByTag, getMemberByTag, getMembers, getMembersByEffectiveName, getMembersByName, getMembersByNickname, getMembersWithRoles, getMembersWithRoles, getOwnerId, getRoleByBot, getRoleByBot, getRoleByBot, getRoleById, getRoleById, getRoles, getRolesByName, getScheduledEventById, getScheduledEventById, getScheduledEvents, getScheduledEventsByName, getSplash, getSplashUrl, getStickerById, getStickerById, getStickers, getStickersByName, getVanityUrl, isInvitesDisabled, kickVoiceMember, loadMembers, modifyAutoModRuleById, modifyMemberRoles, modifyRolePositions, prune, retrieveAutoModRuleById, retrieveCommandById, retrieveCommands, retrieveEmoji, retrieveEmojiById, retrieveIntegrationPrivilegesById, retrieveMember, retrieveMemberById, retrieveMembers, retrieveMembers, retrieveMembersByIds, retrieveMembersByIds, retrieveMembersByIds, retrieveMembersByIds, retrieveMembersByIds, retrieveMemberVoiceState, retrieveMemberVoiceStateById, retrieveOwner, retrieveRegions, retrieveScheduledEvents, timeoutFor, timeoutFor, upsertCommand

Methods inherited from interface net.dv8tion.jda.api.entities.channel.attribute.IGuildChannelContainer

getCategories, getCategoriesByName, getCategoryById, getCategoryById, getChannelById, getChannelById, getForumChannelById, getForumChannelById, getForumChannels, getForumChannelsByName, getGuildChannelById, getGuildChannelById, getMediaChannelById, getMediaChannelById, getMediaChannels, getMediaChannelsByName, getNewsChannelById, getNewsChannelById, getNewsChannels, getNewsChannelsByName, getStageChannelById, getStageChannelById, getStageChannels, getStageChannelsByName, getTextChannelById, getTextChannelById, getTextChannels, getTextChannelsByName, getThreadChannelById, getThreadChannelById, getThreadChannels, getThreadChannelsByName, getVoiceChannelById, getVoiceChannelById, getVoiceChannels, getVoiceChannelsByName

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getTimeCreated

Constructor Details

GuildImpl

public GuildImpl(JDAImpl api,
 long id)

Method Details

isDetached

public boolean isDetached()

Description copied from interface: IDetachableEntity

Whether this entity is detached.

If this returns true, this entity cannot be retrieved, will never be updated, and most methods that would otherwise return a RestAction will throw a DetachedEntityException instead.

Specified by:

isDetached in interface IDetachableEntity

Returns:

True, if the entity is detached

invalidate

public void invalidate()

uncacheChannel

public void uncacheChannel(GuildChannel channel,
 boolean keepThreads)

retrieveCommands

@Nonnull
public RestAction<List<Command>> retrieveCommands(boolean withLocalizations)

Description copied from interface: Guild

Retrieves the list of guild commands.
This list does not include global commands! Use JDA.retrieveCommands() for global commands.

Specified by:

retrieveCommands in interface Guild

Parameters:

withLocalizations - true if the localization data (such as name and description) should be included

Returns:

RestAction - Type: List of Command

retrieveCommandById

@Nonnull
public RestAction<Command> retrieveCommandById(@Nonnull
 String id)

Description copied from interface: Guild

Retrieves the existing Command instance by id.

If there is no command with the provided ID, this RestAction fails with ErrorResponse.UNKNOWN_COMMAND

Specified by:

retrieveCommandById in interface Guild

Parameters:

id - The command id

Returns:

RestAction - Type: Command

upsertCommand

@Nonnull
public CommandCreateAction upsertCommand(@Nonnull
 CommandData command)

Description copied from interface: Guild

Creates or updates a command.
If a command with the same name exists, it will be replaced. This operation is idempotent. Commands will persist between restarts of your bot, you only have to create a command once.

To specify a complete list of all commands you can use Guild.updateCommands() instead.

You need the OAuth2 scope "applications.commands" in order to add commands to a guild.

Specified by:

upsertCommand in interface Guild

Parameters:

command - The CommandData for the command

Returns:

RestAction - Type: Command
The RestAction used to create or update the command

See Also:

• Commands.slash(...)
• Commands.message(...)
• Commands.user(...)

updateCommands

@Nonnull
public CommandListUpdateAction updateCommands()

Description copied from interface: Guild

Configures the complete list of guild commands.
This will replace the existing command list for this guild. You should only use this at most once on startup!

This operation is idempotent. Commands will persist between restarts of your bot, you only have to create a command once.

You need the OAuth2 scope "applications.commands" in order to add commands to a guild.

Examples

Set list to 2 commands:

 guild.updateCommands()
   .addCommands(Commands.slash("ping", "Gives the current ping"))
   .addCommands(Commands.slash("ban", "Ban the target user")
     .addOption(OptionType.USER, "user", "The user to ban", true))
     .setDefaultPermissions(DefaultMemberPermissions.enabledFor(Permission.BAN_MEMBERS))
   .queue();
 

Delete all commands:

 guild.updateCommands().queue();
 

Specified by:

updateCommands in interface Guild

Returns:

CommandListUpdateAction

See Also:

• JDA.updateCommands()

editCommandById

@Nonnull
public CommandEditAction editCommandById(@Nonnull
 Command.Type type,
 @Nonnull
 String id)

Description copied from interface: Guild

Edit an existing command by id.

If there is no command with the provided ID, this RestAction fails with ErrorResponse.UNKNOWN_COMMAND

Specified by:

editCommandById in interface Guild

Parameters:

type - The command type

id - The id of the command to edit

Returns:

CommandEditAction used to edit the command

deleteCommandById

@Nonnull
public RestAction<Void> deleteCommandById(@Nonnull
 String commandId)

Description copied from interface: Guild

Delete the command for this id.

If there is no command with the provided ID, this RestAction fails with ErrorResponse.UNKNOWN_COMMAND

Specified by:

deleteCommandById in interface Guild

Parameters:

commandId - The id of the command that should be deleted

Returns:

RestAction

retrieveIntegrationPrivilegesById

@Nonnull
public RestAction<List<IntegrationPrivilege>> retrieveIntegrationPrivilegesById(@Nonnull
 String targetId)

Description copied from interface: Guild

Retrieves the IntegrationPrivileges for the target with the specified ID.
The ID can either be of a Command or Application!

Moderators of a guild can modify these privileges through the Integrations Menu

If there is no command or application with the provided ID, this RestAction fails with ErrorResponse.UNKNOWN_COMMAND

Specified by:

retrieveIntegrationPrivilegesById in interface Guild

Parameters:

targetId - The id of the command (global or guild), or application

Returns:

RestAction - Type: List of IntegrationPrivilege

retrieveCommandPrivileges

@Nonnull
public RestAction<PrivilegeConfig> retrieveCommandPrivileges()

Description copied from interface: Guild

Retrieves the IntegrationPrivileges for the commands in this guild.
The RestAction provides a PrivilegeConfig providing the privileges of this application and its commands.

Moderators of a guild can modify these privileges through the Integrations Menu

Specified by:

retrieveCommandPrivileges in interface Guild

Returns:

RestAction - Type: PrivilegeConfig

retrieveRegions

@Nonnull
public RestAction<EnumSet<Region>> retrieveRegions(boolean includeDeprecated)

Description copied from interface: Guild

Retrieves the available regions for this Guild

Specified by:

retrieveRegions in interface Guild

Parameters:

includeDeprecated - Whether to include deprecated regions

Returns:

RestAction - Type EnumSet

retrieveAutoModRules

@Nonnull
public RestAction<List<AutoModRule>> retrieveAutoModRules()

Description copied from interface: Guild

Retrieves all current AutoModRules for this guild.

Specified by:

retrieveAutoModRules in interface Guild

Returns:

RestAction - Type: List of AutoModRule

retrieveAutoModRuleById

@Nonnull
public RestAction<AutoModRule> retrieveAutoModRuleById(@Nonnull
 String id)

Description copied from interface: Guild

Retrieves the AutoModRule for the provided id.

Specified by:

retrieveAutoModRuleById in interface Guild

Parameters:

id - The id of the rule

Returns:

RestAction - Type: AutoModRule

createAutoModRule

@Nonnull
public AuditableRestAction<AutoModRule> createAutoModRule(@Nonnull
 AutoModRuleData rule)

Description copied from interface: Guild

Creates a new AutoModRule for this guild.

You can only create a certain number of rules for each AutoModTriggerType. The maximum is provided by AutoModTriggerType.getMaxPerGuild().

Specified by:

createAutoModRule in interface Guild

Parameters:

rule - The data for the new rule

Returns:

AuditableRestAction - Type: AutoModRule

modifyAutoModRuleById

@Nonnull
public AutoModRuleManager modifyAutoModRuleById(@Nonnull
 String id)

Description copied from interface: Guild

Returns an AutoModRuleManager, which can be used to modify the rule for the provided id.

The manager allows modifying multiple fields in a single request.
You modify multiple fields in one request by chaining setters before calling RestAction.queue().

Specified by:

modifyAutoModRuleById in interface Guild

Returns:

The manager instance

deleteAutoModRuleById

@Nonnull
public AuditableRestAction<Void> deleteAutoModRuleById(@Nonnull
 String id)

Description copied from interface: Guild

Deletes the AutoModRule for the provided id.

Specified by:

deleteAutoModRuleById in interface Guild

Parameters:

id - The id of the rule

Returns:

AuditableRestAction - Type: Void

addMember

@Nonnull
public MemberAction addMember(@Nonnull
 String accessToken,
 @Nonnull
 UserSnowflake user)

Description copied from interface: Guild

Adds the user to this guild as a member.
This requires an OAuth2 Access Token with the scope guilds.join.

Specified by:

addMember in interface Guild

Parameters:

accessToken - The access token

user - The UserSnowflake for the member to add. This can be a member or user instance or User.fromId(long).

Returns:

MemberAction

See Also:

• Discord OAuth2 Documentation

isLoaded

public boolean isLoaded()

Description copied from interface: Guild

Whether this guild has loaded members.
This will always be false if the GUILD_MEMBERS intent is disabled.

Specified by:

isLoaded in interface Guild

Returns:

True, if members are loaded.

pruneMemberCache

public void pruneMemberCache()

Description copied from interface: Guild

Re-apply the MemberCachePolicy of this session to all Members of this Guild.

Example

 // Check if the members of this guild have at least 50% bots (bot collection/farm)
 public void checkBots(Guild guild) {
     // Keep in mind: This requires the GUILD_MEMBERS intent which is disabled in createDefault and createLight by default
     guild.retrieveMembers() // Load members CompletableFuture<Void> (async and eager)
          .thenApply((v) -> guild.getMemberCache()) // Turn into CompletableFuture<MemberCacheView>
          .thenAccept((members) -> {
              int total = members.size();
              // Casting to double to get a double as result of division, don't need to worry about precision with small counts like this
              double bots = (double) members.applyStream(stream ->
                  stream.map(Member::getUser)
                        .filter(User::isBot)
                        .count()); // Count bots
              if (bots / total > 0.5) // Check how many members are bots
                  System.out.println("More than 50% of members in this guild are bots");
          })
          .thenRun(guild::pruneMemberCache); // Then prune the cache
 }
 

Specified by:

pruneMemberCache in interface Guild

See Also:

• Guild.unloadMember(long)
• JDA.unloadUser(long)

unloadMember

public boolean unloadMember(long userId)

Description copied from interface: Guild

Attempts to remove the user with the provided id from the member cache.
If you attempt to remove the SelfUser this will simply return false.

This should be used by an implementation of MemberCachePolicy as an upstream request to remove a member. For example a Least-Recently-Used (LRU) cache might use this to drop old members if the cache capacity is reached. Or a timeout cache could use this to remove expired members.

Specified by:

unloadMember in interface Guild

Parameters:

userId - The target user id

Returns:

True, if the cache was changed

See Also:

• Guild.pruneMemberCache()
• JDA.unloadUser(long)

getMemberCount

public int getMemberCount()

Description copied from interface: Guild

The expected member count for this guild.
If this guild is not lazy loaded this should be identical to the size returned by Guild.getMemberCache().

When GatewayIntent.GUILD_MEMBERS is disabled, this will not be updated.

Specified by:

getMemberCount in interface Guild

Returns:

The expected member count for this guild

getName

@Nonnull
public String getName()

Description copied from interface: Guild

The human readable name of the Guild.

This value can be modified using GuildManager.setName(String).

Specified by:

getName in interface Guild

Returns:

Never-null String containing the Guild's name.

getIconId

public String getIconId()

Description copied from interface: Guild

The Discord hash-id of the Guild icon image. If no icon has been set, this returns null.

The Guild icon can be modified using GuildManager.setIcon(Icon).

Specified by:

getIconId in interface Guild

Returns:

Possibly-null String containing the Guild's icon hash-id.

getFeatures

@Nonnull
public Set<String> getFeatures()

Description copied from interface: Guild

The Features of the Guild.

Features can be updated using GuildManager.setFeatures(Collection).

Specified by:

getFeatures in interface Guild

Returns:

Never-null, unmodifiable Set containing all of the Guild's features.

See Also:

• List of Features

getSplashId

public String getSplashId()

Description copied from interface: Guild

The Discord hash-id of the splash image for this Guild. A Splash image is an image displayed when viewing a Discord Guild Invite on the web or in client just before accepting or declining the invite. If no splash has been set, this returns null.
Splash images are VIP/Partner Guild only.

The Guild splash can be modified using GuildManager.setSplash(Icon).

Specified by:

getSplashId in interface Guild

Returns:

Possibly-null String containing the Guild's splash hash-id

getVanityCode

@Nullable
public String getVanityCode()

Description copied from interface: Guild

The vanity url code for this Guild. The vanity url is the custom invite code of partnered / official / boosted Guilds.
The returned String will be the code that can be provided to discord.gg/{code} to get the invite link.

Specified by:

getVanityCode in interface Guild

Returns:

The vanity code or null

See Also:

• Guild.getVanityUrl()

retrieveVanityInvite

@Nonnull
public RestAction<VanityInvite> retrieveVanityInvite()

Description copied from interface: Guild

Retrieves the Vanity Invite meta data for this guild.
This allows you to inspect how many times the vanity invite has been used. You can use Guild.getVanityUrl() if you only care about the invite.

This action requires the MANAGE_SERVER permission.

Possible ErrorResponses caused by the returned RestAction include the following:

• INVITE_CODE_INVALID
  If this guild does not have a vanity invite
• MISSING_PERMISSIONS
  The vanity invite cannot be fetched due to a permission discrepancy

Specified by:

retrieveVanityInvite in interface Guild

Returns:

RestAction - Type: VanityInvite

getDescription

@Nullable
public String getDescription()

Description copied from interface: Guild

The description for this guild.
This is displayed in the server browser below the guild name for verified guilds.

The description can be modified using GuildManager.setDescription(String).

Specified by:

getDescription in interface Guild

Returns:

The description

getLocale

@Nonnull
public DiscordLocale getLocale()

Description copied from interface: Guild

The preferred locale for this guild.
If the guild doesn't have the COMMUNITY feature, this returns the default.
Default: DiscordLocale.ENGLISH_US

Specified by:

getLocale in interface Guild

Returns:

The preferred DiscordLocale for this guild

getBannerId

@Nullable
public String getBannerId()

Description copied from interface: Guild

The guild banner id.
This is shown in guilds below the guild name.

The banner can be modified using GuildManager.setBanner(Icon).

Specified by:

getBannerId in interface Guild

Returns:

The guild banner id or null

See Also:

• Guild.getBannerUrl()

getBoostTier

@Nonnull
public Guild.BoostTier getBoostTier()

Description copied from interface: Guild

The boost tier for this guild.
Each tier unlocks new perks for a guild that can be seen in the features.

Specified by:

getBoostTier in interface Guild

Returns:

The boost tier.

getBoostCount

public int getBoostCount()

Description copied from interface: Guild

The amount of boosts this server currently has.

Specified by:

getBoostCount in interface Guild

Returns:

The boost count

getBoosters

@Nonnull
public List<Member> getBoosters()

Description copied from interface: Guild

Sorted list of Members that boost this guild.
The list is sorted by Member.getTimeBoosted() ascending. This means the first element will be the member who has been boosting for the longest time.

This will only check cached members!
See MemberCachePolicy

Specified by:

getBoosters in interface Guild

Returns:

Immutable list of members who boost this guild

getMaxMembers

public int getMaxMembers()

Description copied from interface: Guild

The maximum amount of members that can join this guild.

Specified by:

getMaxMembers in interface Guild

Returns:

The maximum amount of members

See Also:

• Guild.retrieveMetaData()

getMaxPresences

public int getMaxPresences()

Description copied from interface: Guild

The maximum amount of connected members this guild can have at a time.
This includes members that are invisible but still connected to discord. If too many members are online the guild will become unavailable for others.

Specified by:

getMaxPresences in interface Guild

Returns:

The maximum amount of connected members this guild can have

See Also:

• Guild.retrieveMetaData()

retrieveMetaData

@Nonnull
public RestAction<Guild.MetaData> retrieveMetaData()

Description copied from interface: Guild

Loads Guild.MetaData for this guild instance.

Specified by:

retrieveMetaData in interface Guild

Returns:

RestAction - Type: Guild.MetaData

getAfkChannel

public VoiceChannel getAfkChannel()

Description copied from interface: Guild

Provides the VoiceChannel that has been set as the channel which Members will be moved to after they have been inactive in a VoiceChannel for longer than Guild.getAfkTimeout().
If no channel has been set as the AFK channel, this returns null.

This value can be modified using GuildManager.setAfkChannel(VoiceChannel).

Specified by:

getAfkChannel in interface Guild

Returns:

Possibly-null VoiceChannel that is the AFK Channel.

getSystemChannel

public TextChannel getSystemChannel()

Description copied from interface: Guild

Provides the TextChannel that has been set as the channel which newly joined Members will be announced in.
If no channel has been set as the system channel, this returns null.

This value can be modified using GuildManager.setSystemChannel(TextChannel).

Specified by:

getSystemChannel in interface Guild

Returns:

Possibly-null TextChannel that is the system Channel.

getRulesChannel

public TextChannel getRulesChannel()

Description copied from interface: Guild

Provides the TextChannel that lists the rules of the guild.
If this guild doesn't have the COMMUNITY feature, this returns null.

Specified by:

getRulesChannel in interface Guild

Returns:

Possibly-null TextChannel that is the rules channel

See Also:

• Guild.getFeatures()

retrieveScheduledEvents

@Nonnull
public RestAction<List<ScheduledEvent>> retrieveScheduledEvents(boolean includeUserCount)

Description copied from interface: Guild

Retrieves all ScheduledEvents for this guild.

Specified by:

retrieveScheduledEvents in interface Guild

Parameters:

includeUserCount - Whether to include user counts for the ScheduledEvents.

Returns:

RestAction - Type: List of ScheduledEvent

retrieveScheduledEventById

@Nonnull
public CacheRestAction<ScheduledEvent> retrieveScheduledEventById(@Nonnull
 String id)

Description copied from interface: Guild

Retrieves a ScheduledEvent by its ID.

Possible ErrorResponses include:

• ErrorResponse.UNKNOWN_SCHEDULED_EVENT
  A scheduled event with the specified ID does not exist in this guild, or the currently logged in user does not have access to it.

Specified by:

retrieveScheduledEventById in interface Guild

Parameters:

id - The ID of the ScheduledEvent

Returns:

RestAction - Type: ScheduledEvent

See Also:

• Guild.getScheduledEventById(long)

retrieveScheduledEventById

@Nonnull
public CacheRestAction<ScheduledEvent> retrieveScheduledEventById(long id)

Description copied from interface: Guild

Retrieves a ScheduledEvent by its ID.

Possible ErrorResponses include:

• ErrorResponse.UNKNOWN_SCHEDULED_EVENT
  A scheduled event with the specified ID does not exist in the guild, or the currently logged in user does not have access to it.

Specified by:

retrieveScheduledEventById in interface Guild

Parameters:

id - The ID of the ScheduledEvent

Returns:

RestAction - Type: ScheduledEvent

See Also:

• Guild.getScheduledEventById(long)

createScheduledEvent

@Nonnull
public ScheduledEventAction createScheduledEvent(@Nonnull
 String name,
 @Nonnull
 String location,
 @Nonnull
 OffsetDateTime startTime,
 @Nonnull
 OffsetDateTime endTime)

Description copied from interface: Guild

Creates a new ScheduledEvent. Events created with this method will be of Type.EXTERNAL. These events are set to take place at an external location.

Requirements
Events are required to have a name, location and start time. Additionally, an end time must also be specified for events of Type.EXTERNAL. Permission.MANAGE_EVENTS is required on the guild level in order to create this type of event.

Example

 guild.createScheduledEvent("Cactus Beauty Contest", "Mike's Backyard", OffsetDateTime.now().plusHours(1), OffsetDateTime.now().plusHours(3))
     .setDescription("Come and have your cacti judged! _Must be spikey to enter_")
     .queue();
 

Specified by:

createScheduledEvent in interface Guild

Parameters:

name - the name for this scheduled event, 1-100 characters

location - the external location for this scheduled event, 1-100 characters

startTime - the start time for this scheduled event, can't be in the past or after the end time

endTime - the end time for this scheduled event, has to be later than the start time

Returns:

ScheduledEventAction

createScheduledEvent

@Nonnull
public ScheduledEventAction createScheduledEvent(@Nonnull
 String name,
 @Nonnull
 GuildChannel channel,
 @Nonnull
 OffsetDateTime startTime)

Description copied from interface: Guild

Creates a new ScheduledEvent.

Requirements
Events are required to have a name, channel and start time. Depending on the type of channel provided, an event will be of one of two different Types:

1. Type.STAGE_INSTANCE
   These events are set to take place inside of a StageChannel. The following permissions are required in the specified stage channel in order to create an event there:
   • Permission.MANAGE_EVENTS
   • Permission.MANAGE_CHANNEL
   • Permission.VOICE_MUTE_OTHERS
   • Permission.VOICE_MOVE_OTHERS}
2. Type.VOICE
   These events are set to take place inside of a VoiceChannel. The following permissions are required in the specified voice channel in order to create an event there:
   • Permission.MANAGE_EVENTS
   • Permission.VIEW_CHANNEL
   • Permission.VOICE_CONNECT

Example

 guild.createScheduledEvent("Cactus Beauty Contest", guild.getGuildChannelById(channelId), OffsetDateTime.now().plusHours(1))
     .setDescription("Come and have your cacti judged! _Must be spikey to enter_")
     .queue();
 

Specified by:

createScheduledEvent in interface Guild

Parameters:

name - the name for this scheduled event, 1-100 characters

channel - the voice or stage channel where this scheduled event will take place

startTime - the start time for this scheduled event, can't be in the past

Returns:

ScheduledEventAction

getCommunityUpdatesChannel

public TextChannel getCommunityUpdatesChannel()

Description copied from interface: Guild

Provides the TextChannel that receives community updates.
If this guild doesn't have the COMMUNITY feature, this returns null.

Specified by:

getCommunityUpdatesChannel in interface Guild

Returns:

Possibly-null TextChannel that is the community updates channel

See Also:

• Guild.getFeatures()

getSafetyAlertsChannel

@Nullable
public TextChannel getSafetyAlertsChannel()

Description copied from interface: Guild

Provides the TextChannel that receives discord safety alerts.
If this guild doesn't have the COMMUNITY feature, this returns null.

Specified by:

getSafetyAlertsChannel in interface Guild

Returns:

Possibly-null TextChannel that is the saferty alerts channel.

See Also:

• Guild.getFeatures()

retrieveWebhooks

@Nonnull
public RestAction<List<Webhook>> retrieveWebhooks()

Description copied from interface: Guild

Retrieves all Webhooks for this Guild.
Requires MANAGE_WEBHOOKS in this Guild.

To get all webhooks for a specific TextChannel, use IWebhookContainer.retrieveWebhooks()

Specified by:

retrieveWebhooks in interface Guild

Returns:

RestAction - Type: List<Webhook>
A list of all Webhooks in this Guild.

See Also:

• IWebhookContainer.retrieveWebhooks()

getOwner

public Member getOwner()

Description copied from interface: Guild

The Member object for the owner of this Guild.
This is null when the owner is no longer in this guild or not yet loaded (lazy loading). Sometimes owners of guilds delete their account or get banned by Discord.

If lazy-loading is used it is recommended to use Guild.retrieveOwner() instead.

Ownership can be transferred using Guild.transferOwnership(Member).

This only works when the member was added to cache. Lazy loading might load this later.
See MemberCachePolicy

Specified by:

getOwner in interface Guild

Returns:

Possibly-null Member object for the Guild owner.

See Also:

• Guild.getOwnerIdLong()
• Guild.retrieveOwner()

getOwnerIdLong

public long getOwnerIdLong()

Description copied from interface: Guild

The ID for the current owner of this guild.
This is useful for debugging purposes or as a shortcut.

Specified by:

getOwnerIdLong in interface Guild

Returns:

The ID for the current owner

See Also:

• Guild.getOwner()

getAfkTimeout

@Nonnull
public Guild.Timeout getAfkTimeout()

Description copied from interface: Guild

The Timeout set for this Guild representing the amount of time that must pass for a Member to have had no activity in a VoiceChannel to be considered AFK. If Guild.getAfkChannel() is not null (thus an AFK channel has been set) then Member will be automatically moved to the AFK channel after they have been inactive for longer than the returned Timeout.
Default is 300 seconds (5 minutes).

This value can be modified using GuildManager.setAfkTimeout(net.dv8tion.jda.api.entities.Guild.Timeout).

Specified by:

getAfkTimeout in interface Guild

Returns:

The Timeout set for this Guild.

getSecurityIncidentActions

@Nonnull
public SecurityIncidentActions getSecurityIncidentActions()

Description copied from interface: Guild

The current guild security incident actions.
Security incident actions are used to temporarily disable features for the purpose of moderation.

Specified by:

getSecurityIncidentActions in interface Guild

Returns:

SecurityIncidentActions the current actions

getSecurityIncidentDetections

@Nonnull
public SecurityIncidentDetections getSecurityIncidentDetections()

Description copied from interface: Guild

The current security incident detections.
Discord may automatically detect spammers or raiders.

Specified by:

getSecurityIncidentDetections in interface Guild

Returns:

SecurityIncidentDetections the current detections

isMember

public boolean isMember(@Nonnull
 UserSnowflake user)

Description copied from interface: Guild

Used to determine if the provided UserSnowflake is a member of this Guild.

This will only check cached members! If the cache is not loaded (see Guild.isLoaded()), this may return false despite the user being a member. This is false when Guild.getMember(UserSnowflake) returns null.

Specified by:

isMember in interface Guild

Parameters:

user - The user to check

Returns:

True - if this user is present and cached in this guild

getSelfMember

@Nonnull
public Member getSelfMember()

Description copied from interface: Guild

Gets the Member object of the currently logged in account in this guild.
This is basically JDA.getSelfUser() being provided to Guild.getMember(UserSnowflake).

Specified by:

getSelfMember in interface Guild

Returns:

The Member object of the currently logged in account.

getMember

public Member getMember(@Nonnull
 UserSnowflake user)

Description copied from interface: Guild

Gets the Guild specific Member object for the provided UserSnowflake.
If the user is not in this guild or currently uncached, null is returned.

This will only check cached members!

Specified by:

getMember in interface Guild

Parameters:

user - The UserSnowflake for the member to get. This can be a member or user instance or User.fromId(long).

Returns:

Possibly-null Member for the related User.

See Also:

• Guild.retrieveMember(UserSnowflake)

getMemberCache

@Nonnull
public MemberCacheView getMemberCache()

Description copied from interface: Guild

MemberCacheView for all cached Members of this Guild.

This will only provide cached members!
See MemberCachePolicy

Specified by:

getMemberCache in interface Guild

Returns:

MemberCacheView

See Also:

• Guild.loadMembers()

getScheduledEventCache

@Nonnull
public SortedSnowflakeCacheView<ScheduledEvent> getScheduledEventCache()

Description copied from interface: Guild

Sorted SnowflakeCacheView of all cached ScheduledEvents of this Guild.
Scheduled events are sorted by their start time, and events that start at the same time are sorted by their snowflake ID.

This requires CacheFlag.SCHEDULED_EVENTS to be enabled.

Specified by:

getScheduledEventCache in interface Guild

Returns:

SortedSnowflakeCacheView

getCategoryCache

@Nonnull
public SortedSnowflakeCacheView<Category> getCategoryCache()

Description copied from interface: IGuildChannelContainer

Sorted SnowflakeCacheView of Category.
In Guild cache, channels are sorted according to their position and id.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

Specified by:

getCategoryCache in interface Guild

Specified by:

getCategoryCache in interface IGuildChannelContainer<GuildChannel>

Returns:

SortedSnowflakeCacheView

getTextChannelCache

@Nonnull
public SortedSnowflakeCacheView<TextChannel> getTextChannelCache()

Description copied from interface: IGuildChannelContainer

Sorted SnowflakeCacheView of TextChannel.
In Guild cache, channels are sorted according to their position and id.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

Specified by:

getTextChannelCache in interface Guild

Specified by:

getTextChannelCache in interface IGuildChannelContainer<GuildChannel>

Returns:

SortedSnowflakeCacheView

getNewsChannelCache

@Nonnull
public SortedSnowflakeCacheView<NewsChannel> getNewsChannelCache()

Description copied from interface: IGuildChannelContainer

Sorted SnowflakeCacheView of NewsChannel.
In Guild cache, channels are sorted according to their position and id.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

Specified by:

getNewsChannelCache in interface Guild

Specified by:

getNewsChannelCache in interface IGuildChannelContainer<GuildChannel>

Returns:

SortedSnowflakeCacheView

getVoiceChannelCache

@Nonnull
public SortedSnowflakeCacheView<VoiceChannel> getVoiceChannelCache()

Description copied from interface: IGuildChannelContainer

Sorted SnowflakeCacheView of VoiceChannel.
In Guild cache, channels are sorted according to their position and id.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

Specified by:

getVoiceChannelCache in interface Guild

Specified by:

getVoiceChannelCache in interface IGuildChannelContainer<GuildChannel>

Returns:

SortedSnowflakeCacheView

getForumChannelCache

@Nonnull
public SortedSnowflakeCacheView<ForumChannel> getForumChannelCache()

Description copied from interface: IGuildChannelContainer

SnowflakeCacheView of ForumChannel.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

Specified by:

getForumChannelCache in interface Guild

Specified by:

getForumChannelCache in interface IGuildChannelContainer<GuildChannel>

Returns:

SnowflakeCacheView

getMediaChannelCache

@Nonnull
public SnowflakeCacheView<MediaChannel> getMediaChannelCache()

Description copied from interface: IGuildChannelContainer

SnowflakeCacheView of MediaChannel.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

Specified by:

getMediaChannelCache in interface IGuildChannelContainer<GuildChannel>

Returns:

SnowflakeCacheView

getStageChannelCache

@Nonnull
public SortedSnowflakeCacheView<StageChannel> getStageChannelCache()

Description copied from interface: IGuildChannelContainer

Sorted SnowflakeCacheView of StageChannel.
In Guild cache, channels are sorted according to their position and id.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

Specified by:

getStageChannelCache in interface Guild

Specified by:

getStageChannelCache in interface IGuildChannelContainer<GuildChannel>

Returns:

SortedSnowflakeCacheView

getThreadChannelCache

@Nonnull
public SortedSnowflakeCacheView<ThreadChannel> getThreadChannelCache()

Description copied from interface: IGuildChannelContainer

SnowflakeCacheView of ThreadChannel.

These threads can also represent posts in ForumChannels.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

Specified by:

getThreadChannelCache in interface Guild

Specified by:

getThreadChannelCache in interface IGuildChannelContainer<GuildChannel>

Returns:

SnowflakeCacheView

getChannelCache

@Nonnull
public SortedChannelCacheViewImpl<GuildChannel> getChannelCache()

Description copied from interface: Guild

SortedChannelCacheView of GuildChannel.

Provides cache access to all channels of this guild, including thread channels (unlike Guild.getChannels()). The cache view attempts to provide a sorted list, based on how channels are displayed in the client. Various methods like CacheView.forEachUnordered(Consumer) or CacheView.lockedIterator() bypass sorting for optimization reasons.

It is possible to filter the channels to more specific types using ChannelCacheView.getElementById(ChannelType, long) or SortedChannelCacheView.ofType(Class).

Specified by:

getChannelCache in interface Guild

Specified by:

getChannelCache in interface IGuildChannelContainer<GuildChannel>

Returns:

SortedChannelCacheView

getGuildChannelById

@Nullable
public GuildChannel getGuildChannelById(long id)

Description copied from interface: IGuildChannelContainer

Get GuildChannel for the provided ID.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().

To get more specific channel types you can use one of the following:

• IGuildChannelContainer.getChannelById(Class, long)
• IGuildChannelContainer.getTextChannelById(long)
• IGuildChannelContainer.getNewsChannelById(long)
• IGuildChannelContainer.getStageChannelById(long)
• IGuildChannelContainer.getVoiceChannelById(long)
• IGuildChannelContainer.getCategoryById(long)
• IGuildChannelContainer.getForumChannelById(long)

Specified by:

getGuildChannelById in interface IGuildChannelContainer<GuildChannel>

Parameters:

id - The ID of the channel

Returns:

The GuildChannel or null

getGuildChannelById

public GuildChannel getGuildChannelById(@Nonnull
 ChannelType type,
 long id)

Description copied from interface: IGuildChannelContainer

Get GuildChannel for the provided ID.

This getter exists on any instance of IGuildChannelContainer and only checks the caches with the relevant scoping. For Guild, JDA, or ShardManager, this returns the relevant channel with respect to the cache within each of those objects. For a guild, this would mean it only returns channels within the same guild.
If this is called on JDA or ShardManager, this may return null immediately after building, because the cache isn't initialized yet. To make sure the cache is initialized after building your JDA instance, you can use JDA.awaitReady().
This is meant for systems that use a dynamic ChannelType and can profit from a simple function to get the channel instance.

To get more specific channel types you can use one of the following:

• IGuildChannelContainer.getChannelById(Class, long)
• IGuildChannelContainer.getTextChannelById(long)
• IGuildChannelContainer.getNewsChannelById(long)
• IGuildChannelContainer.getStageChannelById(long)
• IGuildChannelContainer.getVoiceChannelById(long)
• IGuildChannelContainer.getCategoryById(long)
• IGuildChannelContainer.getForumChannelById(long)

Specified by:

getGuildChannelById in interface IGuildChannelContainer<GuildChannel>

Parameters:

type - The ChannelType

id - The ID of the channel

Returns:

The GuildChannel or null

getRoleCache

@Nonnull
public SortedSnowflakeCacheView<Role> getRoleCache()

Description copied from interface: Guild

Sorted SnowflakeCacheView of all cached Roles of this Guild.
Roles are sorted according to their position.

Specified by:

getRoleCache in interface Guild

Returns:

SortedSnowflakeCacheView

getEmojiCache

@Nonnull
public SnowflakeCacheView<RichCustomEmoji> getEmojiCache()

Description copied from interface: Guild

SnowflakeCacheView of all cached Custom Emojis of this Guild.
This will be empty if CacheFlag.EMOJI is disabled.

This requires the CacheFlag.EMOJI to be enabled!

Specified by:

getEmojiCache in interface Guild

Returns:

SnowflakeCacheView

See Also:

• Guild.retrieveEmojis()

getStickerCache

@Nonnull
public SnowflakeCacheView<GuildSticker> getStickerCache()

Description copied from interface: Guild

SnowflakeCacheView of all cached GuildStickers of this Guild.
This will be empty if CacheFlag.STICKER is disabled.

This requires the CacheFlag.STICKER to be enabled!

Specified by:

getStickerCache in interface Guild

Returns:

SnowflakeCacheView

See Also:

• Guild.retrieveStickers()

getChannels

@Nonnull
public List<GuildChannel> getChannels(boolean includeHidden)

Description copied from interface: Guild

Populated list of channels for this guild.
This includes all types of channels, except for threads.

The returned list is ordered in the same fashion as it would be by the official discord client.

1. TextChannel, ForumChannel, and NewsChannel without parent
2. VoiceChannel and StageChannel without parent
3. Categories
   1. TextChannel, ForumChannel, and NewsChannel with category as parent
   2. VoiceChannel and StageChannel with category as parent

Specified by:

getChannels in interface Guild

Parameters:

includeHidden - Whether to include channels with denied View Channel Permission

Returns:

Immutable list of channels for this guild

See Also:

• Guild.getChannels()

retrieveEmojis

@Nonnull
public RestAction<List<RichCustomEmoji>> retrieveEmojis()

Description copied from interface: Guild

Retrieves an immutable list of Custom Emojis together with their respective creators.

Note that RichCustomEmoji.getOwner() is only available if the currently logged in account has Permission.MANAGE_GUILD_EXPRESSIONS.

Specified by:

retrieveEmojis in interface Guild

Returns:

RestAction - Type: List of RichCustomEmoji

retrieveEmojiById

@Nonnull
public RestAction<RichCustomEmoji> retrieveEmojiById(@Nonnull
 String id)

Description copied from interface: Guild

Retrieves a custom emoji together with its respective creator.
This does not include unicode emoji.

Note that RichCustomEmoji.getOwner() is only available if the currently logged in account has Permission.MANAGE_GUILD_EXPRESSIONS.

Possible ErrorResponses caused by the returned RestAction include the following:

• UNKNOWN_EMOJI
  If the provided id does not correspond to an emoji in this guild

Specified by:

retrieveEmojiById in interface Guild

Parameters:

id - The emoji id

Returns:

RestAction - Type: RichCustomEmoji

retrieveStickers

@Nonnull
public RestAction<List<GuildSticker>> retrieveStickers()

Description copied from interface: Guild

Retrieves all the stickers from this guild.
This also includes unavailable stickers.

Specified by:

retrieveStickers in interface Guild

Returns:

RestAction - Type: List of GuildSticker

retrieveSticker

@Nonnull
public RestAction<GuildSticker> retrieveSticker(@Nonnull
 StickerSnowflake sticker)

Description copied from interface: Guild

Attempts to retrieve a GuildSticker object for this guild based on the provided snowflake reference.

The returned RestAction can encounter the following Discord errors:

• UNKNOWN_STICKER
  Occurs when the provided id does not refer to a sticker known by Discord.

Specified by:

retrieveSticker in interface Guild

Parameters:

sticker - The reference of the requested Sticker.
Can be RichSticker, StickerItem, or Sticker.fromId(long).

Returns:

RestAction - Type: GuildSticker
On request, gets the sticker with id matching provided id from Discord.

editSticker

@Nonnull
public GuildStickerManager editSticker(@Nonnull
 StickerSnowflake sticker)

Description copied from interface: Guild

Modify a sticker using GuildStickerManager.
You can update multiple fields at once, by calling the respective setters before executing the request.

The returned RestAction can encounter the following Discord errors:

• UNKNOWN_STICKER
  Occurs when the provided id does not refer to a sticker known by Discord.

Specified by:

editSticker in interface Guild

Returns:

GuildStickerManager

retrieveBanList

@Nonnull
public BanPaginationActionImpl retrieveBanList()

Description copied from interface: Guild

Retrieves an immutable list of the currently banned Users.
If you wish to ban or unban a user, use either Guild.ban(UserSnowflake, int, TimeUnit) or Guild.unban(UserSnowflake).

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The ban list cannot be fetched due to a permission discrepancy

Specified by:

retrieveBanList in interface Guild

Returns:

The BanPaginationAction of the guild's bans.

retrieveBan

@Nonnull
public RestAction<Guild.Ban> retrieveBan(@Nonnull
 UserSnowflake user)

Description copied from interface: Guild

Retrieves a Ban of the provided UserSnowflake.
If you wish to ban or unban a user, use either Guild.ban(UserSnowflake, int, TimeUnit) or Guild.unban(UserSnowflake).

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The ban list cannot be fetched due to a permission discrepancy
• UNKNOWN_BAN
  Either the ban was removed before finishing the task or it did not exist in the first place

Specified by:

retrieveBan in interface Guild

Parameters:

user - The UserSnowflake for the banned user. This can be a user instance or User.fromId(long).

Returns:

RestAction - Type: Ban
An unmodifiable ban object for the user banned from this guild

retrievePrunableMemberCount

@Nonnull
public RestAction<Integer> retrievePrunableMemberCount(int days)

Description copied from interface: Guild

The method calculates the amount of Members that would be pruned if Guild.prune(int, Role...) was executed. Prunability is determined by a Member being offline for at least days days.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The prune count cannot be fetched due to a permission discrepancy

Specified by:

retrievePrunableMemberCount in interface Guild

Parameters:

days - Minimum number of days since a member has been offline to get affected.

Returns:

RestAction - Type: Integer
The amount of Members that would be affected.

getPublicRole

@Nonnull
public Role getPublicRole()

Description copied from interface: Guild

The @everyone Role of this Guild.
This role is special because its position is calculated as -1. All other role positions are 0 or greater. This implies that the public role is always below any custom roles created in this Guild. Additionally, all members of this guild are implied to have this role so it is not included in the list returned by Member.getRoles().
The ID of this Role is the Guild's ID thus it is equivalent to using getRoleById(getIdLong()).

Specified by:

getPublicRole in interface Guild

Returns:

The @everyone Role

getDefaultChannel

@Nullable
public DefaultGuildChannelUnion getDefaultChannel()

Description copied from interface: Guild

The default StandardGuildChannel for a Guild.
This is the channel that the Discord client will default to opening when a Guild is opened for the first time when accepting an invite that is not directed at a specific channel.

Note: This channel is the first channel in the guild (ordered by position) that the Guild.getPublicRole() has the Permission.VIEW_CHANNEL in.

Specified by:

getDefaultChannel in interface Guild

Returns:

The channel representing the default channel for this guild

getManager

@Nonnull
public GuildManager getManager()

Description copied from interface: Guild

Returns the GuildManager for this Guild, used to modify all properties and settings of the Guild.
You modify multiple fields in one request by chaining setters before calling RestAction.queue().

Specified by:

getManager in interface Guild

Returns:

The Manager of this Guild

isBoostProgressBarEnabled

public boolean isBoostProgressBarEnabled()

Description copied from interface: Guild

Returns whether this Guild has its boost progress bar shown.

Specified by:

isBoostProgressBarEnabled in interface Guild

Returns:

True, if this Guild has its boost progress bar shown

retrieveAuditLogs

@Nonnull
public AuditLogPaginationAction retrieveAuditLogs()

Description copied from interface: Guild

A PaginationAction implementation that allows to iterate over all AuditLogEntries of this Guild.
This iterates from the most recent action to the first logged one. (Limit 90 days into history by discord api)

Examples

 public void logBan(GuildBanEvent event) {
     Guild guild = event.getGuild();
     List<TextChannel> modLog = guild.getTextChannelsByName("mod-log", true);
     guild.retrieveAuditLogs()
          .type(ActionType.BAN) // filter by type
          .limit(1)
          .queue(list -> {
             if (list.isEmpty()) return;
             AuditLogEntry entry = list.get(0);
             String message = String.format("%#s banned %#s with reason %s",
                                            entry.getUser(), event.getUser(), entry.getReason());
             modLog.forEach(channel ->
               channel.sendMessage(message).queue()
             );
          });
 }
 

Specified by:

retrieveAuditLogs in interface Guild

Returns:

AuditLogPaginationAction

leave

@Nonnull
public RestAction<Void> leave()

Description copied from interface: Guild

Used to leave a Guild. If the currently logged in account is the owner of this guild (Guild.getOwner()) then ownership of the Guild needs to be transferred to a different Member before leaving using Guild.transferOwnership(Member).

Specified by:

leave in interface Guild

Returns:

RestAction - Type: Void

delete

@Nonnull
public RestAction<Void> delete()

Description copied from interface: Guild

Used to completely delete a Guild. This can only be done if the currently logged in account is the owner of the Guild.
If the account has MFA enabled, use Guild.delete(String) instead to provide the MFA code.

Specified by:

delete in interface Guild

Returns:

RestAction - Type: Void

delete

@Nonnull
public RestAction<Void> delete(String mfaCode)

Description copied from interface: Guild

Used to completely delete a guild. This can only be done if the currently logged in account is the owner of the Guild.
This method is specifically used for when MFA is enabled on the logged in account SelfUser.isMfaEnabled(). If MFA is not enabled, use Guild.delete().

Specified by:

delete in interface Guild

Parameters:

mfaCode - The Multifactor Authentication code generated by an app like Google Authenticator.
This is not the MFA token given to you by Discord. The code is typically 6 characters long.

Returns:

RestAction - Type: Void

getAudioManager

@Nonnull
public AudioManager getAudioManager()

Description copied from interface: Guild

The AudioManager that represents the audio connection for this Guild.
If no AudioManager exists for this Guild, this will create a new one.
This operation is synchronized on all audio managers for this JDA instance, this means that calling getAudioManager() on any other guild while a thread is accessing this method may be locked.

Specified by:

getAudioManager in interface Guild

Returns:

The AudioManager for this Guild.

See Also:

• JDA.getAudioManagerCache()

requestToSpeak

@Nonnull
public Task<Void> requestToSpeak()

Description copied from interface: Guild

Once the currently logged in account is connected to a StageChannel, this will trigger a Request-to-Speak (aka raise your hand).

This will set an internal flag to automatically request to speak once the bot joins a stage channel.
You can use Guild.cancelRequestToSpeak() to move back to the audience or cancel your pending request.

If the self member has Permission.VOICE_MUTE_OTHERS this will immediately promote them to speaker.

Example:

 stageChannel.createStageInstance("Talent Show").queue()
 guild.requestToSpeak(); // Set request to speak flag
 guild.getAudioManager().openAudioConnection(stageChannel); // join the channel
 

Specified by:

requestToSpeak in interface Guild

Returns:

Task representing the request to speak. Calling Task.get() can result in deadlocks and should be avoided at all times.

See Also:

• Guild.cancelRequestToSpeak()

cancelRequestToSpeak

@Nonnull
public Task<Void> cancelRequestToSpeak()

Description copied from interface: Guild

Cancels the Request-to-Speak.
This can also be used to move back to the audience if you are currently a speaker.

If there is no request to speak or the member is not currently connected to a StageChannel, this does nothing.

Specified by:

cancelRequestToSpeak in interface Guild

Returns:

Task representing the request to speak cancellation. Calling Task.get() can result in deadlocks and should be avoided at all times.

See Also:

• Guild.requestToSpeak()

getJDA

@Nonnull
public JDAImpl getJDA()

Description copied from interface: Guild

Returns the JDA instance of this Guild

Specified by:

getJDA in interface Guild

Returns:

the corresponding JDA instance

getVoiceStates

@Nonnull
public List<GuildVoiceState> getVoiceStates()

Description copied from interface: Guild

A list containing the cached GuildVoiceState of every Member connected to an audio channel in this guild.

This requires CacheFlag.VOICE_STATE to be enabled.

Specified by:

getVoiceStates in interface Guild

Returns:

Immutable list containing all cached GuildVoiceStates for this guild.

retrieveMemberVoiceStateById

@Nonnull
@CheckReturnValue
public CacheRestAction<GuildVoiceState> retrieveMemberVoiceStateById(long id)

Description copied from interface: Guild

Load the member's voice state for the specified user.

Possible ErrorResponseExceptions include:

• ErrorResponse.UNKNOWN_VOICE_STATE
  The specified user does not exist, is not a member of this guild or is not connected to a voice channel

Specified by:

retrieveMemberVoiceStateById in interface Guild

Parameters:

id - The user id to load the voice state from

Returns:

RestAction - Type: GuildVoiceState

getVerificationLevel

@Nonnull
public Guild.VerificationLevel getVerificationLevel()

Description copied from interface: Guild

Returns the verification-Level of this Guild. Verification level is one of the factors that determines if a Member can send messages in a Guild.
For a short description of the different values, see Guild.VerificationLevel.

This value can be modified using GuildManager.setVerificationLevel(net.dv8tion.jda.api.entities.Guild.VerificationLevel).

Specified by:

getVerificationLevel in interface Guild

Returns:

The Verification-Level of this Guild.

getDefaultNotificationLevel

@Nonnull
public Guild.NotificationLevel getDefaultNotificationLevel()

Description copied from interface: Guild

Returns the default message Notification-Level of this Guild. Notification level determines when Members get notification for messages. The value returned is the default level set for any new Members that join the Guild.
For a short description of the different values, see NotificationLevel.

This value can be modified using GuildManager.setDefaultNotificationLevel(net.dv8tion.jda.api.entities.Guild.NotificationLevel).

Specified by:

getDefaultNotificationLevel in interface Guild

Returns:

The default message Notification-Level of this Guild.

getRequiredMFALevel

@Nonnull
public Guild.MFALevel getRequiredMFALevel()

Description copied from interface: Guild

Returns the level of multifactor authentication required to execute administrator restricted functions in this guild.
For a short description of the different values, see MFALevel.

This value can be modified using GuildManager.setRequiredMFALevel(net.dv8tion.jda.api.entities.Guild.MFALevel).

Specified by:

getRequiredMFALevel in interface Guild

Returns:

The MFA-Level required by this Guild.

getExplicitContentLevel

@Nonnull
public Guild.ExplicitContentLevel getExplicitContentLevel()

Description copied from interface: Guild

The level of content filtering enabled in this Guild.
This decides which messages sent by which Members will be scanned for explicit content.

Specified by:

getExplicitContentLevel in interface Guild

Returns:

ExplicitContentLevel for this Guild

loadMembers

@Nonnull
public Task<Void> loadMembers(@Nonnull
 Consumer<Member> callback)

Description copied from interface: Guild

Retrieves all members of this guild.
This will use the configured MemberCachePolicy to decide which members to retain in cache.

This requires the privileged GatewayIntent.GUILD_MEMBERS to be enabled!

You MUST NOT use blocking operations such as Task.get()! The response handling happens on the event thread by default.

Specified by:

loadMembers in interface Guild

Parameters:

callback - Consumer callback for each member

Returns:

Task cancellable handle for this request

retrieveMemberById

@Nonnull
public CacheRestAction<Member> retrieveMemberById(long id)

Description copied from interface: Guild

Load the member for the specified user.
If the member is already loaded it will be retrieved from Guild.getMemberById(long) and immediately provided if the member information is consistent. The cache consistency directly relies on the enabled GatewayIntents as GatewayIntent.GUILD_MEMBERS is required to keep the cache updated with the latest information. You can use useCache(false) to always make a new request, which is the default behavior if the required intents are disabled.

Possible ErrorResponseExceptions include:

• ErrorResponse.UNKNOWN_MEMBER
  The specified user is not a member of this guild
• ErrorResponse.UNKNOWN_USER
  The specified user does not exist

Specified by:

retrieveMemberById in interface Guild

Parameters:

id - The user id to load the member from

Returns:

RestAction - Type: Member

See Also:

• Guild.pruneMemberCache()
• Guild.unloadMember(long)

retrieveMembersByIds

@Nonnull
public Task<List<Member>> retrieveMembersByIds(boolean includePresence,
 @Nonnull
 long... ids)

Description copied from interface: Guild

Retrieves a list of members by their user id.
If the id does not resolve to a member of this guild, then it will not appear in the resulting list. It is possible that none of the IDs resolve to a member, in which case an empty list will be the result.

You can only load presences with the GUILD_PRESENCES intent enabled.

The requests automatically timeout after 10 seconds. When the timeout occurs a TimeoutException will be used to complete exceptionally.

You MUST NOT use blocking operations such as Task.get()! The response handling happens on the event thread by default.

Specified by:

retrieveMembersByIds in interface Guild

Parameters:

includePresence - Whether to load presences of the members (online status/activity)

ids - The ids of the members (max 100)

Returns:

Task handle for the request

retrieveMembersByPrefix

@Nonnull
@CheckReturnValue
public Task<List<Member>> retrieveMembersByPrefix(@Nonnull
 String prefix,
 int limit)

Description copied from interface: Guild

Queries a list of members using a radix tree based on the provided name prefix.
This will check both the username and the nickname of the members. Additional filtering may be required. If no members with the specified prefix exist, the list will be empty.

The requests automatically timeout after 10 seconds. When the timeout occurs a TimeoutException will be used to complete exceptionally.

You MUST NOT use blocking operations such as Task.get()! The response handling happens on the event thread by default.

Specified by:

retrieveMembersByPrefix in interface Guild

Parameters:

prefix - The case-insensitive name prefix

limit - The max amount of members to retrieve (1-100)

Returns:

Task handle for the request

See Also:

• Guild.getMembersByName(String, boolean)
• Guild.getMembersByNickname(String, boolean)
• Guild.getMembersByEffectiveName(String, boolean)

retrieveActiveThreads

@Nonnull
public RestAction<List<ThreadChannel>> retrieveActiveThreads()

Description copied from interface: Guild

Retrieves the active threads in this guild.

Specified by:

retrieveActiveThreads in interface Guild

Returns:

RestAction - List of ThreadChannel

getIdLong

public long getIdLong()

Description copied from interface: ISnowflake

The Snowflake id of this entity. This is unique to every entity and will never change.

Specified by:

getIdLong in interface ISnowflake

Returns:

Long containing the Id.

retrieveInvites

@Nonnull
public RestAction<List<Invite>> retrieveInvites()

Description copied from interface: Guild

Retrieves all Invites for this guild.
Requires MANAGE_SERVER in this guild. Will throw an InsufficientPermissionException otherwise.

To get all invites for a GuildChannel use GuildChannel.retrieveInvites()

Specified by:

retrieveInvites in interface Guild

Returns:

RestAction - Type: List<Invite>
The list of expanded Invite objects

See Also:

• IInviteContainer.retrieveInvites()

retrieveTemplates

@Nonnull
public RestAction<List<Template>> retrieveTemplates()

Description copied from interface: Guild

Retrieves all Templates for this guild.
Requires MANAGE_SERVER in this guild. Will throw an InsufficientPermissionException otherwise.

Specified by:

retrieveTemplates in interface Guild

Returns:

RestAction - Type: List<Template>
The list of Template objects

createTemplate

@Nonnull
public RestAction<Template> createTemplate(@Nonnull
 String name,
 @Nullable
 String description)

Description copied from interface: Guild

Used to create a new Template for this Guild.
Requires MANAGE_SERVER in this Guild. Will throw an InsufficientPermissionException otherwise.

Possible ErrorResponses include:

• Guild already has a template
  The guild already has a template.

Specified by:

createTemplate in interface Guild

Parameters:

name - The name of the template

description - The description of the template

Returns:

RestAction - Type: Template
The created Template object

retrieveWelcomeScreen

@Nonnull
public RestAction<GuildWelcomeScreen> retrieveWelcomeScreen()

Description copied from interface: Guild

Retrieves the welcome screen for this Guild.
The welcome screen is shown to all members after joining the Guild.

Possible ErrorResponses include:

• Unknown Guild Welcome Screen
  The guild has no welcome screen
• Missing Permissions
  The guild's welcome screen is disabled and the currently logged in account doesn't have the MANAGE_SERVER permission

Specified by:

retrieveWelcomeScreen in interface Guild

Returns:

RestAction - Type: GuildWelcomeScreen
The welcome screen for this Guild.

moveVoiceMember

@Nonnull
public RestAction<Void> moveVoiceMember(@Nonnull
 UserSnowflake user,
 @Nullable
 AudioChannel audioChannel)

Description copied from interface: Guild

Used to move a Member from one AudioChannel to another AudioChannel.
As a note, you cannot move a Member that isn't already in a AudioChannel. Also they must be in a AudioChannel in the same Guild as the one that you are moving them to.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be moved due to a permission discrepancy
• MISSING_ACCESS
  The VIEW_CHANNEL permission was removed
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task
• UNKNOWN_CHANNEL
  The specified channel was deleted before finishing the task

Specified by:

moveVoiceMember in interface Guild

Parameters:

user - The member that you are moving.

audioChannel - The destination AudioChannel to which the member is being moved to. Or null to perform a voice kick.

Returns:

RestAction

modifyNickname

@Nonnull
public AuditableRestAction<Void> modifyNickname(@Nonnull
 Member member,
 String nickname)

Description copied from interface: Guild

Changes the Member's nickname in this guild. The nickname is visible to all members of this guild.

To change the nickname for the currently logged in account only the Permission NICKNAME_CHANGE is required.
To change the nickname of any Member for this Guild the Permission NICKNAME_MANAGE is required.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The nickname of the target Member is not modifiable due to a permission discrepancy
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Specified by:

modifyNickname in interface Guild

Parameters:

member - The Member for which the nickname should be changed.

nickname - The new nickname of the Member, provide null or an empty String to reset the nickname

Returns:

AuditableRestAction

prune

@Nonnull
public AuditableRestAction<Integer> prune(int days,
 boolean wait,
 @Nonnull
 Role... roles)

Description copied from interface: Guild

This method will prune (kick) all members who were offline for at least days days.
The RestAction returned from this method will return the amount of Members that were pruned.
You can use Guild.retrievePrunableMemberCount(int) to determine how many Members would be pruned if you were to call this method.

This might timeout when pruning many members with wait=true.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The prune cannot finished due to a permission discrepancy

Specified by:

prune in interface Guild

Parameters:

days - Minimum number of days since a member has been offline to get affected.

wait - Whether to calculate the number of pruned members and wait for the response (timeout for too many pruned)

roles - Optional roles to include in prune filter

Returns:

AuditableRestAction - Type: Integer
Provides the amount of Members that were pruned from the Guild, if wait is true.

modifySecurityIncidents

@Nonnull
public AuditableRestAction<Void> modifySecurityIncidents(@Nonnull
 SecurityIncidentActions incidents)

Description copied from interface: Guild

Update the current guild security incident actions.
Security incident actions are used to temporarily disable features for the purpose of moderation.

Possible ErrorResponses caused by the returned RestAction include the following:

• ErrorResponse.INVALID_FORM_BODY
  If one of the provided timestamps is too far into the future

Specified by:

modifySecurityIncidents in interface Guild

Parameters:

incidents - The new security incidents

Returns:

AuditableRestAction

See Also:

• SecurityIncidentActions.enabled(OffsetDateTime, OffsetDateTime)
• SecurityIncidentActions.disabled()

kick

@Nonnull
public AuditableRestAction<Void> kick(@Nonnull
 UserSnowflake user)

Description copied from interface: Guild

Kicks a Member from the Guild.

Note: Guild.getMembers() will still contain the User until Discord sends the GuildMemberRemoveEvent.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be kicked due to a permission discrepancy
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Specified by:

kick in interface Guild

Parameters:

user - The UserSnowflake for the user to kick. This can be a member or user instance or User.fromId(long).

Returns:

AuditableRestAction Kicks the provided Member from the current Guild

ban

@Nonnull
public AuditableRestAction<Void> ban(@Nonnull
 UserSnowflake user,
 int duration,
 @Nonnull
 TimeUnit unit)

Description copied from interface: Guild

Bans the user specified by the provided UserSnowflake and deletes messages sent by the user based on the deletionTimeframe.
If you wish to ban a user without deleting any messages, provide deletionTimeframe with a value of 0. To set a ban reason, use AuditableRestAction.reason(String).

You can unban a user with Guild.unban(UserReference).

Note: Guild.getMembers() will still contain the User's Member object (if the User was in the Guild) until Discord sends the GuildMemberRemoveEvent.

Examples
Banning a user without deleting any messages:

 guild.ban(user, 0, TimeUnit.SECONDS)
      .reason("Banned for rude behavior")
      .queue();
 

Banning a user and deleting messages from the past hour:

 guild.ban(user, 1, TimeUnit.HOURS)
      .reason("Banned for spamming")
      .queue();
 

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be banned due to a permission discrepancy
• UNKNOWN_USER
  The user does not exist

Specified by:

ban in interface Guild

Parameters:

user - The UserSnowflake for the user to ban. This can be a member or user instance or User.fromId(long).

duration - The timeframe for the history of messages that will be deleted. (seconds precision)

unit - Timeframe unit as a TimeUnit (for example ban(user, 7, TimeUnit.DAYS)).

Returns:

AuditableRestAction

See Also:

• AuditableRestAction.reason(String)

ban

@Nonnull
public AuditableRestAction<BulkBanResponse> ban(@Nonnull
 Collection<? extends UserSnowflake> users,
 @Nullable
 Duration deletionTime)

Description copied from interface: Guild

Bans up to 200 of the provided users.
To set a ban reason, use AuditableRestAction.reason(String).

The BulkBanResponse includes a list of failed users, which is populated with users that could not be banned, for instance due to some internal server error or permission issues. This list of failed users also includes all users that were already banned.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be banned due to a permission discrepancy
• FAILED_TO_BAN_USERS
  None of the users could be banned

Specified by:

ban in interface Guild

Parameters:

users - The users to ban

deletionTime - Delete recent messages of the given timeframe (for instance the last hour with Duration.ofHours(1))

Returns:

AuditableRestAction - Type: BulkBanResponse

unban

@Nonnull
public AuditableRestAction<Void> unban(@Nonnull
 UserSnowflake user)

Description copied from interface: Guild

Unbans the specified UserSnowflake from this Guild.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be unbanned due to a permission discrepancy
• UNKNOWN_BAN
  The specified User is not banned from the current Guild
• UNKNOWN_USER
  The specified User does not exist

Specified by:

unban in interface Guild

Parameters:

user - The UserSnowflake to unban. This can be a member or user instance or User.fromId(long).

Returns:

AuditableRestAction

timeoutUntil

@Nonnull
public AuditableRestAction<Void> timeoutUntil(@Nonnull
 UserSnowflake user,
 @Nonnull
 TemporalAccessor temporal)

Description copied from interface: Guild

Puts the specified Member in time out in this Guild until the specified date.
While a Member is in time out, all permissions except VIEW_CHANNEL and MESSAGE_HISTORY are removed from them.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be put into time out due to a permission discrepancy
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Specified by:

timeoutUntil in interface Guild

Parameters:

user - The UserSnowflake to timeout. This can be a member or user instance or User.fromId(long).

temporal - The time the specified Member will be released from time out

Returns:

AuditableRestAction

removeTimeout

@Nonnull
public AuditableRestAction<Void> removeTimeout(@Nonnull
 UserSnowflake user)

Description copied from interface: Guild

Removes a time out from the specified Member in this Guild.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The time out cannot be removed due to a permission discrepancy
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Specified by:

removeTimeout in interface Guild

Parameters:

user - The UserSnowflake to timeout. This can be a member or user instance or User.fromId(long).

Returns:

AuditableRestAction

deafen

@Nonnull
public AuditableRestAction<Void> deafen(@Nonnull
 UserSnowflake user,
 boolean deafen)

Description copied from interface: Guild

Sets the Guild Deafened state of the Member based on the provided boolean.

Note: The Member's GuildVoiceState.isGuildDeafened() value won't change until JDA receives the GuildVoiceGuildDeafenEvent event related to this change.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be deafened due to a permission discrepancy
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task
• USER_NOT_CONNECTED
  The specified Member is not connected to a voice channel

Specified by:

deafen in interface Guild

Parameters:

user - The UserSnowflake who's GuildVoiceState to change. This can be a member or user instance or User.fromId(long).

deafen - Whether this Member should be deafened or undeafened.

Returns:

AuditableRestAction

mute

@Nonnull
public AuditableRestAction<Void> mute(@Nonnull
 UserSnowflake user,
 boolean mute)

Description copied from interface: Guild

Sets the Guild Muted state of the Member based on the provided boolean.

Note: The Member's GuildVoiceState.isGuildMuted() value won't change until JDA receives the GuildVoiceGuildMuteEvent event related to this change.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be muted due to a permission discrepancy
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task
• USER_NOT_CONNECTED
  The specified Member is not connected to a voice channel

Specified by:

mute in interface Guild

Parameters:

user - The UserSnowflake who's GuildVoiceState to change. This can be a member or user instance or User.fromId(long).

mute - Whether this Member should be muted or unmuted.

Returns:

AuditableRestAction

addRoleToMember

@Nonnull
public AuditableRestAction<Void> addRoleToMember(@Nonnull
 UserSnowflake user,
 @Nonnull
 Role role)

Description copied from interface: Guild

Atomically assigns the provided Role to the specified Member.
This can be used together with other role modification methods as it does not require an updated cache!

If multiple roles should be added/removed (efficiently) in one request you may use modifyMemberRoles(Member, Collection, Collection) or similar methods.

If the specified role is already present in the member's set of roles this does nothing.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The Members Roles could not be modified due to a permission discrepancy
• UNKNOWN_MEMBER
  The target Member was removed from the Guild before finishing the task
• UNKNOWN_ROLE
  If the specified Role does not exist

Specified by:

addRoleToMember in interface Guild

Parameters:

user - The UserSnowflake to change roles for. This can be a member or user instance or User.fromId(long).

role - The role which should be assigned atomically

Returns:

AuditableRestAction

removeRoleFromMember

@Nonnull
public AuditableRestAction<Void> removeRoleFromMember(@Nonnull
 UserSnowflake user,
 @Nonnull
 Role role)

Description copied from interface: Guild

Atomically removes the provided Role from the specified Member.
This can be used together with other role modification methods as it does not require an updated cache!

If multiple roles should be added/removed (efficiently) in one request you may use modifyMemberRoles(Member, Collection, Collection) or similar methods.

If the specified role is not present in the member's set of roles this does nothing.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The Members Roles could not be modified due to a permission discrepancy
• UNKNOWN_MEMBER
  The target Member was removed from the Guild before finishing the task
• UNKNOWN_ROLE
  If the specified Role does not exist

Specified by:

removeRoleFromMember in interface Guild

Parameters:

user - The UserSnowflake to change roles for. This can be a member or user instance or User.fromId(long).

role - The role which should be removed atomically

Returns:

AuditableRestAction

modifyMemberRoles

@Nonnull
public AuditableRestAction<Void> modifyMemberRoles(@Nonnull
 Member member,
 Collection<Role> rolesToAdd,
 Collection<Role> rolesToRemove)

Description copied from interface: Guild

Modifies the Roles of the specified Member by adding and removing a collection of roles.
None of the provided roles may be the Public Role of the current Guild.
If a role is both in rolesToAdd and rolesToRemove it will be removed.

Example

 public static void promote(Member member) {
     Guild guild = member.getGuild();
     List<Role> pleb = guild.getRolesByName("Pleb", true); // remove all roles named "pleb"
     List<Role> knight = guild.getRolesByName("Knight", true); // add all roles named "knight"
     // update roles in single request
     guild.modifyMemberRoles(member, knight, pleb).queue();
 }
 

Warning
This may not be used together with any other role add/remove/modify methods for the same Member within one event listener cycle! The changes made by this require cache updates which are triggered by lifecycle events which are received later. This may only be called again once the specific Member has been updated by a GenericGuildMemberEvent targeting the same Member.

This is logically equivalent to:

 Set<Role> roles = new HashSet<>(member.getRoles());
 roles.addAll(rolesToAdd);
 roles.removeAll(rolesToRemove);
 RestAction<Void> action = guild.modifyMemberRoles(member, roles);
 

You can use Guild.addRoleToMember(UserSnowflake, Role) and Guild.removeRoleFromMember(UserSnowflake, Role) to make updates independent of the cache.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The Members Roles could not be modified due to a permission discrepancy
• UNKNOWN_MEMBER
  The target Member was removed from the Guild before finishing the task

Specified by:

modifyMemberRoles in interface Guild

Parameters:

member - The Member that should be modified

rolesToAdd - A Collection of Roles to add to the current Roles the specified Member already has, or null

rolesToRemove - A Collection of Roles to remove from the current Roles the specified Member already has, or null

Returns:

AuditableRestAction

modifyMemberRoles

@Nonnull
public AuditableRestAction<Void> modifyMemberRoles(@Nonnull
 Member member,
 @Nonnull
 Collection<Role> roles)

Description copied from interface: Guild

Modifies the complete Role set of the specified Member
The provided roles will replace all current Roles of the specified Member.

The new roles must not contain the Public Role of the Guild

Warning
This may not be used together with any other role add/remove/modify methods for the same Member within one event listener cycle! The changes made by this require cache updates which are triggered by lifecycle events which are received later. This may only be called again once the specific Member has been updated by a GenericGuildMemberEvent targeting the same Member.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The Members Roles could not be modified due to a permission discrepancy
• UNKNOWN_MEMBER
  The target Member was removed from the Guild before finishing the task

Example

 public static void makeModerator(Member member) {
     Guild guild = member.getGuild();
     List<Role> roles = new ArrayList<>(member.getRoles()); // modifiable copy
     List<Role> modRoles = guild.getRolesByName("moderator", true); // get roles with name "moderator"
     roles.addAll(modRoles); // add new roles
     // update the member with new roles
     guild.modifyMemberRoles(member, roles).queue();
 }
 

Specified by:

modifyMemberRoles in interface Guild

Parameters:

member - A Member of which to override the Roles of

roles - New collection of Roles for the specified Member

Returns:

AuditableRestAction

See Also:

• Guild.modifyMemberRoles(Member, Collection)

transferOwnership

@Nonnull
public AuditableRestAction<Void> transferOwnership(@Nonnull
 Member newOwner)

Description copied from interface: Guild

Transfers the Guild ownership to the specified Member
Only available if the currently logged in account is the owner of this Guild

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The currently logged in account lost ownership before completing the task
• UNKNOWN_MEMBER
  The target Member was removed from the Guild before finishing the task

Specified by:

transferOwnership in interface Guild

Parameters:

newOwner - Not-null Member to transfer ownership to

Returns:

AuditableRestAction

createTextChannel

@Nonnull
public ChannelAction<TextChannel> createTextChannel(@Nonnull
 String name,
 Category parent)

Description copied from interface: Guild

Creates a new TextChannel in this Guild. For this to be successful, the logged in account has to have the MANAGE_CHANNEL Permission

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MAX_CHANNELS
  The maximum number of channels were exceeded

Specified by:

createTextChannel in interface Guild

Parameters:

name - The name of the TextChannel to create (up to 100 characters)

parent - The optional parent category for this channel, or null

Returns:

A specific ChannelAction
This action allows to set fields for the new TextChannel before creating it

createNewsChannel

@Nonnull
public ChannelAction<NewsChannel> createNewsChannel(@Nonnull
 String name,
 Category parent)

Description copied from interface: Guild

Creates a new NewsChannel in this Guild. For this to be successful, the logged in account has to have the MANAGE_CHANNEL Permission

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MAX_CHANNELS
  The maximum number of channels were exceeded

Specified by:

createNewsChannel in interface Guild

Parameters:

name - The name of the NewsChannel to create (up to 100 characters)

parent - The optional parent category for this channel, or null

Returns:

A specific ChannelAction
This action allows to set fields for the new NewsChannel before creating it

createVoiceChannel

@Nonnull
public ChannelAction<VoiceChannel> createVoiceChannel(@Nonnull
 String name,
 Category parent)

Description copied from interface: Guild

Creates a new VoiceChannel in this Guild. For this to be successful, the logged in account has to have the MANAGE_CHANNEL Permission.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MAX_CHANNELS
  The maximum number of channels were exceeded

Specified by:

createVoiceChannel in interface Guild

Parameters:

name - The name of the VoiceChannel to create (up to 100 characters)

parent - The optional parent category for this channel, or null

Returns:

A specific ChannelAction
This action allows to set fields for the new VoiceChannel before creating it

createStageChannel

@Nonnull
public ChannelAction<StageChannel> createStageChannel(@Nonnull
 String name,
 Category parent)

Description copied from interface: Guild

Creates a new StageChannel in this Guild. For this to be successful, the logged in account has to have the MANAGE_CHANNEL Permission.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MAX_CHANNELS
  The maximum number of channels were exceeded

Specified by:

createStageChannel in interface Guild

Parameters:

name - The name of the StageChannel to create (up to 100 characters)

parent - The optional parent category for this channel, or null

Returns:

A specific ChannelAction
This action allows to set fields for the new StageChannel before creating it

createForumChannel

@Nonnull
public ChannelAction<ForumChannel> createForumChannel(@Nonnull
 String name,
 Category parent)

Description copied from interface: Guild

Creates a new ForumChannel in this Guild. For this to be successful, the logged in account has to have the MANAGE_CHANNEL Permission.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MAX_CHANNELS
  The maximum number of channels were exceeded

Specified by:

createForumChannel in interface Guild

Parameters:

name - The name of the ForumChannel to create (up to 100 characters)

parent - The optional parent category for this channel, or null

Returns:

A specific ChannelAction
This action allows to set fields for the new ForumChannel before creating it

createMediaChannel

@Nonnull
public ChannelAction<MediaChannel> createMediaChannel(@Nonnull
 String name,
 @Nullable
 Category parent)

Description copied from interface: Guild

Creates a new MediaChannel in this Guild. For this to be successful, the logged in account has to have the MANAGE_CHANNEL Permission.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MAX_CHANNELS
  The maximum number of channels were exceeded

Specified by:

createMediaChannel in interface Guild

Parameters:

name - The name of the MediaChannel to create (up to 100 characters)

parent - The optional parent category for this channel, or null

Returns:

A specific ChannelAction
This action allows to set fields for the new MediaChannel before creating it

createCategory

@Nonnull
public ChannelAction<Category> createCategory(@Nonnull
 String name)

Description copied from interface: Guild

Creates a new Category in this Guild. For this to be successful, the logged in account has to have the MANAGE_CHANNEL Permission.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MAX_CHANNELS
  The maximum number of channels were exceeded

Specified by:

createCategory in interface Guild

Parameters:

name - The name of the Category to create (up to 100 characters)

Returns:

A specific ChannelAction
This action allows to set fields for the new Category before creating it

createRole

@Nonnull
public RoleAction createRole()

Description copied from interface: Guild

Creates a new Role in this Guild.
It will be placed at the bottom (just over the Public Role) to avoid permission hierarchy conflicts.
For this to be successful, the logged in account has to have the MANAGE_ROLES Permission

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The role could not be created due to a permission discrepancy
• MAX_ROLES_PER_GUILD
  There are too many roles in this Guild

Specified by:

createRole in interface Guild

Returns:

RoleAction
Creates a new role with previously selected field values

createEmoji

@Nonnull
public AuditableRestAction<RichCustomEmoji> createEmoji(@Nonnull
 String name,
 @Nonnull
 Icon icon,
 @Nonnull
 Role... roles)

Description copied from interface: Guild

Creates a new RichCustomEmoji in this Guild.
If one or more Roles are specified the new emoji will only be available to Members with any of the specified Roles (see Member.canInteract(RichCustomEmoji))
For this to be successful, the logged in account has to have the MANAGE_GUILD_EXPRESSIONS Permission.

Unicode emojis are not included as RichCustomEmoji!

Note that a guild is limited to 50 normal and 50 animated emojis by default. Some guilds are able to add additional emojis beyond this limitation due to the MORE_EMOJI feature (see Guild.getFeatures()).
Due to simplicity we do not check for these limits.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The emoji could not be created due to a permission discrepancy

Specified by:

createEmoji in interface Guild

Parameters:

name - The name for the new emoji

icon - The Icon for the new emoji

roles - The Roles the new emoji should be restricted to
If no roles are provided the emoji will be available to all Members of this Guild

Returns:

AuditableRestAction - Type: RichCustomEmoji

createSticker

@Nonnull
public AuditableRestAction<GuildSticker> createSticker(@Nonnull
 String name,
 @Nonnull
 String description,
 @Nonnull
 FileUpload file,
 @Nonnull
 Collection<String> tags)

Description copied from interface: Guild

Creates a new GuildSticker in this Guild.

Possible ErrorResponses include:

• INVALID_FILE_UPLOADED
  The sticker file asset is not in a supported file format
• MISSING_PERMISSIONS
  The sticker could not be created due to a permission discrepancy

Specified by:

createSticker in interface Guild

Parameters:

name - The sticker name (2-30 characters)

description - The sticker description (2-100 characters, or empty)

file - The sticker file containing the asset (png/apng/gif/lottie) with valid file extension (png, gif, or json)

tags - The tags to use for auto-suggestions (Up to 200 characters in total)

Returns:

AuditableRestAction - Type: GuildSticker

deleteSticker

@Nonnull
public AuditableRestAction<Void> deleteSticker(@Nonnull
 StickerSnowflake id)

Description copied from interface: Guild

Deletes a sticker from the guild.

The returned RestAction can encounter the following Discord errors:

• UNKNOWN_STICKER
  Occurs when the provided id does not refer to a sticker known by Discord.

Specified by:

deleteSticker in interface Guild

Returns:

AuditableRestAction

modifyCategoryPositions

@Nonnull
public ChannelOrderAction modifyCategoryPositions()

Description copied from interface: Guild

Modifies the positional order of Guild.getCategories() using a specific RestAction extension to allow moving Channels up/down or to a specific position.
This uses ascending order with a 0 based index.

Possible ErrorResponses include:

• UNNKOWN_CHANNEL
  One of the channels has been deleted before the completion of the task
• MISSING_ACCESS
  The currently logged in account was removed from the Guild

Specified by:

modifyCategoryPositions in interface Guild

Returns:

ChannelOrderAction - Type: Category

modifyTextChannelPositions

@Nonnull
public ChannelOrderAction modifyTextChannelPositions()

Description copied from interface: Guild

Modifies the positional order of Guild.getTextChannels() using a specific RestAction extension to allow moving Channels up/down or to a specific position.
This uses ascending order with a 0 based index.

Possible ErrorResponses include:

• UNNKOWN_CHANNEL
  One of the channels has been deleted before the completion of the task
• MISSING_ACCESS
  The currently logged in account was removed from the Guild

Specified by:

modifyTextChannelPositions in interface Guild

Returns:

ChannelOrderAction - Type: TextChannel

modifyVoiceChannelPositions

@Nonnull
public ChannelOrderAction modifyVoiceChannelPositions()

Description copied from interface: Guild

Modifies the positional order of Guild.getVoiceChannels() using a specific RestAction extension to allow moving Channels up/down or to a specific position.
This uses ascending order with a 0 based index.

Possible ErrorResponses include:

• UNNKOWN_CHANNEL
  One of the channels has been deleted before the completion of the task
• MISSING_ACCESS
  The currently logged in account was removed from the Guild

Specified by:

modifyVoiceChannelPositions in interface Guild

Returns:

ChannelOrderAction - Type: VoiceChannel

modifyTextChannelPositions

@Nonnull
public CategoryOrderAction modifyTextChannelPositions(@Nonnull
 Category category)

Description copied from interface: Guild

Modifies the positional order of Category#getTextChannels() using an extension of ChannelOrderAction specialized for ordering the nested TextChannels of this Category.
Like ChannelOrderAction, the returned CategoryOrderAction can be used to move TextChannels up, down, or to a specific position.
This uses ascending order with a 0 based index.

Possible ErrorResponses include:

• UNNKOWN_CHANNEL
  One of the channels has been deleted before the completion of the task.
• MISSING_ACCESS
  The currently logged in account was removed from the Guild.

Specified by:

modifyTextChannelPositions in interface Guild

Parameters:

category - The Category to order TextChannels from.

Returns:

CategoryOrderAction - Type: TextChannel

modifyVoiceChannelPositions

@Nonnull
public CategoryOrderAction modifyVoiceChannelPositions(@Nonnull
 Category category)

Description copied from interface: Guild

Modifies the positional order of Category#getVoiceChannels() using an extension of ChannelOrderAction specialized for ordering the nested VoiceChannels of this Category.
Like ChannelOrderAction, the returned CategoryOrderAction can be used to move VoiceChannels up, down, or to a specific position.
This uses ascending order with a 0 based index.

Possible ErrorResponses include:

• UNNKOWN_CHANNEL
  One of the channels has been deleted before the completion of the task.
• MISSING_ACCESS
  The currently logged in account was removed from the Guild.

Specified by:

modifyVoiceChannelPositions in interface Guild

Parameters:

category - The Category to order VoiceChannels from.

Returns:

CategoryOrderAction - Type: VoiceChannels

modifyRolePositions

@Nonnull
public RoleOrderAction modifyRolePositions(boolean useAscendingOrder)

Description copied from interface: Guild

Modifies the positional order of Guild.getRoles() using a specific RestAction extension to allow moving Roles up/down or to a specific position.

Possible ErrorResponses include:

• UNKNOWN_ROLE
  One of the roles was deleted before the completion of the task
• MISSING_ACCESS
  The currently logged in account was removed from the Guild

Specified by:

modifyRolePositions in interface Guild

Parameters:

useAscendingOrder - Defines the ordering of the OrderAction. If false, the OrderAction will be in the ordering defined by Discord for roles, which is Descending. This means that the highest role appears at index 0 and the lowest role at index n - 1. Providing true will result in the ordering being in ascending order, with the lower role at index 0 and the highest at index n - 1.
As a note: Member.getRoles() and Guild.getRoles() are both in descending order.

Returns:

RoleOrderAction

modifyWelcomeScreen

@Nonnull
public GuildWelcomeScreenManager modifyWelcomeScreen()

Description copied from interface: Guild

The Manager for this guild's welcome screen, used to modify properties of the welcome screen like if the welcome screen is enabled, the description and welcome channels.
You modify multiple fields in one request by chaining setters before calling RestAction.queue().

Specified by:

modifyWelcomeScreen in interface Guild

Returns:

The GuildWelcomeScreenManager for this guild's welcome screen

updateRequestToSpeak

public void updateRequestToSpeak()

setOwner

public GuildImpl setOwner(Member owner)

setName

public GuildImpl setName(String name)

setIconId

public GuildImpl setIconId(String iconId)

setFeatures

public GuildImpl setFeatures(Set<String> features)

setSplashId

public GuildImpl setSplashId(String splashId)

setVanityCode

public GuildImpl setVanityCode(String code)

setDescription

public GuildImpl setDescription(String description)

setBannerId

public GuildImpl setBannerId(String bannerId)

setMaxPresences

public GuildImpl setMaxPresences(int maxPresences)

setMaxMembers

public GuildImpl setMaxMembers(int maxMembers)

setAfkChannel

public GuildImpl setAfkChannel(VoiceChannel afkChannel)

setSystemChannel

public GuildImpl setSystemChannel(TextChannel systemChannel)

setRulesChannel

public GuildImpl setRulesChannel(TextChannel rulesChannel)

setCommunityUpdatesChannel

public GuildImpl setCommunityUpdatesChannel(TextChannel communityUpdatesChannel)

setSafetyAlertsChannel

public GuildImpl setSafetyAlertsChannel(TextChannel safetyAlertsChannel)

setPublicRole

public GuildImpl setPublicRole(Role publicRole)

setSecurityIncidentActions

public GuildImpl setSecurityIncidentActions(SecurityIncidentActions actions)

setSecurityIncidentDetections

public GuildImpl setSecurityIncidentDetections(SecurityIncidentDetections detections)

setVerificationLevel

public GuildImpl setVerificationLevel(Guild.VerificationLevel level)

setDefaultNotificationLevel

public GuildImpl setDefaultNotificationLevel(Guild.NotificationLevel level)

setRequiredMFALevel

public GuildImpl setRequiredMFALevel(Guild.MFALevel level)

setExplicitContentLevel

public GuildImpl setExplicitContentLevel(Guild.ExplicitContentLevel level)

setAfkTimeout

public GuildImpl setAfkTimeout(Guild.Timeout afkTimeout)

setLocale

public GuildImpl setLocale(DiscordLocale locale)

setBoostTier

public GuildImpl setBoostTier(int tier)

setBoostCount

public GuildImpl setBoostCount(int count)

setOwnerId

public GuildImpl setOwnerId(long ownerId)

setMemberCount

public GuildImpl setMemberCount(int count)

setNSFWLevel

public GuildImpl setNSFWLevel(Guild.NSFWLevel nsfwLevel)

setBoostProgressBarEnabled

public GuildImpl setBoostProgressBarEnabled(boolean enabled)

getScheduledEventsView

public SortedSnowflakeCacheViewImpl<ScheduledEvent> getScheduledEventsView()

getChannelView

public SortedChannelCacheViewImpl<GuildChannel> getChannelView()

getRolesView

public SortedSnowflakeCacheViewImpl<Role> getRolesView()

getEmojisView

public SnowflakeCacheViewImpl<RichCustomEmoji> getEmojisView()

getStickersView

public SnowflakeCacheViewImpl<GuildSticker> getStickersView()

getMembersView

public MemberCacheViewImpl getMembersView()

getNSFWLevel

@Nonnull
public Guild.NSFWLevel getNSFWLevel()

Description copied from interface: Guild

Returns the NSFW Level that this guild is classified with.
For a short description of the different values, see NSFWLevel.

This value can only be modified by Discord after reviewing the Guild.

Specified by:

getNSFWLevel in interface Guild

Returns:

The NSFWLevel of this guild.

getPresenceView

@Nullable
public CacheView.SimpleCacheView<MemberPresenceImpl> getPresenceView()

getVoiceStateView

@Nonnull
public SnowflakeCacheViewImpl<GuildVoiceStateImpl> getVoiceStateView()

onMemberAdd

public void onMemberAdd()

onMemberRemove

public void onMemberRemove(long memberId)

shouldCacheVoiceState

public boolean shouldCacheVoiceState(long userId)

getVoiceState

public GuildVoiceStateImpl getVoiceState(Member member)

updateCacheVoiceStateMember

public void updateCacheVoiceStateMember(MemberImpl member)

handleVoiceStateUpdate

public void handleVoiceStateUpdate(GuildVoiceStateImpl voiceState)

getConnectedMembers

public List<Member> getConnectedMembers(GuildChannel channel)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object