Document CURRENT_GUILD_MEMBER_UPDATE (#7130)

* Document CURRENT_GUILD_MEMBER_UPDATE * Fix CURRENT_GUILD_MEMBER_UPDATE scopes Co-authored-by: advaith <[email protected]> * Fix color string * Document GuildMemberRPC --------- Co-authored-by: advaith <[email protected]>
discord · Jan 13, 2025 · 6525c03 · 6525c03
1 parent bf550ba
commit 6525c03
Showing 1 changed file with 39 additions and 0 deletions.
diff --git a/docs/developer_tools/Embedded_App_SDK.mdx b/docs/developer_tools/Embedded_App_SDK.mdx
@@ -793,6 +793,7 @@ Developers may use the following events alongside the `subscribe()` SDK method t
 | [ACTIVITY_LAYOUT_MODE_UPDATE](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/activitylayoutmodeupdate)                     | Received when a user changes the layout mode in the Discord client                        |
 | [ORIENTATION_UPDATE](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/orientationupdate)                                     | Received when screen orientation changes                                                  |
 | [CURRENT_USER_UPDATE](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/currentuserupdate)                                    | Received when the current user object changes                                             |
+| [CURRENT_GUILD_MEMBER_UPDATE](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/currentguildmemberupdate)                     | Received when the current guild member object changes                                     |
 | [THERMAL_STATE_UPDATE](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/thermalstateupdate)                                  | Received when Android or iOS thermal states are surfaced to the Discord app               |
 | [ACTIVITY_INSTANCE_PARTICIPANTS_UPDATE](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/activityinstanceparticipantsupdate) | Received when the number of instance participants changes                                 |
 | [ENTITLEMENT_CREATE](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/entitlementcreate)                                     | Received when an entitlement is created for a SKU                                         |
@@ -977,6 +978,33 @@ Received when the current user object changes.
 
 ---
 
+### CURRENT_GUILD_MEMBER_UPDATE
+
+Received when the current guild member object changes.
+
+#### Required Scopes
+
+- identify
+- guilds.members.read
+
+#### Sample Event Payload
+
+```javascript
+{
+  "user_id": "7173771622812225536",
+  "nick": "beef_supreme",
+  "guild_id": "613425648685547541"
+  "avatar": "abcdefg",
+  "avatar_decoration_data": {
+    "asset": "abcdefg",
+    "sku_id": "123456789"
+  },
+  "color_string": "#ffff00"
+}
+```
+
+---
+
 ### THERMAL_STATE_UPDATE
 
 Received when Android or iOS thermal states are surfaced to the Discord mobile app.
@@ -1292,6 +1320,17 @@ No scopes required
 | deaf      | boolean                                             |
 | mute      | boolean                                             |
 
+#### GuildMemberRPC
+
+| Property                | Type                                                                                        |
+|-------------------------|---------------------------------------------------------------------------------------------|
+| user_id                 | string                                                                                      |
+| nick?                   | string \| null                                                                              |
+| guild_id                | string                                                                                      |
+| avatar?                 | string \| null                                                                              |
+| avatar_decoration_data? | [AvatarDecorationData](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/avatardecorationdata) \| null |
+| color_string?           | string \| null                                                                              |
+
 #### Image
 
 | Property   | Type   |