From 17e5cf0c2b61cc008a54122614aa11b1010abfd5 Mon Sep 17 00:00:00 2001 From: miaber Date: Mon, 12 May 2025 21:36:36 +0000 Subject: [PATCH 1/3] Address feedback --- docs/developer-tools/embedded-app-sdk.mdx | 96 ++++++++++++++++++++++- 1 file changed, 95 insertions(+), 1 deletion(-) diff --git a/docs/developer-tools/embedded-app-sdk.mdx b/docs/developer-tools/embedded-app-sdk.mdx index 164b01b8be..544c1c8078 100644 --- a/docs/developer-tools/embedded-app-sdk.mdx +++ b/docs/developer-tools/embedded-app-sdk.mdx @@ -167,6 +167,7 @@ Developers can use these commands to interact with the Discord client. The follo | [getEntitlements](/docs/developer-tools/embedded-app-sdk#getentitlements) | Returns a list of entitlements for the current user | | [getInstanceConnectedParticipants](/docs/developer-tools/embedded-app-sdk#getinstanceconnectedparticipants) | Returns all participants connected to the instance | | [getPlatformBehaviors](/docs/developer-tools/embedded-app-sdk#getplatformbehaviors) | Returns information about supported platform behaviors | +| [getRelationships](/docs/developer-tools/embedded-app-sdk#getrelationships) | Returns the current user's relationships | | [getSkus](/docs/developer-tools/embedded-app-sdk#getskus) | Returns a list of your app's SKUs | | [initiateImageUpload](/docs/developer-tools/embedded-app-sdk#initiateimageupload) | Presents the file upload flow in the Discord client | | [openExternalLink](/docs/developer-tools/embedded-app-sdk#openexternallink) | Allows for opening an external link from within the Discord client | @@ -455,6 +456,39 @@ await discordSdk.commands.getPlatformBehaviors(); --- + +### getRelationships() + +Returns the current user's relationships. + + +#### Supported Platforms +| Web | iOS | Android | +|-----|-----|---------| +| ✅ | ✅ | ✅ | + +#### Required Scopes + +- relationships.read + +:::info +Requires Discord approval +::: + +#### Signature + + +getRelationships(): Promise\<[GetRelationshipsResponse](/docs/developer-tools/embedded-app-sdk#getrelationshipsresponse)\> + + +#### Usage + +```js +await discordSdk.commands.getRelationships(); +``` + +--- + ### getSkus() Returns a list of SKU objects. SKUs without prices are automatically filtered out. @@ -795,9 +829,9 @@ Developers may use the following events alongside the `subscribe()` SDK method t | [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 | +| [RELATIONSHIP_UPDATE](/docs/developer-tools/embedded-app-sdk#relationshipupdate) | Received when a relationship of the current user is updated | | [ENTITLEMENT_CREATE](/docs/developer-tools/embedded-app-sdk#entitlementcreate) | Received when an entitlement is created for a SKU | - ### READY Non-subscription event sent immediately after connecting, contains server information. @@ -1054,6 +1088,41 @@ No scopes required --- +### RELATIONSHIP_UPDATE + +Received when a relationship of the current user is updated. + +#### Required Scopes + +- relationships.read + +:::info +Requires Discord approval +::: + +#### Sample Event Payload +```javascript +{ + "type": 1, + "user": { + "id": "7173771622812225536", + "username": "beef_supreme", + "discriminator": "0", + "global_name": "Dis Cord", + "avatar": "abcdefg", + "avatar_decoration_data": { + "asset": "abcdefg", + "sku_id": "123456789" + }, + "bot": false, + "flags": 1, + "premium_type": 2 + } +} +``` + +--- + ### ENTITLEMENT_CREATE :::preview @@ -1302,6 +1371,12 @@ Coming soon! Not available during Developer Preview |-------------------------|---------| | iosKeyboardResizesView? | boolean | +#### GetRelationshipsResponse + +| Property | Type | +|---------------|-----------------------------------------------------------------------| +| relationships | [Relationship](/docs/developer-tools/embedded-app-sdk#relationship)[] | + #### GetSkusResponse | Property | Type | @@ -1438,6 +1513,13 @@ Coming soon! Not available during Developer Preview | me | boolean | | emoji | [Emoji](/docs/developer-tools/embedded-app-sdk#emoji) | +#### Relationship + +| Property | Type | +|----------|---------------------------------------------------------------------------------| +| type | [Relationship Types](/docs/developer-tools/embedded-app-sdk#relationship-types) | +| user | [User](/docs/developer-tools/embedded-app-sdk#user) | + #### Secrets | Property | Type | @@ -1690,3 +1772,15 @@ Coming soon! Not available during Developer Preview | CONSUMABLE | 3 | | BUNDLE | 4 | | SUBSCRIPTION | 5 | + +#### Relationship Types + +| Value | Name | Description | +|-------|------------------|--------------------------------------------------------------------------------------------------| +| 0 | None | The user has no relationship with the other user. | +| 1 | Friend | The user is friends with the other user. | +| 2 | Blocked | The current user has blocked the target user. | +| 3 | Pending Incoming | The current user has received a friend request from the target user, but it is not yet accepted. | +| 4 | Pending Outgoing | The current user has sent a friend request to the target user, but it is not yet accepted. | +| 5 | Implicit | The Implicit type is documented for visibility, but should be unused in the SDK. | +| 6 | Suggestion | The Suggestion type is documented for visibility, but should be unused in the SDK. | From 474182146e033d7fecc27270dc7c4be64a781041 Mon Sep 17 00:00:00 2001 From: miaber Date: Mon, 12 May 2025 21:41:55 +0000 Subject: [PATCH 2/3] cleanup --- docs/developer-tools/embedded-app-sdk.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/developer-tools/embedded-app-sdk.mdx b/docs/developer-tools/embedded-app-sdk.mdx index 544c1c8078..536f80eef1 100644 --- a/docs/developer-tools/embedded-app-sdk.mdx +++ b/docs/developer-tools/embedded-app-sdk.mdx @@ -832,6 +832,7 @@ Developers may use the following events alongside the `subscribe()` SDK method t | [RELATIONSHIP_UPDATE](/docs/developer-tools/embedded-app-sdk#relationshipupdate) | Received when a relationship of the current user is updated | | [ENTITLEMENT_CREATE](/docs/developer-tools/embedded-app-sdk#entitlementcreate) | Received when an entitlement is created for a SKU | + ### READY Non-subscription event sent immediately after connecting, contains server information. @@ -1517,7 +1518,7 @@ Coming soon! Not available during Developer Preview | Property | Type | |----------|---------------------------------------------------------------------------------| -| type | [Relationship Types](/docs/developer-tools/embedded-app-sdk#relationship-types) | +| type | [number](/docs/developer-tools/embedded-app-sdk#relationship-types) | | user | [User](/docs/developer-tools/embedded-app-sdk#user) | #### Secrets From 49c6104263d935948c8fea9aa5fc0b6f20bd98c0 Mon Sep 17 00:00:00 2001 From: miaber Date: Mon, 12 May 2025 21:46:05 +0000 Subject: [PATCH 3/3] format --- docs/developer-tools/embedded-app-sdk.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/developer-tools/embedded-app-sdk.mdx b/docs/developer-tools/embedded-app-sdk.mdx index 536f80eef1..c127d99903 100644 --- a/docs/developer-tools/embedded-app-sdk.mdx +++ b/docs/developer-tools/embedded-app-sdk.mdx @@ -1516,10 +1516,10 @@ Coming soon! Not available during Developer Preview #### Relationship -| Property | Type | -|----------|---------------------------------------------------------------------------------| +| Property | Type | +|----------|---------------------------------------------------------------------| | type | [number](/docs/developer-tools/embedded-app-sdk#relationship-types) | -| user | [User](/docs/developer-tools/embedded-app-sdk#user) | +| user | [User](/docs/developer-tools/embedded-app-sdk#user) | #### Secrets