Add support for guild welcome screens #1989

mlnrDev · 2022-01-15T17:51:07Z

Pull Request Etiquette

I have checked the PRs for upcoming features/bug fixes.
I have read the contributing guidelines.

Changes

Internal code
Library interface (affecting end-user code)
Documentation
Other: _____

Closes Issue: #1987

Description

this PR adds support for Guild welcome screens. this currently doesn't support modifying the welcome screen as I'm still figuring out a good design.

mlnrDev · 2022-01-15T17:54:35Z

src/main/java/net/dv8tion/jda/api/entities/GuildWelcomeScreen.java

+         * @return The id of the emote that is used for this recommended channel or {@code null}
+         */
+        @Nullable
+        public String getEmoteId()


I'm not sure whether I should wrap this (while removing the getter below) into an Emoji object instead. The class constructor accepts the animated field which we can't know, but a recommended channel's emote can be animated.

We can't tell by the emote's id via something like a_ prefix or whatever?

no, the object only contains the emote id and name, not the hash

DV8FromTheWorld · 2022-02-04T06:02:41Z

src/main/java/net/dv8tion/jda/api/entities/Guild.java

+     *
+     * <p>Possible {@link net.dv8tion.jda.api.requests.ErrorResponse ErrorResponses} include:
+     * <ul>
+     *     <li>{@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_GUILD_WELCOME_SCREEN Unknown Guild Welcome Screen}


I wonder if we should convert this error into a null instead of forcing users to handle it as a user.

DV8FromTheWorld · 2022-02-04T06:04:34Z

src/main/java/net/dv8tion/jda/api/entities/GuildWelcomeScreen.java

+ * @see Guild#retrieveWelcomeScreen()
+ * @see Invite.Guild#getWelcomeScreen()
+ */
+public class GuildWelcomeScreen


This should have a getGuild getter

DV8FromTheWorld · 2022-02-04T06:05:29Z

src/main/java/net/dv8tion/jda/api/entities/GuildWelcomeScreen.java

