Skip to content

add simple embedded app sdk shareLink docs #7339

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

Merged
merged 5 commits into from
Jan 10, 2025
Merged

add simple embedded app sdk shareLink docs #7339

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b3b6762
add simple embedded app sdk shareLink docs
afgiel Jan 10, 2025
df6e309
npm run fix:tables
afgiel Jan 10, 2025
84f1b3e
Update docs/developer_tools/Embedded_App_SDK.mdx
afgiel Jan 10, 2025
4093236
Update docs/developer_tools/Embedded_App_SDK.mdx
afgiel Jan 10, 2025
7b48745
Update docs/developer_tools/Embedded_App_SDK.mdx
afgiel Jan 10, 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
52 changes: 51 additions & 1 deletion docs/developer_tools/Embedded_App_SDK.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,7 @@ Developers can use these commands to interact with the Discord client. The follo
| [setActivity](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/setactivity) | Modifies how your activity's rich presence is displayed in the Discord client |
| [setConfig](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/setconfig) | Set whether or not the PIP (picture-in-picture) is interactive |
| [setOrientationLockState](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/setorientationlockstate) | Set options for orientation and picture-in-picture (PIP) modes |
| [shareLink](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/sharelink) | Presents a modal for the user to share a link to your activity with custom query params |
| [startPurchase](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/startpurchase) | Launches the purchase flow for a specific SKU, per the sku_id |
| [userSettingsGetLocale](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/usersettingsgetlocale) | Returns the current user's locale |

Expand Down Expand Up @@ -691,6 +692,41 @@ await discordSdk.commands.setOrientationLockState({

---


### shareLink()

Presents the user with a modal to share a link

#### Supported Platforms
| Web | iOS | Android |
|-----|-----|---------|
| ✅ | ⛔️ | ⛔️ |

#### Required Scopes

No scopes required

#### Signature

<Monospace>
shareLink(args: [ShareLinkRequest](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/sharelinkrequest)): Promise\<[ShareLinkResponse](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/sharelinkresponse)\>\<void\>
</Monospace>

#### Usage

```js
import {Common} from '@discord/embedded-app-sdk';

const { success } = await discordSdk.commands.shareLink({
message: 'This message is shared alongside the link!',
referrer_id: 'some_referrer_id',
custom_id: 'some_custom_id',
});
success ? console.log('User shared link!') : console.log('User did not share link!');
```

---

### startPurchase()

Launches the purchase flow for a specific SKU ID.
Expand Down Expand Up @@ -1398,6 +1434,20 @@ No scopes required
| picture_in_picture_lock_state | [OrientationLockState](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/orientationlockstatetypeobject) |
| grid_lock_state | [OrientationLockState](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/orientationlockstatetypeobject) |

#### ShareLinkRequest

| Property | Type |
|-------------|----------------|
| message | string \| null |
| referrer_id | string \| null |
| custom_id | string \| null |

#### ShareLinkResponse

| Property | Type |
|----------|---------|
| success | boolean |

#### Sku

| Property | Type |
Expand Down Expand Up @@ -1604,4 +1654,4 @@ No scopes required
| DLC | 2 |
| CONSUMABLE | 3 |
| BUNDLE | 4 |
| SUBSCRIPTION | 5 |
| SUBSCRIPTION | 5 |
Loading