Implement invite targets #1628

anweisen · 2021-05-22T21:23:26Z

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: NaN

Description

This pr provides us with the functionality to create invites for applications and streams.
This allows us to use the discord together features.

The feature is currently only available in the desktop app and the web version.
The invites will show up as normal voice channel invites in the Android and iOS versions.

Examples

Embedded Applications

You can create an invite to an embedded application using

VoiceChannel channel = ...;
channel.createInvite()
    .setTargetApplication("755600276941176913") // Application id for youtuber together
    .queue();

There are currently only a few applications you can use, i listed all I currently know with their application id, so you can try them out yourself if you want:

YouTube Together: 755600276941176913, 880218832743055411
Poker: 755827207812677713
Betrayal.io: 773336526917861400
Fishington.io: 814288819477020702
Chess / CG 2 Dev: 832012586023256104, 832012774040141894
Awkword: 879863881349087252
Spellcast: 852509694341283871
Doodlecrew: 878067389634314250
Wordsnack: 879863976006127627
Lettertile: 879863686565621790

Stream Invites

You can create an invite to an user stream using

VoiceChannel channel = ...;
channel.createInvite()
    .setTargetStream(user) // You can use an User object or the id of the user here
    .queue();

The user to whose stream the invite goes must be streaming in the channel on which the invite is being created.

Invite Properties

This pr also adds the following properties with the following getters to an Invite object

getTargetType(): Invite.TargetType
getTargetApplication(): Invite.EmbeddedApplication
getTargetUser(): User

Andre601 · 2021-05-23T12:24:13Z

Is this an actual planned feature of Discord?
The docs don't show any PRs for it...

KxmischesDomi · 2021-05-23T12:52:30Z

Is this an actual planned feature of Discord?
The docs don't show any PRs for it...

It is already implemented in the desktop app.
Look at this: https://www.reddit.com/r/discordapp/comments/jtnso2/social_party_games_on_discord/
There is still no way of creating these invites with the discord app.

anweisen · 2021-05-23T13:51:09Z

Is this an actual planned feature of Discord?
The docs don't show any PRs for it...

It is already implemented in the desktop app.
Look at this: https://www.reddit.com/r/discordapp/comments/jtnso2/social_party_games_on_discord/
There is still no way of creating these invites with the discord app.

The corresponding properties of the invite object and in the creation request are already in the docs

Sanduhr32 · 2021-05-23T13:55:51Z

Question: Why do you used boxed longs instead of native once?

anweisen · 2021-05-23T13:58:38Z

Question: Why do you used boxed longs instead of native once?

I thought it would be better to use them as they can be null and this property is not required
They were also used for other properties which are not required like maxAge and maxUses

RedDaedalus · 2021-05-23T22:00:11Z

Is this an actual planned feature of Discord?
The docs don't show any PRs for it...

This is also enabled on the official Poker Night server.

DV8FromTheWorld · 2021-05-25T05:29:53Z

JDA only implements features exposed in the discord public documentation. If this feature gets documented there then we can revisit this.

Setting this PR on freezer until then.

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

src/main/java/net/dv8tion/jda/api/requests/restaction/InviteAction.java

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

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

src/main/java/net/dv8tion/jda/internal/handle/InviteCreateHandler.java

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

src/main/java/net/dv8tion/jda/api/requests/restaction/InviteAction.java

DV8FromTheWorld

I'm definitely nervous about this API.
All of these setters implicitly set the TargetType based on tangentially related data passed in.

What happens when discord adds a TargetType 3 that also only needs a user?

Feels like something like setTarget(Target.STREAM.of(User)) and setTarget(Target.EMBEDDED_APPLICATION.of(long)) would be more likely to work further into the future.

Note: I don't like the above proposed builders, they were purely for example purposes. The point was the explicit targetting instead of the implicit targeting via tangential information

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

DV8FromTheWorld · 2021-06-14T14:13:15Z

src/main/java/net/dv8tion/jda/internal/handle/InviteCreateHandler.java

