Package net.dv8tion.jda.api.entities
Interface GuildWelcomeScreen
public interface GuildWelcomeScreen
The welcome screen of a
Guild.
This welcome screen will be shown to all members after joining the Guild.-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfacePOJO for the recommended channels information provided by a welcome screen. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe maximum length of a welcome screen description (140)static final intThe maximum amount of welcome channel a welcome screen can show (5) -
Method Summary
-
Field Details
-
MAX_DESCRIPTION_LENGTH
static final int MAX_DESCRIPTION_LENGTHThe maximum length of a welcome screen description (140)- See Also:
-
MAX_WELCOME_CHANNELS
static final int MAX_WELCOME_CHANNELSThe maximum amount of welcome channel a welcome screen can show (5)- See Also:
-
-
Method Details
-
getGuild
- Returns:
- The Guild, or
null
-
getManager
Returns theManagerfor this guild's welcome screen.- Returns:
- The GuildWelcomeScreenManager for this guild's welcome screen
- Throws:
InsufficientPermissionException- If the currently logged in account does not havePermission.MANAGE_SERVERIllegalStateException- If welcome screen came from anInvite- See Also:
-
getDescription
The server description shown in the welcome screen.
This will benullif the welcome screen has no description.- Returns:
- The server description shown in the welcome screen or
null
-
getChannels
The channels shown in the welcome screen.- Returns:
- Possibly-empty, unmodifiable list of the channels shown in the welcome screen
-