Document RPC over IPC#8246
Conversation
markmandel
left a comment
markmandel
left a comment
There was a problem hiding this comment.
Having a play with this - going to check a few more things on our end, but overall looking good to me, other than the one item I found.
There was a problem hiding this comment.
So I learned new things going through all this! I have some IPC commands working!
Lots of events to remove from the list (see comments) - but some to keep, but we don't have reference for them in this current PR.
@advaith1 WDYT? remove the ones without references or keep them?
I'm almost tempted to keep them, and then either myself or @advaith1 can do a fast follow PR to add references once this one is merged.
How do we all feel?
| | ENTITLEMENT_CREATE | sent when a user purchases or receives a new entitlement (SKU/Game) | | ||
| | ENTITLEMENT_DELETE | sent when an entitlement is removed | |
There was a problem hiding this comment.
We don't have references for these. I believe they work, but haven't been able to test them.
Do we want to remove them for now, and come back around when someone is ready to write a reference for
ENTITLEMENT_CREATE and ENTITLEMENT_DELETE ?
@advaith1 we could probably add in the references for these in a fast follow in these docs though after this PR is merged?
|
|
||
| | Name | Description | | ||
| |------------------------------------------------------------------------------|-----------------------------------------------------------------| | ||
| | [DISPATCH](/developers/topics/rpc#commands-and-events-rpc-events) | event dispatch | |
There was a problem hiding this comment.
Any particular reason to remove all the anchor links? I don't have super strong opinions on this, but they seem handy to have.
There was a problem hiding this comment.
advaith1 said to remove them since they led to nowhere
There was a problem hiding this comment.
aaand it was before you changed the structure. So I can probably return it (or maybe I misunderstood something)
There was a problem hiding this comment.
The ones that don't have references to link to - definitely remove, but we could keep the ones that do point to existing links.
https://docs.discord.com/developers/topics/rpc#getchannels works for example (drops a little low, but better than not having) - so I'd advocate for putthing this back in -- they are handy.
There was a problem hiding this comment.
aaand it was before you changed the structure. So I can probably return it (or maybe I misunderstood something)
heh, yeah there was that too 😁
All good, easy enough to diff and put it back.
| | MESSAGE_DELETE | sent when a message is deleted in a subscribed text channel | | ||
| | NOTIFICATION_CREATE | sent when the client receives a notification (mention or new message in eligible channels) | | ||
| | ACTIVITY_JOIN | sent when the user clicks a Rich Presence join invite in chat to join a game | | ||
| | ACTIVITY_SPECTATE | sent when the user clicks a Rich Presence spectate invite in chat to spectate a game | |
There was a problem hiding this comment.
Also - this should work, but no reference for ACTIVITY_INVITE
|
If you are interesting (and write Rust), this is the test bed I was using: https://github.com/markmandel/discord-ipc-example |
|
If it makes things easier - for the items that don't have references, I'm happy to take on implementing that after this PR is done. So - I'm happy to merge with:
👍🏻 thanks for this work as well! |
Add anchor links and full dispatch data structure documentation for ACTIVITY_INVITE, CURRENT_USER_UPDATE, RELATIONSHIP_UPDATE, ENTITLEMENT_CREATE, and ENTITLEMENT_DELETE, which were added to the RPC Events table without reference sections. Also did some minor cleanup of text, and linked to the Social SDK. Continuation of work in #8246
Add anchor links and full dispatch data structure documentation for ACTIVITY_INVITE, CURRENT_USER_UPDATE, RELATIONSHIP_UPDATE, ENTITLEMENT_CREATE, and ENTITLEMENT_DELETE, which were added to the RPC Events table without reference sections. Also did some minor cleanup of text, and linked to the Social SDK. Continuation of work in #8246
Add anchor links and full dispatch data structure documentation for ACTIVITY_INVITE, CURRENT_USER_UPDATE, RELATIONSHIP_UPDATE, ENTITLEMENT_CREATE, and ENTITLEMENT_DELETE, which were added to the RPC Events table without reference sections. Also did some minor cleanup of text, and linked to the Social SDK. Continuation of work in #8246
* docs(rpc): add reference documentation for new IPC events Add anchor links and full dispatch data structure documentation for ACTIVITY_INVITE, CURRENT_USER_UPDATE, RELATIONSHIP_UPDATE, ENTITLEMENT_CREATE, and ENTITLEMENT_DELETE, which were added to the RPC Events table without reference sections. Also did some minor cleanup of text, and linked to the Social SDK. Continuation of work in #8246 * Added a changelog!
2 participants
I opened new PR, because of new codebase. I edited everything you commented and moved to mdx
@advaith1 #8087