+        case STREAM:
+            DataObject targetUserObject = content.getObject("target_user");
+            targetUser = getJDA().getEntityBuilder().createUser(targetUserObject);
+            application = null;
+            break;
+        case EMBEDDED_APPLICATION:
+            DataObject applicationObject = content.getObject("target_application");
+            application = new InviteImpl.EmbeddedApplicationImpl(
+                    applicationObject.getString("icon", null), applicationObject.getString("name"), applicationObject.getString("description"),
+                    applicationObject.getString("summary"), applicationObject.getLong("id"), applicationObject.getInt("max_participants", -1)
+            );
+            targetUser = null;
+            break;
+        default:
+            application = null;
+            targetUser = null;


Suggested change

case STREAM:

DataObject targetUserObject = content.getObject("target_user");

targetUser = getJDA().getEntityBuilder().createUser(targetUserObject);

application = null;

break;

case EMBEDDED_APPLICATION:

DataObject applicationObject = content.getObject("target_application");

application = new InviteImpl.EmbeddedApplicationImpl(

applicationObject.getString("icon", null), applicationObject.getString("name"), applicationObject.getString("description"),

applicationObject.getString("summary"), applicationObject.getLong("id"), applicationObject.getInt("max_participants", -1)

);

targetUser = null;

break;

default:

application = null;

targetUser = null;

case STREAM:

DataObject targetUserObject = content.getObject("target_user");

targetUser = getJDA().getEntityBuilder().createUser(targetUserObject);

application = null;

break;

case EMBEDDED_APPLICATION:

DataObject applicationObject = content.getObject("target_application");

application = new InviteImpl.EmbeddedApplicationImpl(

applicationObject.getString("icon", null), applicationObject.getString("name"), applicationObject.getString("description"),

applicationObject.getString("summary"), applicationObject.getLong("id"), applicationObject.getInt("max_participants", -1)

);

targetUser = null;

break;

default:

application = null;

targetUser = null;

I didn't indent these cases as they weren't indented in other switches I saw (eg in the EntityBuilder class) and the indent for them are set to false in the editorconfig. Does it make sense to indent them?

anweisen · 2021-06-15T15:02:02Z

I'm definitely nervous about this API.
All of these setters implicitly set the TargetType based on tangentially related data passed in.

What happens when discord adds a TargetType 3 that also only needs a user?

Feels like something like setTarget(Target.STREAM.of(User)) and setTarget(Target.EMBEDDED_APPLICATION.of(long)) would be more likely to work further into the future.

Note: I don't like the above proposed builders, they were purely for example purposes. The point was the explicit targetting instead of the implicit targeting via tangential information

Maybe it would be better to use it like this:
setTargetType(TargetType.STREAM)
setTargetUser(user)

setTargetUser will then not set the target type to STREAM, so it has to be done by hand.
This would allows us to integrate a new type which uses the same setters.
But this approach is not ideal because you don't really know what you should/can set and what is for other target types.

Requested by DV8FromTheWorld Co-authored-by: Austin Keener <keeneraustin@yahoo.com>

MinnDevelopment · 2021-06-15T15:55:52Z

I think it's ok the way it is now, if in the future new target types get introduced we could add an overload that accepts a target type parameter. Currently, this is not needed since you can only have one target type per user/application anyway.

carstendachsbacher · 2021-08-14T20:15:17Z

Any updates on this? I would love to use this feature

Xirado · 2021-08-27T12:32:49Z

Any updates on this? I would love to use this feature

@carstendachsbacher In the meantime you can use something like this
https://github.com/Xirado/HTLDiscordBot/blob/master/src/main/java/at/Xirado/htl/bot/commands/VoiceTargetCommand.java#L38

MinnDevelopment

I think we can merge this. @DV8FromTheWorld any reason to still hold this up?

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

DV8FromTheWorld

Some questions

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

DV8FromTheWorld · 2021-09-05T18:09:12Z

After all this time I still don't think that having setTargetApplication and setTargetUser and their respective getters are the correct move.

setTarget(InviteTarget.APPLICATION.fromId(...)) and getTarget().getType/getUser/getApplication seems better.

Theres also nothing that indicates to the users that .setTargetUser(...).setTargetApplication(...) is wrong.

Xirado · 2021-09-21T15:42:49Z

~~It seems like Discord removed the ability to use these applications. The invite link is no longer clickable.~~

My mistake

MinnDevelopment · 2021-09-21T16:10:44Z

@Xirado works for me

