Package net.dv8tion.jda.api.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:

  • Method Details

    • getVanityCode

      @Nullable String getVanityCode()
      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.
      Returns:
      The vanity code or null
      See Also:

    • getVanityUrl

      @Nullable default String getVanityUrl()
      The vanity url for this Guild. The vanity url is the custom invite code of partnered / official / boosted Guilds.
      The returned String will be the vanity invite link to this guild.
      Returns:
      The vanity url or null

    • getBannerId

      @Nullable String getBannerId()
      The guild banner id.
      This is shown in guilds below the guild name.
      Returns:
      The guild banner id or null
      See Also:

    • getBannerUrl

      @Nullable default String getBannerUrl()
      The guild banner url.
      This is shown in guilds below the guild name.
      Returns:
      The guild banner url or null

    • getBanner

      @Nullable default ImageProxy getBanner()
      Returns an ImageProxy for this guild's banner image.
      Returns:
      Possibly-null ImageProxy of this guild's banner image
      See Also:

    • getDescription

      @Nullable String getDescription()
      The description for this guild.
      This is displayed in the server browser below the guild name for verified guilds, and in embedded invite links.
      Returns:
      The guild's description

    • getIconId

      @Nullable String getIconId()
      The icon id of this guild.
      Returns:
      The guild's icon id
      See Also:

    • getIconUrl

      @Nullable String getIconUrl()
      The icon url of this guild.
      Returns:
      The guild's icon url
      See Also:

    • getIcon

      @Nullable default ImageProxy getIcon()
      Returns an ImageProxy for this guild's icon
      Returns:
      Possibly-null ImageProxy of this guild's icon
      See Also:

    • getName

      @Nonnull String getName()
      The name of this guild.
      Returns:
      The guild's name

    • getSplashId

      @Nullable 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

      @Nullable 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:

    • getSplash

      @Nullable default ImageProxy getSplash()
      Returns an ImageProxy for this invite guild's splash image.
      Returns:
      Possibly-null ImageProxy of this invite guild's splash image
      See Also:

    • getVerificationLevel

      @Nonnull Guild.VerificationLevel getVerificationLevel()
      Returns the VerificationLevel of this guild.
      Returns:
      the verification level of the guild

    • getNSFWLevel

      @Nonnull Guild.NSFWLevel getNSFWLevel()
      Returns the Guild.NSFWLevel of this guild.
      Returns:
      the nsfw 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

      @Nonnull Set<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.

    • getWelcomeScreen

      @Nullable GuildWelcomeScreen getWelcomeScreen()
      The welcome screen of the Guild.
      This will be null if the Guild has no welcome screen, or if the invite came from a GuildInviteCreateEvent.
      Returns:
      The welcome screen of this Guild or null