Welcome Screen

type

The welcome screen of a community guild, as it was when it was retrieved. It is a snapshot: edit it with a welcome screen builder, then retrieve it again.

3 syntaxesnet.dv8tion.jda.api.entities.GuildWelcomeScreen

3 / 3

Properties

propertyTextsince 5.0.0-a2

[the] description of %welcomescreen%

%welcomescreen%'s description

The description shown at the top of the welcome screen, if any.

Helpful?

propertylist of Welcome Channelsince 5.0.0-a2

[the] welcome channels of %welcomescreen%

%welcomescreen%'s welcome channels

The channels listed on the welcome screen (Discord allows at most 5).

Helpful?

propertyGuild since 5.0.0-a1

[the] guild of %welcomescreen%

%welcomescreen%'s guild

The guild a Discord entity belongs to: a member's, message's, role's, channel's, webhook's, sticker's, emoji's or scheduled event's guild. Co-owned across every such type, so "guild of %x%" works on any of them (null when the entity is not tied to a guild, e.g. a message from DMs).

Helpful?

Returned by

Syntaxes elsewhere in DiSky that return Welcome Screen.

[the] welcome screen of %guild%Guild