Xirado · 2021-09-21T16:13:01Z

~~@MinnDevelopment Very weird. Maybe it's just my client? Me and my friends can't click the invite link even though it says Poker below it~~

My mistake

MinnDevelopment

Sorry for the delay. We spoke internally and came up with some changes that should hopefully be acceptable to everyone.

src/main/java/net/dv8tion/jda/api/requests/restaction/InviteAction.java

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

MinnDevelopment

Just a few more points, and then it should be ready to go

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

MinnDevelopment · 2021-10-23T15:07:35Z

One thing I forgot, please also add Invite#getTargetType so you can use it in a switch without a null-check.

MinnDevelopment

Thanks for your efforts! LGTM

DManstrator · 2021-10-23T19:06:10Z

There are currently only a few applications you can use, i listed all I currently know with their application id, so you can try them out yourself if you want:

YouTube Together: 755600276941176913
Poker: 755827207812677713
Betrayal.io: 773336526917861400
Fishington.io: 814288819477020702
Chess / CG 2 Dev: 832012586023256104

How about creating an enum for that and allow it as a parameter for setTargetApplication for a better usability?

MinnDevelopment · 2021-10-23T19:10:25Z

@DManstrator we don't want to provide an enum for undocumented and potentially temporary applications. If more applications exist in the future, we don't want to curate such a list either.

DManstrator · 2021-10-23T19:19:10Z

Didn't knew it was still undocumented, makes sense then not to have that enum. Thank you.

This reverts commit d2f3392.

Initial pass on discord together

e558de9

anweisen added 3 commits May 23, 2021 19:17

Implement invite properties

d45b648

Improve setting in InviteAction

5366d62

Improve comments

a29f8cc

anweisen marked this pull request as ready for review May 23, 2021 19:32

anweisen changed the title ~~Initial pass on discord together~~ Implement invite targets May 24, 2021

DV8FromTheWorld added the status: freezer this is currently put on hold label May 25, 2021

MinnDevelopment added the type: feature label Jun 12, 2021

MinnDevelopment reviewed Jun 12, 2021

View reviewed changes

MinnDevelopment added size: small and removed status: freezer this is currently put on hold labels Jun 12, 2021

jan-tennert reviewed Jun 13, 2021

View reviewed changes

src/main/java/net/dv8tion/jda/api/entities/Invite.java Outdated Show resolved Hide resolved

anweisen added 2 commits June 13, 2021 14:05

Use switch instead of else if

873f4fb

Add missing docs & Remove redundant methods

ba583db

MinnDevelopment reviewed Jun 13, 2021

View reviewed changes

src/main/java/net/dv8tion/jda/api/requests/restaction/InviteAction.java Outdated Show resolved Hide resolved

Change TargetType to EMBEDDED_APPLICATION in comment

c5b2999

MinnDevelopment requested changes Jun 14, 2021

View reviewed changes

Fix some formatting

03b6157

MinnDevelopment approved these changes Jun 14, 2021

View reviewed changes

DV8FromTheWorld requested changes Jun 14, 2021

View reviewed changes

Fix typo

191cbaa

Requested by DV8FromTheWorld Co-authored-by: Austin Keener <keeneraustin@yahoo.com>

anweisen requested a review from DV8FromTheWorld June 20, 2021 11:07

MinnDevelopment approved these changes Sep 5, 2021

View reviewed changes

src/main/java/net/dv8tion/jda/api/entities/Invite.java Outdated Show resolved Hide resolved

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

9bf29ff

DV8FromTheWorld reviewed Sep 5, 2021

View reviewed changes

src/main/java/net/dv8tion/jda/api/entities/Invite.java Outdated Show resolved Hide resolved

src/main/java/net/dv8tion/jda/api/entities/Invite.java Outdated Show resolved Hide resolved

DV8FromTheWorld added the Required for v4 LTS defines that something is slated for inclusion in the final v4 LTS builds label Sep 19, 2021

MinnDevelopment requested changes Oct 8, 2021

View reviewed changes

anweisen added 2 commits October 9, 2021 16:30

Apply review

6ad84fa

Introduce InviteTarget object

124ec91

DV8FromTheWorld requested changes Oct 23, 2021

View reviewed changes

