Interface GuildWelcomeScreen

public interface GuildWelcomeScreen
The welcome screen of a Guild. This welcome screen will be shown to all members after joining the Guild.
See Also:

  • Field Details

    • MAX_DESCRIPTION_LENGTH

      static final int MAX_DESCRIPTION_LENGTH
      The maximum length of a welcome screen description (140)
      See Also:

    • MAX_WELCOME_CHANNELS

      static final int MAX_WELCOME_CHANNELS
      The maximum amount of welcome channel a welcome screen can show (5)
      See Also:

  • Method Details

    • getGuild

      @Nullable Guild getGuild()
      The Guild, or null if this welcome screen came from an Invite
      Returns:
      The Guild, or null

    • getManager

      @Nonnull @CheckReturnValue GuildWelcomeScreenManager getManager()
      Returns the Manager for this guild's welcome screen.
      Returns:
      The GuildWelcomeScreenManager for this guild's welcome screen
      Throws:
      InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_SERVER
      IllegalStateException - If welcome screen came from an Invite
      See Also:

    • getDescription

      @Nullable String getDescription()
      The server description shown in the welcome screen.
      This will be null if the welcome screen has no description.
      Returns:
      The server description shown in the welcome screen or null

    • getChannels

      @Nonnull List<GuildWelcomeScreen.Channel> getChannels()
      The channels shown in the welcome screen.
      Returns:
      Possibly-empty, unmodifiable list of the channels shown in the welcome screen