+        @Nullable
+        public BaseGuildMessageChannel getChannel()
+        {
+            return (BaseGuildMessageChannel) api.getGuildChannelById(id);


This is questionable as I could see ForumChannels being a recommendable channel in the future.

DV8FromTheWorld · 2022-02-04T06:06:33Z

src/main/java/net/dv8tion/jda/api/entities/GuildWelcomeScreen.java

+         * @return The id of the emote that is used for this recommended channel or {@code null}
+         */
+        @Nullable
+        public String getEmoteId()


We can't tell by the emote's id via something like a_ prefix or whatever?

DV8FromTheWorld · 2022-02-04T06:07:40Z

src/main/java/net/dv8tion/jda/api/entities/GuildWelcomeScreen.java

+         * @return The name of the emoji that is used for this recommended channel or {@code null}
+         */
+        @Nullable
+        public String getEmojiName()


So this method can return a name or a unicode emoji? Yeah, not sure how to feel about that representation given the method naming..

DV8FromTheWorld · 2022-02-04T06:08:29Z

src/main/java/net/dv8tion/jda/api/entities/Invite.java

+         * @return The welcome screen of this Guild or {@code null}
+         */
+        @Nullable
+        GuildWelcomeScreen getWelcomeScreen();


So all resolved invites have this information, but the Guild itself doesnt? Curious

exactly, you have to retrieve it yourself.

DV8FromTheWorld · 2022-02-04T06:09:40Z

src/main/java/net/dv8tion/jda/internal/entities/EntityBuilder.java

+            welcomeChannels.add(new GuildWelcomeScreen.Channel(api, welcomeChannelObj.getLong("channel_id"), welcomeChannelObj.getString("description"),
+                    welcomeChannelObj.getString("emoji_id", null), welcomeChannelObj.getString("emoji_name", null)));


Suggested change

welcomeChannels.add(new GuildWelcomeScreen.Channel(api, welcomeChannelObj.getLong("channel_id"), welcomeChannelObj.getString("description"),

welcomeChannelObj.getString("emoji_id", null), welcomeChannelObj.getString("emoji_name", null)));

welcomeChannels.add(new GuildWelcomeScreen.Channel(

api,

welcomeChannelObj.getLong("channel_id"),

welcomeChannelObj.getString("description"),

welcomeChannelObj.getString("emoji_id", null),

welcomeChannelObj.getString("emoji_name", null)

));

DV8FromTheWorld · 2022-02-04T06:12:58Z

We should probably include creation/mutation of GuildWelcomeScreens in this PR instead of providing only read-only access.

We can likely use a simple builder system like we do with EntityBuilder to build it up.

DV8FromTheWorld · 2022-02-05T06:01:09Z

Something else that I forgot to mention is that GuildWelcomeScreen should be inside Guild as Guild.WelcomeScreen.
This follows the pattern established by other constructs that make up the Guild itself.

mlnrDev · 2022-02-05T13:52:39Z

Something else that I forgot to mention is that GuildWelcomeScreen should be inside Guild as Guild.WelcomeScreen. This follows the pattern established by other constructs that make up the Guild itself.

it's intentionally in its own file because it has an inner Channel class, so I didn't want it to look like this: Guild.WelcomeScreen.Channel

DV8FromTheWorld · 2022-02-05T22:42:46Z

I don't personally see a problem with Guild.WelconeScreen.Channel.
The Guild.X classes represent constructs which are partials of a Guild's metadata. That metadata could be represented as Guild#getWelcomeScreenChannels, Guild#getWelcomeScreenDescription. We separate them only so that things logically make sense.

In contrast, something like GuildVoiceState or TextChannel are entities unto themselves. They are not metadata for the Guild.

Aseeef · 2022-04-27T03:15:20Z

Hey any updates on this one?

mlnrDev · 2022-04-27T11:51:39Z

Hey any updates on this one?

not right now, no. I won't have time for the next 2-3 weeks, so if someone wants to tackle this earlier, let me know.

Yashar256 · 2022-07-18T22:30:37Z

Yeah choosing a good design for modifying the welcome screen seems tricky. One possible design could be to have a welcome screen manager, with methods such as SortedSet<GuildWelcomeScreen.Channel> getWelcomeChannels() to see the order of the welcome screen channels while updating them, and methods such as void putChannelBeforeIndex(int index, GuildWelcomeScreen.Channel channel) and void putChannelAfterIndex(int index, GuildWelcomeScreen.Channel channel) to emulate the drag and drop ordering that people are used to in the client. And of course, more conventional methods for replacing a certain channel, removing a certain channel, etc.

MinnDevelopment · 2022-09-20T18:04:39Z

Closing due to inactivity. If anyone wants to continue this based on the current master branch, feel free to open a new PR.

mlnrDev added 2 commits January 15, 2022 18:31

add support for guild welcome screens (without a manager atm)

fb2a975

mention null in the return

e105707

mlnrDev commented Jan 15, 2022

View reviewed changes

mlnrDev added 8 commits January 15, 2022 19:06

add class level docs to GuildWelcomeScreen

6e5a089

add permission check for retrieving

e48bc80

add GuildWelcomeScreen.Channel#getChannel

82a17c4

fix compile error

8b5484a

mention nullability in GuildWelcomeScreen#getDescription

8e24310

remove the permission requirement

31ce56c

add a note about missing permission when the welcome screen is disabled

8e1478a

replace hasKey with isNull just to be safe

601bb1b

DV8FromTheWorld reviewed Feb 4, 2022

View reviewed changes

DV8FromTheWorld added the type: feature label Feb 4, 2022

MinnDevelopment closed this Sep 20, 2022

mlnrDev deleted the feature/welcome-screen branch September 20, 2022 18:08

freya022 added a commit to freya022/JDA that referenced this pull request Sep 27, 2022

Steal discord-jda#1989

c01b74c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for guild welcome screens #1989

Add support for guild welcome screens #1989

mlnrDev commented Jan 15, 2022 •

edited

mlnrDev Jan 15, 2022 •

edited

DV8FromTheWorld Feb 4, 2022

mlnrDev Feb 4, 2022

DV8FromTheWorld Feb 4, 2022

DV8FromTheWorld Feb 4, 2022

DV8FromTheWorld Feb 4, 2022

DV8FromTheWorld Feb 4, 2022

DV8FromTheWorld Feb 4, 2022

DV8FromTheWorld Feb 4, 2022

mlnrDev Feb 4, 2022

DV8FromTheWorld Feb 4, 2022

DV8FromTheWorld commented Feb 4, 2022

DV8FromTheWorld commented Feb 5, 2022

mlnrDev commented Feb 5, 2022 •

edited

DV8FromTheWorld commented Feb 5, 2022

Aseeef commented Apr 27, 2022

mlnrDev commented Apr 27, 2022

Yashar256 commented Jul 18, 2022

MinnDevelopment commented Sep 20, 2022

		welcomeChannels.add(new GuildWelcomeScreen.Channel(api, welcomeChannelObj.getLong("channel_id"), welcomeChannelObj.getString("description"),
		welcomeChannelObj.getString("emoji_id", null), welcomeChannelObj.getString("emoji_name", null)));

Add support for guild welcome screens #1989

Add support for guild welcome screens #1989

Conversation

mlnrDev commented Jan 15, 2022 • edited

Pull Request Etiquette

Changes

Description

mlnrDev Jan 15, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DV8FromTheWorld commented Feb 4, 2022

DV8FromTheWorld commented Feb 5, 2022

mlnrDev commented Feb 5, 2022 • edited

DV8FromTheWorld commented Feb 5, 2022

Aseeef commented Apr 27, 2022

mlnrDev commented Apr 27, 2022

Yashar256 commented Jul 18, 2022

MinnDevelopment commented Sep 20, 2022

mlnrDev commented Jan 15, 2022 •

edited

mlnrDev Jan 15, 2022 •

edited

mlnrDev commented Feb 5, 2022 •

edited