Package net.dv8tion.jda.core.entities

Interface Invite.Guild

All Superinterfaces:

ISnowflake

Enclosing interface:

Invite

public static interface Invite.Guild
extends ISnowflake

POJO for the guild information provided by an invite.

See Also:

Invite.getGuild()

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.lang.String>	getFeatures()	The Features of the Guild.
java.lang.String	getIconId()	The icon id of this guild.
java.lang.String	getIconUrl()	The icon url of this guild.
int	getMemberCount()	Returns the approximate count of total members in the guild.
java.lang.String	getName()	The name of this guild.
int	getOnlineCount()	Returns the approximate count of online members in the guild.
java.lang.String	getSplashId()	The splash image id of this guild.
java.lang.String	getSplashUrl()	Returns the splash image url of this guild.
Guild.VerificationLevel	getVerificationLevel()	Returns the VerificationLevel of this guild.

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

getCreationTime, getId, getIdLong

Method Detail

getIconId

java.lang.String getIconId()

The icon id of this guild.

Returns:

The guild's icon id

See Also:

getIconUrl()

getIconUrl

java.lang.String getIconUrl()

The icon url of this guild.

Returns:

The guild's icon url

See Also:

getIconId()

getName

java.lang.String getName()

The name of this guild.

Returns:

The guilds's name

getSplashId

java.lang.String getSplashId()

The splash image id of this guild.

Returns:

The guild's splash image id or null if the guild has no splash image

See Also:

getSplashUrl()

getSplashUrl

java.lang.String getSplashUrl()

Returns the splash image url of this guild.

Returns:

The guild's splash image url or null if the guild has no splash image

See Also:

getSplashId()

getVerificationLevel

Guild.VerificationLevel getVerificationLevel()

Returns the VerificationLevel of this guild.

Returns:

the verification level of the guild

getOnlineCount

int getOnlineCount()

Returns the approximate count of online members in the guild. If the online member count was not included in the invite, this will return -1. Counts will usually only be returned when resolving the invite via the Invite.resolve() method with the withCounts boolean set to true

Returns:

the approximate count of online members in the guild, or -1 if not present in the invite

getMemberCount

int getMemberCount()

Returns the approximate count of total members in the guild. If the total member count was not included in the invite, this will return -1. Counts will usually only be returned when resolving the invite via the Invite.resolve() method with the withCounts boolean set to true

Returns:

the approximate count of total members in the guild, or -1 if not present in the invite

getFeatures

java.util.Set<java.lang.String> getFeatures()

The Features of the Guild.

Possible known features:

• VIP_REGIONS - Guild has VIP voice regions
• VANITY_URL - Guild a vanity URL (custom invite link)
• INVITE_SPLASH - Guild has custom invite splash. See getSplashId() and getSplashUrl()
• VERIFIED - Guild is "verified"
• MORE_EMOJI - Guild is able to use more than 50 emoji

Returns:

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