Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document CURRENT_GUILD_MEMBER_UPDATE #7130

Merged
merged 4 commits into from
Jan 13, 2025
Merged

Document CURRENT_GUILD_MEMBER_UPDATE #7130

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7ec90f9
Document CURRENT_GUILD_MEMBER_UPDATE
Furnyr Sep 5, 2024
7ef6d87
Fix CURRENT_GUILD_MEMBER_UPDATE scopes
Furnyr Sep 6, 2024
08eb218
Fix color string
Furnyr Sep 6, 2024
c05d2a7
Document GuildMemberRPC
Furnyr Jan 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/developer_tools/Embedded_App_SDK.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down Expand Up @@ -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
Furnyr marked this conversation as resolved.
Show resolved Hide resolved

#### 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.
Expand Down Expand Up @@ -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 |
Expand Down
Loading