src/main/java/net/dv8tion/jda/internal/entities/EntityBuilder.java Show resolved Hide resolved

Use null instead of none target

c14bc48

MinnDevelopment requested changes Oct 23, 2021

View reviewed changes

Apply review

09757e8

MinnDevelopment approved these changes Oct 23, 2021

View reviewed changes

DV8FromTheWorld approved these changes Oct 23, 2021

View reviewed changes

DV8FromTheWorld merged commit d2f3392 into discord-jda:development Oct 23, 2021

aasmart added a commit to aasmart/JDA that referenced this pull request Oct 25, 2021

Revert "Implement invite targets (discord-jda#1628)"

2a7b44f

This reverts commit d2f3392.

Korwai mentioned this pull request Jul 27, 2022

Update VC activities command with new activities Together-Java/TJ-Bot#378

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement invite targets #1628

Implement invite targets #1628

anweisen commented May 22, 2021 •

edited

Loading

Andre601 commented May 23, 2021

KxmischesDomi commented May 23, 2021

anweisen commented May 23, 2021 •

edited

Loading

Sanduhr32 commented May 23, 2021

anweisen commented May 23, 2021 •

edited

Loading

RedDaedalus commented May 23, 2021

DV8FromTheWorld commented May 25, 2021

DV8FromTheWorld left a comment

DV8FromTheWorld Jun 14, 2021

anweisen Jun 15, 2021 •

edited

Loading

anweisen commented Jun 15, 2021

MinnDevelopment commented Jun 15, 2021

carstendachsbacher commented Aug 14, 2021

Xirado commented Aug 27, 2021

MinnDevelopment left a comment

DV8FromTheWorld left a comment

DV8FromTheWorld commented Sep 5, 2021

Xirado commented Sep 21, 2021 •

edited

Loading

MinnDevelopment commented Sep 21, 2021

Xirado commented Sep 21, 2021 •

edited

Loading

MinnDevelopment left a comment

MinnDevelopment left a comment

MinnDevelopment commented Oct 23, 2021

MinnDevelopment left a comment

DManstrator commented Oct 23, 2021

MinnDevelopment commented Oct 23, 2021

DManstrator commented Oct 23, 2021

Implement invite targets #1628

Implement invite targets #1628

Conversation

anweisen commented May 22, 2021 • edited Loading

Pull Request Etiquette

Changes

Description

Examples

Embedded Applications

Stream Invites

Invite Properties

Andre601 commented May 23, 2021

KxmischesDomi commented May 23, 2021

anweisen commented May 23, 2021 • edited Loading

Sanduhr32 commented May 23, 2021

anweisen commented May 23, 2021 • edited Loading

RedDaedalus commented May 23, 2021

DV8FromTheWorld commented May 25, 2021

DV8FromTheWorld left a comment

Choose a reason for hiding this comment

DV8FromTheWorld Jun 14, 2021

Choose a reason for hiding this comment

anweisen Jun 15, 2021 • edited Loading

Choose a reason for hiding this comment

anweisen commented Jun 15, 2021

MinnDevelopment commented Jun 15, 2021

carstendachsbacher commented Aug 14, 2021

Xirado commented Aug 27, 2021

MinnDevelopment left a comment

Choose a reason for hiding this comment

DV8FromTheWorld left a comment

Choose a reason for hiding this comment

DV8FromTheWorld commented Sep 5, 2021

Xirado commented Sep 21, 2021 • edited Loading

MinnDevelopment commented Sep 21, 2021

Xirado commented Sep 21, 2021 • edited Loading

MinnDevelopment left a comment

Choose a reason for hiding this comment

MinnDevelopment left a comment

Choose a reason for hiding this comment

MinnDevelopment commented Oct 23, 2021

MinnDevelopment left a comment

Choose a reason for hiding this comment

DManstrator commented Oct 23, 2021

MinnDevelopment commented Oct 23, 2021

DManstrator commented Oct 23, 2021

anweisen commented May 22, 2021 •

edited

Loading

anweisen commented May 23, 2021 •

edited

Loading

anweisen commented May 23, 2021 •

edited

Loading

anweisen Jun 15, 2021 •

edited

Loading

Xirado commented Sep 21, 2021 •

edited

Loading

Xirado commented Sep 21, 2021 •

edited

Loading