Guild (discord4j-core (3.1.0.RC4))

java.lang.Object
- discord4j.core.object.entity.Guild

All Implemented Interfaces:

DiscordObject, Entity
```
public final class Guild
extends Object
implements Entity
```
A Discord guild.

See Also:

Guild Resource

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Guild.ContentFilterLevel` Automatically scan and delete messages sent in the server that contain explicit content.
`static class`	`Guild.MfaLevel` Prevent potentially dangerous administrative actions for users without two-factor authentication enabled.
`static class`	`Guild.NotificationLevel` Determines whether `Members` who have not explicitly set their notification settings receive a notification for every message sent in the server or not.
`static class`	`Guild.PremiumTier` Represent the server Premium Tier (aka boost level) of the `Guild`.
`static class`	`Guild.SystemChannelFlag` Describes system channel flags.
`static class`	`Guild.VerificationLevel` `Members` of the server must meet the following criteria before they can send messages in text channels or initiate a direct message conversation.

Constructor Summary

Constructors
Constructor and Description
`Guild(GatewayDiscordClient gateway, discord4j.discordjson.json.GuildData data)` Constructs an `Guild` with an associated ServiceMediator and Discord data.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Mono<Void>`	`ban(Snowflake userId, Consumer<? super BanQuerySpec> spec)` Requests to ban the specified user.
`Mono<String>`	`changeSelfNickname(String nickname)` Requests to change the bot user's nickname in this guild.
`Mono<Category>`	`createCategory(Consumer<? super CategoryCreateSpec> spec)` Requests to create a category.
`Mono<GuildEmoji>`	`createEmoji(Consumer<? super GuildEmojiCreateSpec> spec)` Requests to create an emoji.
`Mono<NewsChannel>`	`createNewsChannel(Consumer<? super NewsChannelCreateSpec> spec)` Requests to create a news channel.
`Mono<Role>`	`createRole(Consumer<? super RoleCreateSpec> spec)` Requests to create a role.
`Mono<TextChannel>`	`createTextChannel(Consumer<? super TextChannelCreateSpec> spec)` Requests to create a text channel.
`Mono<VoiceChannel>`	`createVoiceChannel(Consumer<? super VoiceChannelCreateSpec> spec)` Requests to create a voice channel.
`Mono<Void>`	`delete()` Requests to delete this guild.
`Mono<Guild>`	`edit(Consumer<? super GuildEditSpec> spec)` Requests to edit this guild.
`boolean`	`equals(Object obj)`
`Mono<VoiceChannel>`	`getAfkChannel()` Requests to retrieve the AFK channel, if present.
`Mono<VoiceChannel>`	`getAfkChannel(EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the AFK channel, if present, using the given retrieval strategy.
`Optional<Snowflake>`	`getAfkChannelId()` Gets the ID of the AFK channel, if present.
`int`	`getAfkTimeout()` Gets the AFK timeout in seconds.
`Optional<Snowflake>`	`getApplicationId()` Gets the application ID of the guild creator if it is bot-created.
`Flux<AuditLogEntry>`	`getAuditLog()` Requests to retrieve the audit log for this guild.
`Flux<AuditLogEntry>`	`getAuditLog(Consumer<? super AuditLogQuerySpec> spec)` Requests to retrieve the audit log for this guild.
`Mono<Ban>`	`getBan(Snowflake userId)` Requests to retrieve the ban for the specified user for this guild.
`Mono<Image>`	`getBanner(Image.Format format)` Gets the banner of the guild.
`Optional<String>`	`getBannerUrl(Image.Format format)` Gets the banner URL of the guild, if present.
`Flux<Ban>`	`getBans()` Requests to retrieve all the bans for this guild.
`Mono<GuildChannel>`	`getChannelById(Snowflake id)` Requests to retrieve the channel as represented by the supplied ID.
`Mono<GuildChannel>`	`getChannelById(Snowflake id, EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the channel as represented by the supplied ID, using the given retrieval strategy.
`Flux<GuildChannel>`	`getChannels()` Requests to retrieve the guild's channels.
`Flux<GuildChannel>`	`getChannels(EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the guild's channels, using the given retrieval strategy.
`GatewayDiscordClient`	`getClient()` Returns the `GatewayDiscordClient` that created this object.
`Guild.ContentFilterLevel`	`getContentFilterLevel()` Gets the default explicit content filter level.
`Optional<String>`	`getDescription()` Gets the description of the guild, if present.
`Mono<Image>`	`getDiscoverySplash(Image.Format format)` Gets the discovery splash of the guild.
`Optional<String>`	`getDiscoverySplashUrl(Image.Format format)` Gets the discovery splash URL of the guild, if present.
`Mono<GuildChannel>`	`getEmbedChannel()` Requests to retrieve the embedded channel, if present.
`Mono<GuildChannel>`	`getEmbedChannel(EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the embedded channel, if present, using the given retrieval strategy.
`Optional<Snowflake>`	`getEmbedChannelId()` Deprecated. Use `Guild#getWidgetChannelId` instead. For removal in v3.2
`Set<Snowflake>`	`getEmojiIds()` Gets the guild's emoji's IDs.
`Flux<GuildEmoji>`	`getEmojis()` Requests to retrieve the guild's emojis.
`Flux<GuildEmoji>`	`getEmojis(EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the guild's emojis, using the given retrieval strategy.
`Mono<Role>`	`getEveryoneRole()` Requests to retrieve the guild's @everyone `Role`.
`Mono<Role>`	`getEveryoneRole(EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the guild's @everyone `Role`, using the given retrieval strategy.
`Set<String>`	`getFeatures()` Gets the enabled guild features.
`Mono<GuildEmoji>`	`getGuildEmojiById(Snowflake id)` Requests to retrieve the guild emoji as represented by the supplied ID.
`Mono<GuildEmoji>`	`getGuildEmojiById(Snowflake id, EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the guild emoji as represented by the supplied ID, using the given retrieval strategy.
`Mono<Image>`	`getIcon(Image.Format format)` Gets the icon of the guild.
`Optional<String>`	`getIconUrl(Image.Format format)` Gets the icon URL of the guild, if present.
`Snowflake`	`getId()` Gets the Snowflake that uniquely identifies this entity.
`Flux<ExtendedInvite>`	`getInvites()` Requests to retrieve the invites of the guild.
`Instant`	`getJoinTime()` Gets when this guild was joined at.
`OptionalInt`	`getMaxMembers()` Gets the maximum amount of members of the guild, if present.
`int`	`getMaxPresences()` Gets the maximum amount of presences of the guild.
`Optional<Integer>`	`getMaxVideoChannelUsers()` Gets the maximum amount of users in a video channel, if present.
`Mono<Member>`	`getMemberById(Snowflake id)` Requests to retrieve the member as represented by the supplied ID.
`Mono<Member>`	`getMemberById(Snowflake id, EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the member as represented by the supplied ID, using the given retrieval strategy.
`int`	`getMemberCount()` Gets the total number of members in the guild.
`Flux<Member>`	`getMembers()` Requests to retrieve the members of the guild.
`Flux<Member>`	`getMembers(EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the members of the guild, using the given retrieval strategy.
`Guild.MfaLevel`	`getMfaLevel()` Gets the required MFA level for the guild.
`String`	`getName()` Gets the guild name.
`Guild.NotificationLevel`	`getNotificationLevel()` Gets the default message notification level..
`Mono<Member>`	`getOwner()` Requests to retrieve the owner of the guild.
`Snowflake`	`getOwnerId()` Gets the ID of the owner of the guild.
`Locale`	`getPreferredLocale()` Gets the preferred locale of a "PUBLIC" guild used in server discovery and notices from Discord; defaults to "en-US".
`OptionalInt`	`getPremiumSubscriptionCount()` Gets the number of boosts this server currently has, if present.
`Guild.PremiumTier`	`getPremiumTier()` Gets the Premium Tier (Server Boost level) for the guild.
`Flux<Presence>`	`getPresences()` Requests to retrieve the presences of the guild.
`Mono<Integer>`	`getPruneCount(Consumer<? super GuildPruneCountSpec> spec)` Requests to retrieve the number of users that will be pruned.
`Mono<Integer>`	`getPruneCount(int days)` Requests to retrieve the number of users that will be pruned.
`Mono<TextChannel>`	`getPublicUpdatesChannel()` Requests to retrieve the channel where admins and moderators of "PUBLIC" guilds receive notices from Discord, if present.
`Mono<TextChannel>`	`getPublicUpdatesChannel(EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the channel where admins and moderators of "PUBLIC" guilds receive notices from Discord, if present, using the given retrieval strategy.
`Optional<Snowflake>`	`getPublicUpdatesChannelId()` Gets the id of the channel where admins and moderators of "PUBLIC" guilds receive notices from Discord, if present.
`Mono<Region>`	`getRegion()` Requests to retrieve the voice region for the guild.
`String`	`getRegionId()` Gets the voice region ID for the guild.
`Flux<Region>`	`getRegions()` Requests to retrieve the voice regions for the guild.
`Mono<Role>`	`getRoleById(Snowflake id)` Requests to retrieve the role as represented by the supplied ID.
`Mono<Role>`	`getRoleById(Snowflake id, EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the role as represented by the supplied ID, using the given retrieval strategy.
`Set<Snowflake>`	`getRoleIds()` Gets the guild's roles' IDs.
`Flux<Role>`	`getRoles()` Requests to retrieve the guild's roles.
`Flux<Role>`	`getRoles(EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the guild's roles, using the given retrieval strategy.
`Mono<TextChannel>`	`getRulesChannel()` Requests to retrieve the channel where "PUBLIC" guilds display rules and/or guidelines, if present.
`Mono<TextChannel>`	`getRulesChannel(EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the channel where "PUBLIC" guilds display rules and/or guidelines, if present, using the given retrieval strategy.
`Optional<Snowflake>`	`getRulesChannelId()` Gets the id of the channel where "PUBLIC" guilds display rules and/or guidelines, if present.
`Mono<Member>`	`getSelfMember()` Requests to retrieve the member as represented by the bot user's ID.
`Mono<Image>`	`getSplash(Image.Format format)` Gets the splash of the guild.
`Optional<String>`	`getSplashUrl(Image.Format format)` Gets the splash URL of the guild, if present.
`Mono<TextChannel>`	`getSystemChannel()` Requests to retrieve the channel to which system messages are sent, if present.
`Mono<TextChannel>`	`getSystemChannel(EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the channel to which system messages are sent, if present, using the given retrieval strategy.
`EnumSet<Guild.SystemChannelFlag>`	`getSystemChannelFlags()` Returns the flags of the system `channel`.
`Optional<Snowflake>`	`getSystemChannelId()` Gets the ID of the channel where guild notices such as welcome messages and boost events are posted, if present.
`Optional<String>`	`getVanityUrlCode()` Gets the vanity url code of the guild, if present.
`Guild.VerificationLevel`	`getVerificationLevel()` Gets the level of verification required for the guild.
`Flux<VoiceState>`	`getVoiceStates()` Requests to retrieve the voice states of the guild.
`Flux<Webhook>`	`getWebhooks()` Requests to retrieve the webhooks of the guild.
`Mono<GuildChannel>`	`getWidgetChannel()` Requests to retrieve the channel for the server widget, if present.
`Mono<GuildChannel>`	`getWidgetChannel(EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the channel for the server widget, if present, using the given retrieval strategy.
`Optional<Snowflake>`	`getWidgetChannelId()` Gets the channel ID that the widget will generate an invite to, if present.
`int`	`hashCode()`
`boolean`	`isEmbedEnabled()` Deprecated. Use `Guild#isWidgetEnabled` instead
`boolean`	`isLarge()` Gets whether this guild is considered large.
`boolean`	`isUnavailable()` Gets whether this guild is unavailable.
`boolean`	`isWidgetEnabled()` Gets whether or not the server widget is enabled.
`Mono<Void>`	`kick(Snowflake userId)` Requests to kick the specified user from this guild.
`Mono<Void>`	`kick(Snowflake userId, String reason)` Requests to kick the specified user from this guild while optionally specifying a reason.
`Mono<Void>`	`leave()` Requests to leave this guild.
`Mono<Integer>`	`prune(Consumer<? super GuildPruneSpec> spec)` Requests to prune users while customizing parameters.
`Mono<Integer>`	`prune(int days)` Requests to prune users.
`Mono<Integer>`	`prune(int days, String reason)` Requests to prune users while optionally specifying a reason.
`Flux<Member>`	`requestMembers()` Return all `members` from this `Guild` using the current Gateway connection.
`String`	`toString()`
`Mono<Void>`	`unban(Snowflake userId)` Requests to unban the specified user.
`Mono<Void>`	`unban(Snowflake userId, String reason)` Requests to unban the specified user while optionally specifying a reason.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Guild
```
public Guild(GatewayDiscordClient gateway,
             discord4j.discordjson.json.GuildData data)
```
    Constructs an Guild with an associated ServiceMediator and Discord data.
    
    Parameters:
    
    gateway - The GatewayDiscordClient associated to this object, must be non-null.
    
    data - The raw data as represented by Discord, must be non-null.
- Method Detail
  - getClient
```
public GatewayDiscordClient getClient()
```
    Description copied from interface: DiscordObject
    
    Returns the GatewayDiscordClient that created this object. Methods in it are exclusively based on the entity cache or Store in use. Refer to calling getClient().rest() to access a DiscordClient that is capable of requesting entities directly from the REST API.
    
    Specified by:
    
    getClient in interface DiscordObject
    
    Returns:
    
    The GatewayDiscordClient associated to this object.
  - getId
```
public Snowflake getId()
```
    Description copied from interface: Entity
    
    Gets the Snowflake that uniquely identifies this entity.
    
    Specified by:
    
    getId in interface Entity
    
    Returns:
    
    The Snowflake that uniquely identifies this entity.
  - getName
```
public String getName()
```
    Gets the guild name.
    
    Returns:
    
    The guild name.
  - getIconUrl
```
public Optional<String> getIconUrl(Image.Format format)
```
    Gets the icon URL of the guild, if present.
    
    Parameters:
    
    format - The format for the URL.
    
    Returns:
    
    The icon URL of the guild, if present.
  - getIcon
```
public Mono<Image> getIcon(Image.Format format)
```
    Gets the icon of the guild.
    
    Parameters:
    
    format - The format in which to get the image.
    
    Returns:
    
    A Mono where, upon successful completion, emits the icon of the guild. If an error is received, it is emitted through the Mono.
  - getSplashUrl
```
public Optional<String> getSplashUrl(Image.Format format)
```
    Gets the splash URL of the guild, if present.
    
    Parameters:
    
    format - The format for the URL.
    
    Returns:
    
    The splash URL of the guild, if present.
  - getSplash
```
public Mono<Image> getSplash(Image.Format format)
```
    Gets the splash of the guild.
    
    Parameters:
    
    format - The format in which to get the image.
    
    Returns:
    
    A Mono where, upon successful completion, emits the splash of the guild. If an error is received, it is emitted through the Mono.
  - getDiscoverySplashUrl
```
public Optional<String> getDiscoverySplashUrl(Image.Format format)
```
    Gets the discovery splash URL of the guild, if present.
    
    Parameters:
    
    format - The format for the URL.
    
    Returns:
    
    The discovery splash URL of the guild, if present.
  - getDiscoverySplash
```
public Mono<Image> getDiscoverySplash(Image.Format format)
```
    Gets the discovery splash of the guild.
    
    Parameters:
    
    format - The format in which to get the image.
    
    Returns:
    
    A Mono where, upon successful completion, emits the discovery splash of the guild. If an error is received, it is emitted through the Mono.
  - getBannerUrl
```
public Optional<String> getBannerUrl(Image.Format format)
```
    Gets the banner URL of the guild, if present.
    
    Parameters:
    
    format - The format for the URL.
    
    Returns:
    
    The banner URL of the guild, if present.
  - getBanner
```
public Mono<Image> getBanner(Image.Format format)
```
    Gets the banner of the guild.
    
    Parameters:
    
    format - The format in which to get the image.
    
    Returns:
    
    A Mono where, upon successful completion, emits the banner of the guild. If an error is received, it is emitted through the Mono.
  - getOwnerId
```
public Snowflake getOwnerId()
```
    Gets the ID of the owner of the guild.
    
    Returns:
    
    The ID of the owner of the guild.
  - getOwner
```
public Mono<Member> getOwner()
```
    Requests to retrieve the owner of the guild.
    
    Returns:
    
    A Mono where, upon successful completion, emits the owner of the guild. If an error is received, it is emitted through the Mono.
  - getRegionId
```
public String getRegionId()
```
    Gets the voice region ID for the guild.
    
    Returns:
    
    The voice region ID for the guild.
  - getRegion
```
public Mono<Region> getRegion()
```
    Requests to retrieve the voice region for the guild.
    
    Returns:
    
    A Mono where, upon successful completion, emits the voice region for the guild. If an error is received, it is emitted through the Mono.
  - getRegions
```
public Flux<Region> getRegions()
```
    Requests to retrieve the voice regions for the guild.
    
    Returns:
    
    A Flux that continually emits the guild's voice regions. If an error is received, it is emitted through the Flux.
  - getAfkChannelId
```
public Optional<Snowflake> getAfkChannelId()
```
    Gets the ID of the AFK channel, if present.
    
    Returns:
    
    The ID of the AFK channel, if present.
  - getAfkChannel
```
public Mono<VoiceChannel> getAfkChannel()
```
    Requests to retrieve the AFK channel, if present.
    
    Returns:
    
    A Mono where, upon successful completion, emits the AFK channel, if present. If an error is received, it is emitted through the Mono.
  - getAfkChannel
```
public Mono<VoiceChannel> getAfkChannel(EntityRetrievalStrategy retrievalStrategy)
```
    Requests to retrieve the AFK channel, if present, using the given retrieval strategy.
    
    Parameters:
    
    retrievalStrategy - the strategy to use to get the AFK channel
    
    Returns:
    
    A Mono where, upon successful completion, emits the AFK channel, if present. If an error is received, it is emitted through the Mono.
  - getAfkTimeout
```
public int getAfkTimeout()
```
    Gets the AFK timeout in seconds.
    
    Returns:
    
    The AFK timeout in seconds.
  - getEmbedChannelId
```
@Deprecated
public Optional<Snowflake> getEmbedChannelId()
```
    Deprecated. Use Guild#getWidgetChannelId instead. For removal in v3.2
    
    Gets the ID of the embedded channel, if present.
    
    Returns:
    
    The ID of the embedded channel, if present.
  - getEmbedChannel
```
public Mono<GuildChannel> getEmbedChannel()
```
    Requests to retrieve the embedded channel, if present.
    
    Returns:
    
    A Mono where, upon successful completion, emits the embedded channel, if present. If an error is received, it is emitted through the Mono.
  - getEmbedChannel
```
public Mono<GuildChannel> getEmbedChannel(EntityRetrievalStrategy retrievalStrategy)
```
    Requests to retrieve the embedded channel, if present, using the given retrieval strategy.
    
    Parameters:
    
    retrievalStrategy - the strategy to use to get the embedded channel
    
    Returns:
    
    A Mono where, upon successful completion, emits the embedded channel, if present. If an error is received, it is emitted through the Mono.
  - getPremiumTier
```
public Guild.PremiumTier getPremiumTier()
```
    Gets the Premium Tier (Server Boost level) for the guild.
    
    Returns:
    
    The Premium Tier (Server Boost level) for the guild.
  - getPremiumSubscriptionCount
```
public OptionalInt getPremiumSubscriptionCount()
```
    Gets the number of boosts this server currently has, if present.
    
    Returns:
    
    The number of boosts this server currently has, if present.
  - getPreferredLocale
```
public Locale getPreferredLocale()
```
    Gets the preferred locale of a "PUBLIC" guild used in server discovery and notices from Discord; defaults to "en-US".
    
    Returns:
    
    The preferred locale of a "PUBLIC" guild used in server discovery and notices from Discord; defaults to "en-US".
  - getVerificationLevel
```
public Guild.VerificationLevel getVerificationLevel()
```
    Gets the level of verification required for the guild.
    
    Returns:
    
    The level of verification required for the guild.
  - getNotificationLevel
```
public Guild.NotificationLevel getNotificationLevel()
```
    Gets the default message notification level..
    
    Returns:
    
    The default message notification level.
  - getContentFilterLevel
```
public Guild.ContentFilterLevel getContentFilterLevel()
```
    Gets the default explicit content filter level.
    
    Returns:
    
    The default explicit content filter level.
  - getRoleIds
```
public Set<Snowflake> getRoleIds()
```
    Gets the guild's roles' IDs.
    
    Returns:
    
    The guild's roles' IDs.
  - getRoles
```
public Flux<Role> getRoles()
```
    Requests to retrieve the guild's roles.
    The order of items emitted by the returned Flux is unspecified. Use OrderUtil.orderRoles(Flux) to consistently order roles.
    
    Returns:
    
    A Flux that continually emits the guild's roles. If an error is received, it is emitted through the Flux.
  - getRoles
```
public Flux<Role> getRoles(EntityRetrievalStrategy retrievalStrategy)
```
    Requests to retrieve the guild's roles, using the given retrieval strategy.
    The order of items emitted by the returned Flux is unspecified. Use OrderUtil.orderRoles(Flux) to consistently order roles.
    
    Parameters:
    
    retrievalStrategy - the strategy to use to get the roles
    
    Returns:
    
    A Flux that continually emits the guild's roles. If an error is received, it is emitted through the Flux.
  - getRoleById
```
public Mono<Role> getRoleById(Snowflake id)
```
    Requests to retrieve the role as represented by the supplied ID.
    
    Parameters:
    
    id - The ID of the role.
    
    Returns:
    
    A Mono where, upon successful completion, emits the Role as represented by the supplied ID. If an error is received, it is emitted through the Mono.
  - getRoleById
```
public Mono<Role> getRoleById(Snowflake id,
                              EntityRetrievalStrategy retrievalStrategy)
```
    Requests to retrieve the role as represented by the supplied ID, using the given retrieval strategy.
    
    Parameters:
    
    id - The ID of the role.
    
    retrievalStrategy - the strategy to use to get the role
    
    Returns:
    
    A Mono where, upon successful completion, emits the Role as represented by the supplied ID. If an error is received, it is emitted through the Mono.
  - getEveryoneRole
```
public Mono<Role> getEveryoneRole()
```
    Requests to retrieve the guild's @everyone Role.
    
    Returns:
    
    A Mono where, upon successful completion, emits the @everyone Role, if present. If an error is received, it is emitted through the Mono.
  - getEveryoneRole
```
public Mono<Role> getEveryoneRole(EntityRetrievalStrategy retrievalStrategy)
```
    Requests to retrieve the guild's @everyone Role, using the given retrieval strategy.
    
    Parameters:
    
    retrievalStrategy - the strategy to use to get the everyone role
    
    Returns:
    
    A Mono where, upon successful completion, emits the @everyone Role, if present. If an error is received, it is emitted through the Mono.
  - getEmojiIds
```
public Set<Snowflake> getEmojiIds()
```
    Gets the guild's emoji's IDs.
    
    Returns:
    
    The guild's emoji's IDs.
  - getEmojis
```
public Flux<GuildEmoji> getEmojis()
```
    Requests to retrieve the guild's emojis.
    
    Returns:
    
    A Flux that continually emits guild's emojis. If an error is received, it is emitted through the Flux.
  - getEmojis
```
public Flux<GuildEmoji> getEmojis(EntityRetrievalStrategy retrievalStrategy)
```
    Requests to retrieve the guild's emojis, using the given retrieval strategy.
    
    Parameters:
    
    retrievalStrategy - the strategy to use to get the emojis
    
    Returns:
    
    A Flux that continually emits guild's emojis. If an error is received, it is emitted through the Flux.
  - getGuildEmojiById
```
public Mono<GuildEmoji> getGuildEmojiById(Snowflake id)
```
    Requests to retrieve the guild emoji as represented by the supplied ID.
    
    Parameters:
    
    id - The ID of the guild emoji.
    
    Returns:
    
    A Mono where, upon successful completion, emits the GuildEmoji as represented by the supplied ID. If an error is received, it is emitted through the Mono.
  - getGuildEmojiById
```
public Mono<GuildEmoji> getGuildEmojiById(Snowflake id,
                                          EntityRetrievalStrategy retrievalStrategy)
```
    Requests to retrieve the guild emoji as represented by the supplied ID, using the given retrieval strategy.
    
    Parameters:
    
    id - The ID of the guild emoji.
    
    retrievalStrategy - the strategy to use to get the guild emoji
    
    Returns:
    
    A Mono where, upon successful completion, emits the GuildEmoji as represented by the supplied ID. If an error is received, it is emitted through the Mono.
  - getFeatures
```
public Set<String> getFeatures()
```
    Gets the enabled guild features.
    You can see the available guild features
    
    Returns:
    
    The enabled guild features.
  - getMfaLevel
```
public Guild.MfaLevel getMfaLevel()
```
    Gets the required MFA level for the guild.
    
    Returns:
    
    The required MFA level for the guild.
  - getApplicationId
```
public Optional<Snowflake> getApplicationId()
```
    Gets the application ID of the guild creator if it is bot-created.
    
    Returns:
    
    The application ID of the guild creator if it is bot-created.
  - isWidgetEnabled
```
public boolean isWidgetEnabled()
```
    Gets whether or not the server widget is enabled.
    
    Returns:
    
    Whether or not the server widget is enabled.
  - getWidgetChannelId
```
public Optional<Snowflake> getWidgetChannelId()
```
    Gets the channel ID that the widget will generate an invite to, if present.
    
    Returns:
    
    The channel ID that the widget will generate an invite to, if present.
  - getWidgetChannel
```
public Mono<GuildChannel> getWidgetChannel()
```
    Requests to retrieve the channel for the server widget, if present.
    
    Returns:
    
    A Mono where, upon successful completion, emits the channel for the server widget, if present. If an error is received, it is emitted through the Mono.
  - getWidgetChannel
```
public Mono<GuildChannel> getWidgetChannel(EntityRetrievalStrategy retrievalStrategy)
```
    Requests to retrieve the channel for the server widget, if present, using the given retrieval strategy.
    
    Parameters:
    
    retrievalStrategy - the strategy to use to get the widget channel
    
    Returns:
    
    A Mono where, upon successful completion, emits the channel for the server widget, if present. If an error is received, it is emitted through the Mono.
  - getSystemChannelId
```
public Optional<Snowflake> getSystemChannelId()
```
    Gets the ID of the channel where guild notices such as welcome messages and boost events are posted, if present.
    
    Returns:
    
    The ID of the channel where guild notices such as welcome messages and boost events are posted, if present.
  - getSystemChannel
```
public Mono<TextChannel> getSystemChannel()
```
    Requests to retrieve the channel to which system messages are sent, if present.
    
    Returns:
    
    A Mono where, upon successful completion, emits the channel to which system messages are sent, if present. If an error is received, it is emitted through the Mono.
  - getSystemChannel
```
public Mono<TextChannel> getSystemChannel(EntityRetrievalStrategy retrievalStrategy)
```
    Requests to retrieve the channel to which system messages are sent, if present, using the given retrieval strategy.
    
    Parameters:
    
    retrievalStrategy - the strategy to use to get the system channel
    
    Returns:
    
    A Mono where, upon successful completion, emits the channel to which system messages are sent, if present. If an error is received, it is emitted through the Mono.
  - getSystemChannelFlags
```
public EnumSet<Guild.SystemChannelFlag> getSystemChannelFlags()
```
    Returns the flags of the system channel.
    
    Returns:
    
    A EnumSet with the flags of the system channel.
  - getRulesChannelId
```
public Optional<Snowflake> getRulesChannelId()
```
    Gets the id of the channel where "PUBLIC" guilds display rules and/or guidelines, if present.
    
    Returns:
    
    The id of the channel where "PUBLIC" guilds display rules and/or guidelines, if present.
  - getRulesChannel
```
public Mono<TextChannel> getRulesChannel()
```
    Requests to retrieve the channel where "PUBLIC" guilds display rules and/or guidelines, if present.
    
    Returns:
    
    A Mono where, upon successful completion, emits the channel where "PUBLIC" guilds display rules and/or guidelines, if present. If an error is received, it is emitted through the Mono.
  - getRulesChannel
```
public Mono<TextChannel> getRulesChannel(EntityRetrievalStrategy retrievalStrategy)
```
    Requests to retrieve the channel where "PUBLIC" guilds display rules and/or guidelines, if present, using the given retrieval strategy.
    
    Parameters:
    
    retrievalStrategy - the strategy to use to get the rules channel
    
    Returns:
    
    A Mono where, upon successful completion, emits the channel where "PUBLIC" guilds display rules and/or guidelines, if present. If an error is received, it is emitted through the Mono.
  - getPublicUpdatesChannelId
```
public Optional<Snowflake> getPublicUpdatesChannelId()
```
    Gets the id of the channel where admins and moderators of "PUBLIC" guilds receive notices from Discord, if present.
    
    Returns:
    
    The id of the channel where admins and moderators of "PUBLIC" guilds receive notices from Discord, if present.
  - getPublicUpdatesChannel
```
public Mono<TextChannel> getPublicUpdatesChannel()
```
    Requests to retrieve the channel where admins and moderators of "PUBLIC" guilds receive notices from Discord, if present.
    
    Returns:
    
    A Mono where, upon successful completion, emits the channel where admins and moderators of "PUBLIC" guilds receive notices from Discord, if present. If an error is received, it is emitted through the Mono.
  - getPublicUpdatesChannel
```
public Mono<TextChannel> getPublicUpdatesChannel(EntityRetrievalStrategy retrievalStrategy)
```
    Requests to retrieve the channel where admins and moderators of "PUBLIC" guilds receive notices from Discord, if present, using the given retrieval strategy.
    
    Parameters:
    
    retrievalStrategy - the strategy to use to get the rules channel
    
    Returns:
    
    A Mono where, upon successful completion, emits the channel where admins and moderators of "PUBLIC" guilds receive notices from Discord, if present. If an error is received, it is emitted through the Mono.
  - getMaxVideoChannelUsers
```
public Optional<Integer> getMaxVideoChannelUsers()
```
    Gets the maximum amount of users in a video channel, if present.
    
    Returns:
    
    The maximum amount of users in a video channel, if present.
  - getJoinTime
```
public Instant getJoinTime()
```
    Gets when this guild was joined at. If this Guild object was retrieved using REST API, then calling this method will throw DateTimeParseException.
    
    Returns:
    
    When this guild was joined at.
  - isLarge
```
public boolean isLarge()
```
    Gets whether this guild is considered large. If this Guild object was retrieved using REST API, then calling this method will always return false.
    
    Returns:
    
    If present, true if the guild is considered large, false otherwise.
  - isUnavailable
```
public boolean isUnavailable()
```
    Gets whether this guild is unavailable.
    
    Returns:
    
    If present, true if the guild is unavailable, false otherwise.
  - isEmbedEnabled
```
@Deprecated
public boolean isEmbedEnabled()
```
    Deprecated. Use Guild#isWidgetEnabled instead
    
    Gets whether this guild is embeddable (e.g. widget).
    
    Returns:
    
    Whether this guild is embeddable (e.g. widget).
  - getMemberCount
```
public int getMemberCount()
```
    Gets the total number of members in the guild. If this Guild object was retrieved using REST API, then calling this method will always return the same value.
    
    Returns:
    
    The total number of members in the guild.
  - getVoiceStates
```
public Flux<VoiceState> getVoiceStates()
```
    Requests to retrieve the voice states of the guild.
    
    Returns:
    
    A Flux that continually emits the voice states of the guild. If an error is received, it is emitted through the Flux.
  - getMembers
```
public Flux<Member> getMembers()
```
    Requests to retrieve the members of the guild.
    
    Returns:
    
    A Flux that continually emits the members of the guild. If an error is received, it is emitted through the Flux.
  - getMembers
```
public Flux<Member> getMembers(EntityRetrievalStrategy retrievalStrategy)
```
    Requests to retrieve the members of the guild, using the given retrieval strategy.
    
    Parameters:
    
    retrievalStrategy - the strategy to use to get the members
    
    Returns:
    
    A Flux that continually emits the members of the guild. If an error is received, it is emitted through the Flux.
  - requestMembers
```
public Flux<Member> requestMembers()
```
    Return all members from this Guild using the current Gateway connection.
    
    Returns:
    
    a Flux of Member for the given Guild. If an error occurs, it is emitted through the Flux.
  - getMemberById
```
public Mono<Member> getMemberById(Snowflake id)
```
    Requests to retrieve the member as represented by the supplied ID.
    
    Parameters:
    
    id - The ID of the member.
    
    Returns:
    
    A Mono where, upon successful completion, emits the Member as represented by the supplied ID. If an error is received, it is emitted through the Mono.
  - getMemberById
```
public Mono<Member> getMemberById(Snowflake id,
                                  EntityRetrievalStrategy retrievalStrategy)
```
    Requests to retrieve the member as represented by the supplied ID, using the given retrieval strategy.
    
    Parameters:
    
    id - The ID of the member.
    
    retrievalStrategy - the strategy to use to get the member
    
    Returns:
    
    A Mono where, upon successful completion, emits the Member as represented by the supplied ID. If an error is received, it is emitted through the Mono.
  - getSelfMember
```
public Mono<Member> getSelfMember()
```
    Requests to retrieve the member as represented by the bot user's ID.
    
    Returns:
    
    A Mono where, upon successful completion, emits the Member as represented by the bot user's ID. If an error is received, it is emitted through the Mono.
  - getChannels
```
public Flux<GuildChannel> getChannels()
```
    Requests to retrieve the guild's channels.
    The order of items emitted by the returned Flux is unspecified. Use OrderUtil.orderGuildChannels(Flux) to consistently order channels.
    
    Returns:
    
    A Flux that continually emits the guild's channels. If an error is received, it is emitted through the Flux.
  - getChannels
```
public Flux<GuildChannel> getChannels(EntityRetrievalStrategy retrievalStrategy)
```
    Requests to retrieve the guild's channels, using the given retrieval strategy.
    The order of items emitted by the returned Flux is unspecified. Use OrderUtil.orderGuildChannels(Flux) to consistently order channels.
    
    Parameters:
    
    retrievalStrategy - the strategy to use to get the channels
    
    Returns:
    
    A Flux that continually emits the guild's channels. If an error is received, it is emitted through the Flux.
  - getChannelById
```
public Mono<GuildChannel> getChannelById(Snowflake id)
```
    Requests to retrieve the channel as represented by the supplied ID.
    
    Parameters:
    
    id - The ID of the channel.
    
    Returns:
    
    A Mono where, upon successful completion, emits the GuildChannel as represented by the supplied ID. If an error is received, it is emitted through the Mono.
  - getChannelById
```
public Mono<GuildChannel> getChannelById(Snowflake id,
                                         EntityRetrievalStrategy retrievalStrategy)
```
    Requests to retrieve the channel as represented by the supplied ID, using the given retrieval strategy.
    
    Parameters:
    
    id - The ID of the channel.
    
    retrievalStrategy - the strategy to use to get the channel
    
    Returns:
    
    A Mono where, upon successful completion, emits the GuildChannel as represented by the supplied ID. If an error is received, it is emitted through the Mono.
  - getPresences
```
public Flux<Presence> getPresences()
```
    Requests to retrieve the presences of the guild.
    
    Returns:
    
    A Flux that continually emits the presences of the guild. If an error is received, it is emitted through the Flux.
  - getVanityUrlCode
```
public Optional<String> getVanityUrlCode()
```
    Gets the vanity url code of the guild, if present.
    
    Returns:
    
    The vanity url code of the guild, if present.
  - getDescription
```
public Optional<String> getDescription()
```
    Gets the description of the guild, if present.
    
    Returns:
    
    The description of the guild, if present.
  - getMaxPresences
```
public int getMaxPresences()
```
    Gets the maximum amount of presences of the guild.
    
    Returns:
    
    The maximum amount of presences for the guild.
  - getMaxMembers
```
public OptionalInt getMaxMembers()
```
    Gets the maximum amount of members of the guild, if present.
    
    Returns:
    
    The maximum amount of members for the guild, if present.
  - edit
```
public Mono<Guild> edit(Consumer<? super GuildEditSpec> spec)
```
    Requests to edit this guild.
    
    Parameters:
    
    spec - A Consumer that provides a "blank" GuildEditSpec to be operated on.
    
    Returns:
    
    A Mono where, upon successful completion, emits the edited Guild. If an error is received, it is emitted through the Mono.
  - createEmoji
```
public Mono<GuildEmoji> createEmoji(Consumer<? super GuildEmojiCreateSpec> spec)
```
    Requests to create an emoji.
    
    Parameters:
    
    spec - A Consumer that provides a "blank" GuildEmojiCreateSpec to be operated on.
    
    Returns:
    
    A Mono where, upon successful completion, emits the created GuildEmoji. If an error is received, it is emitted through the Mono.
  - createRole
```
public Mono<Role> createRole(Consumer<? super RoleCreateSpec> spec)
```
    Requests to create a role.
    
    Parameters:
    
    spec - A Consumer that provides a "blank" RoleCreateSpec to be operated on.
    
    Returns:
    
    A Mono where, upon successful completion, emits the created Role. If an error is received, it is emitted through the Mono.
  - createNewsChannel
```
public Mono<NewsChannel> createNewsChannel(Consumer<? super NewsChannelCreateSpec> spec)
```
    Requests to create a news channel.
    
    Parameters:
    
    spec - A Consumer that provides a "blank" NewsChannelCreateSpec to be operated on.
    
    Returns:
    
    A Mono where, upon successful completion, emits the created NewsChannel. If an error is received, it is emitted through the Mono.
  - createCategory
```
public Mono<Category> createCategory(Consumer<? super CategoryCreateSpec> spec)
```
    Requests to create a category.
    
    Parameters:
    
    spec - A Consumer that provides a "blank" CategoryCreateSpec to be operated on.
    
    Returns:
    
    A Mono where, upon successful completion, emits the created Category. If an error is received, it is emitted through the Mono.
  - createTextChannel
```
public Mono<TextChannel> createTextChannel(Consumer<? super TextChannelCreateSpec> spec)
```
    Requests to create a text channel.
    
    Parameters:
    
    spec - A Consumer that provides a "blank" TextChannelCreateSpec to be operated on.
    
    Returns:
    
    A Mono where, upon successful completion, emits the created TextChannel. If an error is received, it is emitted through the Mono.
  - createVoiceChannel
```
public Mono<VoiceChannel> createVoiceChannel(Consumer<? super VoiceChannelCreateSpec> spec)
```
    Requests to create a voice channel.
    
    Parameters:
    
    spec - A Consumer that provides a "blank" VoiceChannelCreateSpec to be operated on.
    
    Returns:
    
    A Mono where, upon successful completion, emits the created VoiceChannel. If an error is received, it is emitted through the Mono.
  - delete
```
public Mono<Void> delete()
```
    Requests to delete this guild.
    
    Returns:
    
    A Mono where, upon successful completion, emits nothing; indicating the guild has been deleted. If an error is received, it is emitted through the Mono.
  - kick
```
public Mono<Void> kick(Snowflake userId)
```
    Requests to kick the specified user from this guild.
    
    Parameters:
    
    userId - The ID of the user to kick from this guild.
    
    Returns:
    
    A Mono where, upon successful completion, emits nothing; indicating the specified user was kicked from this guild. If an error is received, it is emitted through the Mono.
  - kick
```
public Mono<Void> kick(Snowflake userId,
                       @Nullable
                       String reason)
```
    Requests to kick the specified user from this guild while optionally specifying a reason.
    
    Parameters:
    
    userId - The ID of the user to kick from this guild.
    
    reason - The reason, if present.
    
    Returns:
    
    A Mono where, upon successful completion, emits nothing; indicating the specified user was kicked from this guild. If an error is received, it is emitted through the Mono.
  - getBans
```
public Flux<Ban> getBans()
```
    Requests to retrieve all the bans for this guild.
    
    Returns:
    
    A Flux that continually emits the bans for this guild. If an error is received, it is emitted through the Flux.
  - getBan
```
public Mono<Ban> getBan(Snowflake userId)
```
    Requests to retrieve the ban for the specified user for this guild.
    
    Parameters:
    
    userId - The ID of the user to retrieve the ban for this guild.
    
    Returns:
    
    A Mono where, upon successful completion, emits the ban for the specified user for this guild. If an error is received, it is meitted through the Mono.
  - ban
```
public Mono<Void> ban(Snowflake userId,
                      Consumer<? super BanQuerySpec> spec)
```
    Requests to ban the specified user.
    
    Parameters:
    
    userId - The ID of the user to ban.
    
    spec - A Consumer that provides a "blank" BanQuerySpec to be operated on.
    
    Returns:
    
    A Mono where, upon successful completion, emits nothing; indicating the specified user was banned. If an error is received, it is emitted through the Mono.
  - unban
```
public Mono<Void> unban(Snowflake userId)
```
    Requests to unban the specified user.
    
    Parameters:
    
    userId - The ID of the user to unban.
    
    Returns:
    
    A Mono where, upon successful completion, emits nothing; indicating the specified user was unbanned. If an error is received, it is emitted through the Mono.
  - unban
```
public Mono<Void> unban(Snowflake userId,
                        @Nullable
                        String reason)
```
    Requests to unban the specified user while optionally specifying a reason.
    
    Parameters:
    
    userId - The ID of the user to unban.
    
    reason - The reason, if present.
    
    Returns:
    
    A Mono where, upon successful completion, emits nothing; indicating the specified user was unbanned. If an error is received, it is emitted through the Mono.
  - getPruneCount
```
public Mono<Integer> getPruneCount(int days)
```
    Requests to retrieve the number of users that will be pruned. Users are pruned if they have not been seen within the past specified amount of days and are not assigned to any roles for this guild.
    
    Parameters:
    
    days - The number of days since an user must have been seen to avoid being kicked.
    
    Returns:
    
    A Mono where, upon successful completion, emits the number of users that will be pruned. If an error is received, it is emitted through the Mono.
  - getPruneCount
```
public Mono<Integer> getPruneCount(Consumer<? super GuildPruneCountSpec> spec)
```
    Requests to retrieve the number of users that will be pruned. Users are pruned if they have not been seen within the past specified amount of days, with roles optionally included in the prune count if specified through GuildPruneCountSpec.addRole(Snowflake) or GuildPruneCountSpec.addRoles(Collection).
    
    Parameters:
    
    spec - A Consumer that provides a "blank" GuildPruneCountSpec to be operated on.
    
    Returns:
    
    A Mono where, upon successful completion, emits the number of users that will be pruned. If an error is received, it is emitted through the Mono.
  - prune
```
public Mono<Integer> prune(int days)
```
    Requests to prune users. Users are pruned if they have not been seen within the past specified amount of days and are not assigned to any roles for this guild.
    
    Parameters:
    
    days - The number of days since an user must have been seen to avoid being kicked.
    
    Returns:
    
    A Mono where, upon successful completion, emits the number of users who were pruned. If an error is received, it is emitted through the Mono.
  - prune
```
public Mono<Integer> prune(int days,
                           @Nullable
                           String reason)
```
    Requests to prune users while optionally specifying a reason. Users are pruned if they have not been seen within the past specified amount of days and are not assigned to any roles for this guild.
    
    Parameters:
    
    days - The number of days since an user must have been seen to avoid being kicked.
    
    reason - The reason, if present.
    
    Returns:
    
    A Mono where, upon successful completion, emits the number of users who were pruned. If an error is received, it is emitted through the Mono.
  - prune
```
public Mono<Integer> prune(Consumer<? super GuildPruneSpec> spec)
```
    Requests to prune users while customizing parameters. Users are pruned if they have not been seen within the past specified amount of days, with roles optionally included in the prune request if specified through GuildPruneSpec.addRole(Snowflake) or GuildPruneSpec.addRoles(Collection).
    
    Parameters:
    
    spec - A Consumer that provides a "blank" GuildPruneSpec to be operated on.
    
    Returns:
    
    A Mono where, upon successful completion, may emit the number of users who were pruned if GuildPruneSpec.setComputePruneCount(boolean) is true (default), otherwise it would emit an empty Mono. If an error is received, it is emitted through the Mono.
  - leave
```
public Mono<Void> leave()
```
    Requests to leave this guild.
    
    Returns:
    
    A Mono where, upon successful completion, emits nothing; indicating this guild has been left. If an error is received, it is emitted through the Mono.
  - getAuditLog
```
public Flux<AuditLogEntry> getAuditLog()
```
    Requests to retrieve the audit log for this guild.
    
    Returns:
    
    A Flux that continually emits entries for this guild's audit log. If an error is received, it is emitted through the Flux.
  - getAuditLog
```
public Flux<AuditLogEntry> getAuditLog(Consumer<? super AuditLogQuerySpec> spec)
```
    Requests to retrieve the audit log for this guild.
    
    Parameters:
    
    spec - A Consumer that provides a "blank" AuditLogQuerySpec to be operated on.
    
    Returns:
    
    A Flux that continually emits entries for this guild's audit log. If an error is received, it is emitted through the Flux.
  - getWebhooks
```
public Flux<Webhook> getWebhooks()
```
    Requests to retrieve the webhooks of the guild.
    
    Returns:
    
    A Flux that continually emits the webhooks of the guild. If an error is received, it is emitted through the Flux.
  - getInvites
```
public Flux<ExtendedInvite> getInvites()
```
    Requests to retrieve the invites of the guild.
    
    Returns:
    
    A Flux that continually emits the invites of the guild. If an error is received, it is emitted through the Flux.
  - changeSelfNickname
```
public Mono<String> changeSelfNickname(@Nullable
                                       String nickname)
```
    Requests to change the bot user's nickname in this guild.
    
    Parameters:
    
    nickname - The new nickname for the bot user in this guild, or null to remove it.
    
    Returns:
    
    A Mono where, upon successful completion, emits the bot user's new nickname in this guild. If the nickname was set to null, then this Mono will complete empty. If an error is received, it is emitted through the Mono.
  - equals
```
public boolean equals(@Nullable
                      Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Guild

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Guild

Method Detail

getClient

getId

getName

getIconUrl

getIcon

getSplashUrl

getSplash

getDiscoverySplashUrl

getDiscoverySplash

getBannerUrl

getBanner

getOwnerId

getOwner

getRegionId

getRegion

getRegions

getAfkChannelId

getAfkChannel

getAfkChannel

getAfkTimeout

getEmbedChannelId

getEmbedChannel

getEmbedChannel

getPremiumTier

getPremiumSubscriptionCount

getPreferredLocale

getVerificationLevel

getNotificationLevel

getContentFilterLevel

getRoleIds

getRoles

getRoles

getRoleById

getRoleById

getEveryoneRole

getEveryoneRole

getEmojiIds

getEmojis

getEmojis

getGuildEmojiById

getGuildEmojiById

getFeatures

getMfaLevel

getApplicationId

isWidgetEnabled

getWidgetChannelId

getWidgetChannel

getWidgetChannel

getSystemChannelId

getSystemChannel

getSystemChannel

getSystemChannelFlags

getRulesChannelId

getRulesChannel

getRulesChannel

getPublicUpdatesChannelId

getPublicUpdatesChannel

getPublicUpdatesChannel

getMaxVideoChannelUsers

getJoinTime

isLarge

isUnavailable

isEmbedEnabled

getMemberCount

getVoiceStates

getMembers

getMembers

requestMembers

getMemberById

getMemberById

getSelfMember

getChannels