diff --git a/docs/change-log/2025-07-17-clickable-links-and-customizable-statuses-in-rich-presence.md b/docs/change-log/2025-07-17-clickable-links-and-customizable-statuses-in-rich-presence.md new file mode 100644 index 0000000000..0df4f8869a --- /dev/null +++ b/docs/change-log/2025-07-17-clickable-links-and-customizable-statuses-in-rich-presence.md @@ -0,0 +1,13 @@ +--- +title: "Clickable Links and Customizable Statuses in Rich Presence" +date: "2025-07-17" +topics: +- "Activities" +- "Embedded App SDK" +--- + +We've added new functionality to Rich Presences to give users of your application a more interactive and flexible experience. There are two big changes as part of this: +- You can now add clickable links to the state text, details text, large image & small image +- You can now choose which field (name, state, or details) is used in users' status text in the member list (e.g. instead of "Listening to MyMusic" you can now have your status text show "Listening to Rick Astley") + +All of these new fields are documented on the [Activity Object](/docs/events/gateway-events#activity-object) section of Gateway Events and also available through the Embedded App SDK. \ No newline at end of file diff --git a/docs/components/reference.mdx b/docs/components/reference.mdx index dce78cf194..ce741398ea 100644 --- a/docs/components/reference.mdx +++ b/docs/components/reference.mdx @@ -146,7 +146,7 @@ Buttons must be placed inside an [Action Row](/docs/components/reference#action- | emoji? | partial [emoji](/docs/resources/emoji#emoji-object) | `name`, `id`, and `animated` | | custom_id | string | Developer-defined identifier for the button; max 100 characters | | sku_id? | snowflake | Identifier for a purchasable [SKU](/docs/resources/sku#sku-object), only available when using premium-style buttons | -| url? | string | URL for link-style buttons | +| url? | string | URL for link-style buttons; max 512 characters | | disabled? | boolean | Whether the button is disabled (defaults to `false`) | Buttons come in various styles to convey different types of actions. These styles also define what fields are valid for a button. @@ -924,7 +924,7 @@ To use this component, you need to send the [message flag](/docs/resources/messa "components": [ { "type": 10, - "content": "# This is a Text Display\nAll the regular markdown rules apply\n- You can make lists\n- You can use `code blocks`\n- You can use [links](http://watchanimeattheoffice.com/)\n- Even :blush: :star_struck: :exploding_head:\n- Spolier alert: ||these too!||" + "content": "# This is a Text Display\nAll the regular markdown rules apply\n- You can make lists\n- You can use `code blocks`\n- You can use [links](http://watchanimeattheoffice.com/)\n- Even :blush: :star_struck: :exploding_head:\n- Spoiler alert: ||these too!||" } ] } diff --git a/docs/developer-tools/embedded-app-sdk.mdx b/docs/developer-tools/embedded-app-sdk.mdx index c127d99903..2798ef9cd8 100644 --- a/docs/developer-tools/embedded-app-sdk.mdx +++ b/docs/developer-tools/embedded-app-sdk.mdx @@ -1143,7 +1143,9 @@ Coming soon! Not available during Developer Preview | timestamps? | [Timestamp](/docs/developer-tools/embedded-app-sdk#timestamp) \| null | | application_id? | string \| null | | details? | string \| null | +| details_url? | string \| null | | state? | string \| null | +| state_url? | string \| null | | emoji? | [Emoji](/docs/developer-tools/embedded-app-sdk#emoji) \| null | | party? | [Party](/docs/developer-tools/embedded-app-sdk#party) \| null | | assets? | [Assets](/docs/developer-tools/embedded-app-sdk#assets) \| null | @@ -1157,8 +1159,10 @@ Coming soon! Not available during Developer Preview |--------------|----------------| | large_image? | string \| null | | large_text? | string \| null | +| large_url? | string \| null | | small_image? | string \| null | | small_text? | string \| null | +| small_url? | string \| null | #### Application diff --git a/docs/discord-social-sdk/core-concepts.mdx b/docs/discord-social-sdk/core-concepts.mdx index 9554376a59..ad870e7d92 100644 --- a/docs/discord-social-sdk/core-concepts.mdx +++ b/docs/discord-social-sdk/core-concepts.mdx @@ -1,7 +1,12 @@ --- sidebar_label: Core Concepts +subpages: + - core-concepts/core-features.mdx + - core-concepts/communication-features.mdx + - core-concepts/integration-overview.mdx + - core-concepts/platform-compatibility.mdx + - core-concepts/oauth2-scopes.mdx --- -import ConsoleAccess from './partials/callouts/console-access.mdx'; [Home](/docs/intro) > [Discord Social SDK](/docs/discord-social-sdk/overview) > {sidebar_label} @@ -9,303 +14,47 @@ import ConsoleAccess from './partials/callouts/console-access.mdx'; The Discord Social SDK allows you to build social features into your game, including friend lists, messaging, voice chat, and rich presence. Unlike a traditional SDK with built-in UI components, the Discord Social SDK provides access to raw data, allowing developers to create a fully customized experience that aligns with their game's aesthetic. ---- +## Core Concepts Overview -## How the Discord Social SDK Works +Select a topic below to learn more about the Discord Social SDK: -### Integration Overview - -To implement the Discord Social SDK, developers for all platforms will generally follow these steps: - -1. Import the SDK -2. Initialize the SDK: - - Create a [`Client`] instance. - - Set up event listeners to monitor SDK events and callbacks -3. Authenticate users with flexible account options - - Link an existing Discord account via OAuth ([`Client::Authorize`]). - - Create and manage provisional accounts for users who don't have or want a Discord account ([`Client::GetProvisionalToken`]). -4. Implement social features - - Implement [unified friends list](/docs/discord-social-sdk/development-guides/creating-a-unified-friends-list) and [relationships](/docs/discord-social-sdk/development-guides/managing-relationships). - - Use [rich presence](/docs/discord-social-sdk/development-guides/setting-rich-presence) for game activity updates. - - Set up [lobbies](/docs/discord-social-sdk/development-guides/managing-lobbies) for multiplayer interaction and [game invites](/docs/discord-social-sdk/development-guides/managing-game-invites). - - Manage [direct message](/docs/discord-social-sdk/development-guides/sending-direct-messages), [linked channels](/docs/discord-social-sdk/development-guides/creating-a-unified-friends-list), and [voice communication](/docs/discord-social-sdk/development-guides/managing-voice-chat). -5. Handle events & API calls: - - Listen for changes in friend lists, presence updates, and chat messages. - - Use Discord's APIs to update statuses, send messages, and manage connections. - -This guide is a conceptual overview. If you're ready to start building, [follow our step-by-step guide](/docs/discord-social-sdk/getting-started) to set up the SDK in your game engine. - ---- - -## Limited Access Features - -The following features are only fully unlocked when joining the closed beta: - -- **Cross-platform messaging** allows users to message each other in-game and on Discord. -- **Voice chat integration** delivers excellent audio quality and lets you create individual user voice streams. -- **Linked Channels** provide persistent group chats that allow conversations to flow seamlessly before, during, and after gameplay—both in-game and out. - -While these limited access features are available in the Discord Social SDK, their usage is capped with a rate limit. Please read our [documentation on rate limits](/docs/topics/rate-limits) to learn more. - -:::preview -To apply for full access to closed beta features or to reach out to Discord directly to discuss your game, please fill out [this form](https://discord.com/developers/social-sdk-closed-beta-access-request-form). -::: - ---- - -## SDK Platform Compatibility - -:::info -You can find instructions on how to download the SDK for each platform in the [Getting Started](/docs/discord-social-sdk/getting-started) guide. -::: - -The Discord Social SDK is available for the following platforms: - -### Desktop - -- Standalone C++ (Windows and macOS) -- Unreal Engine (Windows Only) -- Unity (Windows and macOS) - -### Android/iOS (full mobile support & guides coming soon) - -- Standalone C++ -- Unity - -### Console (full console support & guides coming soon) - - -- **Xbox Series X|S and Xbox One** - - Standalone C++ - - Unreal Engine - - Unity -- **PlayStation5 and PlayStation4** - - Standalone C++ - - Unreal Engine - - Unity - - - ---- - -## OAuth2 Scopes - -OAuth2 scopes define the level of access your app has to a user's Discord account - -What OAuth scopes are available to your integration are set via -[`AuthorizationArgs::SetScopes`] on [`AuthorizationArgs`] which is passed to [`Client::Authorize`] on Social SDK -authentication. - -### Default Presence Scopes - -At a minimum, the Social SDK uses the following scopes to use features like rich presence and friends list: - -- `openid` -- `sdk.social_layer_presence` - -The default presence features include: - -* [Account Linking](/docs/discord-social-sdk/core-concepts#account-linking) -* [Provisional Accounts](/docs/discord-social-sdk/core-concepts#provisional-accounts) -* [Friend System & Relationships](/docs/discord-social-sdk/core-concepts#friend-system-relationships) -* [Presence & Rich Presence](/docs/discord-social-sdk/core-concepts#presence-rich-presence) - -The Social SDK provides the helper method [`Client::GetDefaultPresenceScopes`], which returns `openid sdk.social_layer_presence`, -that you can use when setting up your OAuth2 flow, for integrations that only need the above functionality. - -:::warn -With only the default presence scopes, your game will not be able to use any of the limited access -communications features. -::: - -### Default Communication Scopes - -The communications features are currently available but have limited access. Those features **require** the scope -of `sdk.social_layer`, which includes the `sdk.social_layer_presence` scope but also allows your app to use those limited features on behalf of the user. - -- `openid` -- `sdk.social_layer` - -These communication features include: -* [Messaging & Communication](/docs/discord-social-sdk/core-concepts#messaging-communication) -* [Lobbies & In-Game Chat](/docs/discord-social-sdk/core-concepts#lobbies-ingame-chat) -* [Linked Channels](/docs/discord-social-sdk/core-concepts#linked-channels) - -The Social SDK provides the helper method [`Client::GetDefaultCommunicationScopes`], which returns `openid sdk.social_layer`, -that you can use when setting up your OAuth2 flow, for integrations that integrates both the default and limited communications features. - -:::preview -For more information about these features, please see [Core Concepts: Limited Access Features](/docs/discord-social-sdk/core-concepts#limited-access-features). -::: - -If your game requires additional scopes, you can add them to the default scopes to authorize additional access from your users. - -You should only add scopes that are necessary for your game to function. Requesting unnecessary scopes can lead to user distrust and may result in users not linking their Discord account. - -See [available OAuth2 scopes](/docs/topics/oauth2#shared-resources-oauth2-scopes) available with the Discord API. - -### OAuth2 Client Types - -OAuth2 has two client types: **Public** and **Confidential**. Most games will not want to ship with **Public Client** enabled. - -Some Social SDK methods require your Discord application to be a **Public Client**. These methods also have server-side alternatives that you can use with a **Confidential Client**. - -- Public clients cannot securely store client secrets. -- Using confidential clients with proper secret management for production applications is generally recommended. -- Your security team should review this setting and authentication flows before releasing your game. - -[Learn more about OAuth2 client types](https://oauth.net/2/client-types) - ---- - -## Core Features - -The Discord Social SDK offers a range of features to enhance social interactions within games. Developers can leverage these features to create a more engaging and connected experience for players in their game. - -### Account Linking - -Account linking allows a game to authenticate users with their Discord credentials, gaining access to social features like friends, chat, and presence. This process uses OAuth2 authentication. - -| Development Guides | -|----------------------------------------------------------------------------------------------------------| -| [Account Linking with Discord](/docs/discord-social-sdk/development-guides/account-linking-with-discord) | -| [Account Linking on Consoles](/docs/discord-social-sdk/development-guides/account-linking-on-consoles) | - -| Design Guidelines | -|----------------------------------------------------------------------------------| -| [Signing in with Discord](/docs/discord-social-sdk/design-guidelines/signing-in) | -| [Consoles](/docs/discord-social-sdk/design-guidelines/consoles) | - -### Provisional Accounts - -Provisional accounts let players use social features in your game without linking a Discord account so all players can have a consistent gameplay experience. - -| Development Guides | -|------------------------------------------------------------------------------------------------------| -| [Using Provisional Accounts](/docs/discord-social-sdk/development-guides/using-provisional-accounts) | - -| Design Guidelines | -|-----------------------------------------------------------------------------------------| -| [Provisional Accounts](/docs/discord-social-sdk/design-guidelines/provisional-accounts) | - -### Friend System & Relationships - -The SDK models friendships and relationships in two ways: - -- Discord Friends: Persistent across all games. -- Game-Specific Friends: Limited to the current game. - -| Development Guides | -|----------------------------------------------------------------------------------------------------------------| -| [Creating a Unified Friends List](/docs/discord-social-sdk/development-guides/creating-a-unified-friends-list) | - -| Design Guidelines | -|-----------------------------------------------------------------------------------------| -| [Unified Friends List](/docs/discord-social-sdk/design-guidelines/provisional-accounts) | -| [Game Friends](/docs/discord-social-sdk/design-guidelines/game-friends) | - -### Messaging & Communication - -Users can communicate via direct messages (DMs) and voice calls: - -- DMs: One-on-one private chat ([`MessageHandle`]). -- Calls: Real-time voice communication inside a game lobby ([`Call`]). - -| Development Guides | -|------------------------------------------------------------------------------------------------| -| [Sending Direct Messages](/docs/discord-social-sdk/development-guides/sending-direct-messages) | -| [Managing Voice Chat](/docs/discord-social-sdk/development-guides/managing-voice-chat) | - -| Design Guidelines | -|-------------------------------------------------------------------------------| -| [Direct Messages](/docs/discord-social-sdk/design-guidelines/direct-messages) | - -### Presence & Rich Presence - -Presence refers to a user's online status, while Rich Presence provides game-specific activity data: - -- Displays if a user is online, idle, or offline. -- Shows detailed game stats (e.g., what level they're playing and time played). -- Allows users to send game invites through Discord and in-game. - -| Development Guides | -|--------------------------------------------------------------------------------------------| -| [Setting Rich Presence](/docs/discord-social-sdk/development-guides/setting-rich-presence) | - -| Design Guidelines | -|-------------------------------------------------------------------------------------------| -| [Status & Rich Presence](/docs/discord-social-sdk/design-guidelines/status-rich-presence) | - -### Lobbies & In-Game Chat - -A lobby is a virtual space where players can interact through voice and text chat. - -- Your game controls lobbies, which can have different membership rules. -- Integrated voice chat allows real-time communication among players in a session. - -| Development Guides | -|---------------------------------------------------------------------------------| -| [Manging Lobbies](/docs/discord-social-sdk/development-guides/managing-lobbies) | - -### Linked Channels - -Games can link in-game chat with Discord's server-based text channels in their UI, allowing players to chat in a Discord server without leaving the game. - -| Development Guides | -|--------------------------------------------------------------------------------| -| [Linked channels](/docs/discord-social-sdk/development-guides/linked-channels) | - -| Design Guidelines | -|-------------------------------------------------------------------------------| -| [Linked channels](/docs/discord-social-sdk/design-guidelines/linked-channels) | + + + Explore social features like account linking, friends, and rich presence. + + + Learn about messaging, voice chat, and in-game lobbies. + + + Learn about the integration overview and implementation steps. + + + See supported platforms and download information. + + + Understand OAuth2 scopes and client types for authentication. + + --- -## SDK Best Practices & Design Guidelines +## Next Steps -### Best Practices +After exploring these core concepts, you can start implementing the Discord Social SDK in your game: -- Optimize your authentication flow: Minimize disruptions during sign-in. -- Use event-driven updates: Listen for SDK status changes to ensure a responsive UI. -- Respect user privacy: Never send friend requests or messages without user consent. -- Design intuitive UI/UX: Ensure social features blend seamlessly with the gameplay. - -### Design Guidelines - -Check out the [Discord Social SDK Design Guidelines](/docs/discord-social-sdk/design-guidelines) for more best practices and common integration scenarios. - ---- - -## SDK & API Reference - -### Discord Social SDK - -Check out the full [Discord Social SDK Reference](https://discord.com/developers/docs/social-sdk/index.html) for reference details. - -For development guides on implementing specific features, refer to the [Discord Social SDK Development Guides](/docs/discord-social-sdk/development-guides). - -### Discord HTTP API - -When working with the Discord HTTP API directly from your game backend, developers can use the [Discord API Reference](/docs/reference) to see available endpoints and methods. - -Learn more about [Using the Discord HTTP API](/docs/discord-social-sdk/development-guides/using-with-discord-apis) with the Discord Social SDK. +- **Ready to integrate?** Follow our [Getting Started](/docs/discord-social-sdk/getting-started) guide for step-by-step setup instructions. +- **Need implementation details?** Check out the [Development Guides](/docs/discord-social-sdk/development-guides) for specific feature implementations. +- **Looking for UI guidance?** Review the [Design Guidelines](/docs/discord-social-sdk/design-guidelines) for best practices. --- ## Change Log -| Date | Changes | -|----------------|--------------------------| -| June 30, 2025 | restructure oauth scopes | -| March 17, 2025 | initial release | - -{/* Autogenerated Reference Links */} -[`AuthorizationArgs`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1AuthorizationArgs.html#adb47ac55258db29d4cb8a2c506093eed -[`AuthorizationArgs::SetScopes`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1AuthorizationArgs.html#aa3714d11a196e0d71c8c1cf38c506d92 -[`Call`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Call.html#a1cc8a7f73c15a960bc409d734b5edbd1 -[`Client`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#a91716140c699d8ef0bdf6bfd7ee0ae13 -[`Client::Authorize`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#ace94a58e27545a933d79db32b387a468 -[`Client::GetDefaultCommunicationScopes`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#a71499da752fbdc2d4326ae0fd36c0dd1 -[`Client::GetDefaultPresenceScopes`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#a7648bd1d2f7d9a86ebd0edb8bef12b5c -[`Client::GetProvisionalToken`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#a8003130b6c46e54ac68442483bf0480c -[`MessageHandle`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1MessageHandle.html#ae25595b43bc74b0c4c92c5165d16382f \ No newline at end of file +| Date | Changes | +|----------------|---------------------------| +| July 21, 2025 | restructure core concepts | +| June 30, 2025 | restructure oauth scopes | +| March 17, 2025 | initial release | \ No newline at end of file diff --git a/docs/discord-social-sdk/core-concepts/communication-features.mdx b/docs/discord-social-sdk/core-concepts/communication-features.mdx new file mode 100644 index 0000000000..8cccc74ca4 --- /dev/null +++ b/docs/discord-social-sdk/core-concepts/communication-features.mdx @@ -0,0 +1,94 @@ +--- +sidebar_label: Communication Features +--- + +[Home](/docs/intro) > [Discord Social SDK](/docs/discord-social-sdk/overview) > [Core Concepts](/docs/discord-social-sdk/core-concepts) > {sidebar_label} + +# Communication Features + +The Discord Social SDK provides powerful communication features to enhance player interaction in your game. +These features include messaging, voice chat, and in-game lobbies, allowing players to connect seamlessly. + +## Limited Access + +The following communication features are available to be used, but are only fully unlocked when joining the closed beta. + +:::preview +To apply for full access to closed beta features or to reach out to Discord directly to discuss your game, please fill out [this form](https://discord.com/developers/social-sdk-closed-beta-access-request-form). +::: + +Without full access, these features are available for development and testing, but they are not suitable for a +production environments as their usage is capped with a rate limit. Please read our +[documentation on rate limits](/docs/topics/rate-limits) to learn more. + +## Messaging & Communication + +Users can communicate via direct messages (DMs) and voice calls: + +- DMs: One-on-one private chat ([`MessageHandle`]). +- Calls: Real-time voice communication inside a game lobby ([`Call`]). + +| Development Guides | +|------------------------------------------------------------------------------------------------| +| [Sending Direct Messages](/docs/discord-social-sdk/development-guides/sending-direct-messages) | +| [Managing Voice Chat](/docs/discord-social-sdk/development-guides/managing-voice-chat) | + +| Design Guidelines | +|-------------------------------------------------------------------------------| +| [Direct Messages](/docs/discord-social-sdk/design-guidelines/direct-messages) | + +## Lobbies & In-Game Chat + +A lobby is a virtual space where players can interact through voice and text chat. + +- Your game controls lobbies, which can have different membership rules. +- Integrated voice chat allows real-time communication among players in a session. + +| Development Guides | +|---------------------------------------------------------------------------------| +| [Manging Lobbies](/docs/discord-social-sdk/development-guides/managing-lobbies) | + +## Linked Channels + +Games can link in-game chat with Discord's server-based text channels in their UI, allowing players to chat in a Discord server without leaving the game. + +| Development Guides | +|--------------------------------------------------------------------------------| +| [Linked channels](/docs/discord-social-sdk/development-guides/linked-channels) | + +| Design Guidelines | +|-------------------------------------------------------------------------------| +| [Linked channels](/docs/discord-social-sdk/design-guidelines/linked-channels) | + +--- + +## Next Steps + +Learn about integration steps, check platform support, and explore implementation guides: + + + + Learn about the integration overview and implementation steps. + + + See supported platforms and download information. + + + Learn how to implement messaging, voice chat, and linked channels. + + + +--- + +## Change Log + +| Date | Changes | +|---------------|-----------------| +| July 21, 2025 | initial release | + + +{/* Autogenerated Reference Links */} +[`Call`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Call.html#a1cc8a7f73c15a960bc409d734b5edbd1 +[`MessageHandle`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1MessageHandle.html#ae25595b43bc74b0c4c92c5165d16382f \ No newline at end of file diff --git a/docs/discord-social-sdk/core-concepts/core-features.mdx b/docs/discord-social-sdk/core-concepts/core-features.mdx new file mode 100644 index 0000000000..3f55af3497 --- /dev/null +++ b/docs/discord-social-sdk/core-concepts/core-features.mdx @@ -0,0 +1,96 @@ +--- +sidebar_label: Core Features +--- + +[Home](/docs/intro) > [Discord Social SDK](/docs/discord-social-sdk/overview) > [Core Concepts](/docs/discord-social-sdk/core-concepts) > {sidebar_label} + +# Core Features + +The Discord Social SDK offers a range of features to enhance social interactions within games. Developers can leverage these features to create a more engaging and connected experience for players in their game. + +## Account Linking + +Account linking allows a game to authenticate users with their Discord credentials, gaining access to social features like friends, chat, and presence. This process uses OAuth2 authentication. + +| Development Guides | +|----------------------------------------------------------------------------------------------------------| +| [Account Linking with Discord](/docs/discord-social-sdk/development-guides/account-linking-with-discord) | +| [Account Linking on Consoles](/docs/discord-social-sdk/development-guides/account-linking-on-consoles) | + +| Design Guidelines | +|----------------------------------------------------------------------------------| +| [Signing in with Discord](/docs/discord-social-sdk/design-guidelines/signing-in) | +| [Consoles](/docs/discord-social-sdk/design-guidelines/consoles) | + +## Provisional Accounts + +Provisional accounts let players use social features in your game without linking a Discord account so all players can have a consistent gameplay experience. + +| Development Guides | +|------------------------------------------------------------------------------------------------------| +| [Using Provisional Accounts](/docs/discord-social-sdk/development-guides/using-provisional-accounts) | + +| Design Guidelines | +|-----------------------------------------------------------------------------------------| +| [Provisional Accounts](/docs/discord-social-sdk/design-guidelines/provisional-accounts) | + +## Friend System & Relationships + +The SDK models friendships and relationships in two ways: + +- Discord Friends: Persistent across all games. +- Game-Specific Friends: Limited to the current game. + +| Development Guides | +|----------------------------------------------------------------------------------------------------------------| +| [Creating a Unified Friends List](/docs/discord-social-sdk/development-guides/creating-a-unified-friends-list) | + +| Design Guidelines | +|-----------------------------------------------------------------------------------------| +| [Unified Friends List](/docs/discord-social-sdk/design-guidelines/provisional-accounts) | +| [Game Friends](/docs/discord-social-sdk/design-guidelines/game-friends) | + +## Presence & Rich Presence + +Presence refers to a user's online status, while Rich Presence provides game-specific activity data: + +- Displays if a user is online, idle, or offline. +- Shows detailed game stats (e.g., what level they're playing and time played). +- Allows users to send game invites through Discord and in-game. + +| Development Guides | +|--------------------------------------------------------------------------------------------| +| [Setting Rich Presence](/docs/discord-social-sdk/development-guides/setting-rich-presence) | + +| Design Guidelines | +|-------------------------------------------------------------------------------------------| +| [Status & Rich Presence](/docs/discord-social-sdk/design-guidelines/status-rich-presence) | + + +--- + +## Next Steps + +Learn the implementation steps, configure authentication, and explore development guides: + + + + Learn about messaging, voice chat, and in-game lobbies. + + + Learn about the integration overview and implementation steps. + + + Step-by-step guides for implementing each social feature. + + + +--- + +## Change Log + +| Date | Changes | +|---------------|-----------------| +| July 21, 2025 | initial release | diff --git a/docs/discord-social-sdk/core-concepts/integration-overview.mdx b/docs/discord-social-sdk/core-concepts/integration-overview.mdx new file mode 100644 index 0000000000..5b1b25ba95 --- /dev/null +++ b/docs/discord-social-sdk/core-concepts/integration-overview.mdx @@ -0,0 +1,60 @@ +--- +sidebar_label: Integration Overview +--- + +[Home](/docs/intro) > [Discord Social SDK](/docs/discord-social-sdk/overview) > [Core Concepts](/docs/discord-social-sdk/core-concepts) > {sidebar_label} + +# Integration Overview + +To implement the Discord Social SDK, developers for all platforms will generally follow these steps: + +1. Import the SDK +2. Initialize the SDK: + - Create a [`Client`] instance. + - Set up event listeners to monitor SDK events and callbacks +3. Authenticate users with flexible account options + - Link an existing Discord account via OAuth ([`Client::Authorize`]). + - Create and manage provisional accounts for users who don't have or want a Discord account ([`Client::GetProvisionalToken`]). +4. Implement social features + - Implement [unified friends list](/docs/discord-social-sdk/development-guides/creating-a-unified-friends-list) and [relationships](/docs/discord-social-sdk/development-guides/managing-relationships). + - Use [rich presence](/docs/discord-social-sdk/development-guides/setting-rich-presence) for game activity updates. + - Set up [lobbies](/docs/discord-social-sdk/development-guides/managing-lobbies) for multiplayer interaction and [game invites](/docs/discord-social-sdk/development-guides/managing-game-invites). + - Manage [direct message](/docs/discord-social-sdk/development-guides/sending-direct-messages), [linked channels](/docs/discord-social-sdk/development-guides/creating-a-unified-friends-list), and [voice communication](/docs/discord-social-sdk/development-guides/managing-voice-chat). +5. Handle events & API calls: + - Listen for changes in friend lists, presence updates, and chat messages. + - Use Discord's APIs to update statuses, send messages, and manage connections. + +This guide is a conceptual overview. If you're ready to start building, [follow our step-by-step guide](/docs/discord-social-sdk/getting-started) to set up the SDK in your game engine. + +--- + +## Next Steps + +Check platform compatibility, explore communication features, and start your integration: + + + + See supported platforms and download information. + + + Learn about messaging, voice chat, and in-game lobbies. + + + Choose your platform and follow step-by-step setup instructions. + + + +--- + +## Change Log + +| Date | Changes | +|---------------|-----------------| +| July 21, 2025 | initial release | + +{/* Autogenerated Reference Links */} +[`Client`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#a91716140c699d8ef0bdf6bfd7ee0ae13 +[`Client::Authorize`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#ace94a58e27545a933d79db32b387a468 +[`Client::GetProvisionalToken`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#a8003130b6c46e54ac68442483bf0480c \ No newline at end of file diff --git a/docs/discord-social-sdk/core-concepts/oauth2-scopes.mdx b/docs/discord-social-sdk/core-concepts/oauth2-scopes.mdx new file mode 100644 index 0000000000..32a45f30c1 --- /dev/null +++ b/docs/discord-social-sdk/core-concepts/oauth2-scopes.mdx @@ -0,0 +1,107 @@ +--- +sidebar_label: OAuth2 Scopes +--- + +[Home](/docs/intro) > [Discord Social SDK](/docs/discord-social-sdk/overview) > [Core Concepts](/docs/discord-social-sdk/core-concepts) > {sidebar_label} + +# OAuth2 Scopes + +OAuth2 scopes define the level of access your app has to a user's Discord account + +What OAuth scopes are available to your integration are set via +[`AuthorizationArgs::SetScopes`] on [`AuthorizationArgs`] which is passed to [`Client::Authorize`] on Social SDK +authentication. + +## Default Presence Scopes + +At a minimum, the Social SDK uses the following scopes to use features like rich presence and friends list: + +- `openid` +- `sdk.social_layer_presence` + +The default presence features include: + +* [Account Linking](/docs/discord-social-sdk/core-concepts/core-features#account-linking) +* [Provisional Accounts](/docs/discord-social-sdk/core-concepts/core-features#provisional-accounts) +* [Friend System & Relationships](/docs/discord-social-sdk/core-concepts/core-features#friend-system-relationships) +* [Presence & Rich Presence](/docs/discord-social-sdk/core-concepts/core-features#presence-rich-presence) + +The Social SDK provides the helper method [`Client::GetDefaultPresenceScopes`], which returns `openid sdk.social_layer_presence`, +that you can use when setting up your OAuth2 flow, for integrations that only need the above functionality. + +:::warn +With only the default presence scopes, your game will not be able to use any of the limited access +communications features. +::: + +## Default Communication Scopes + +The communications features are currently available but have limited access. Those features **require** the scope +of `sdk.social_layer`, which includes the `sdk.social_layer_presence` scope but also allows your app to use those limited features on behalf of the user. + +- `openid` +- `sdk.social_layer` + +These communication features include: +* [Messaging & Communication](/docs/discord-social-sdk/core-concepts/communication-features#messaging-communication) +* [Lobbies & In-Game Chat](/docs/discord-social-sdk/core-concepts/communication-features#lobbies-ingame-chat) +* [Linked Channels](/docs/discord-social-sdk/core-concepts/communication-features#linked-channels) + +The Social SDK provides the helper method [`Client::GetDefaultCommunicationScopes`], which returns `openid sdk.social_layer`, +that you can use when setting up your OAuth2 flow, for integrations that integrates both the default and limited communications features. + +:::preview +For more information about these features, please see [Core Concepts: Communication Features](/docs/discord-social-sdk/core-concepts/communication-features). +::: + +If your game requires additional scopes, you can add them to the default scopes to authorize additional access from your users. + +You should only add scopes that are necessary for your game to function. Requesting unnecessary scopes can lead to user distrust and may result in users not linking their Discord account. + +See [available OAuth2 scopes](/docs/topics/oauth2#shared-resources-oauth2-scopes) available with the Discord API. + +## OAuth2 Client Types + +OAuth2 has two client types: **Public** and **Confidential**. Most games will not want to ship with **Public Client** enabled. + +Some Social SDK methods require your Discord application to be a **Public Client**. These methods also have server-side alternatives that you can use with a **Confidential Client**. + +- Public clients cannot securely store client secrets. +- Using confidential clients with proper secret management for production applications is generally recommended. +- Your security team should review this setting and authentication flows before releasing your game. + +[Learn more about OAuth2 client types](https://oauth.net/2/client-types) + +--- + +## Next Steps + +Start your integration, implement user authentication, and learn about UI design: + + + + Choose your platform and follow step-by-step setup instructions. + + + Implement user authentication with Discord OAuth2. + + + Learn how to design your game's UI to integrate social features. + + + +--- + +## Change Log + +| Date | Changes | +|---------------|-----------------| +| July 21, 2025 | initial release | + +{/* Autogenerated Reference Links */} +[`AuthorizationArgs`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1AuthorizationArgs.html#adb47ac55258db29d4cb8a2c506093eed +[`AuthorizationArgs::SetScopes`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1AuthorizationArgs.html#aa3714d11a196e0d71c8c1cf38c506d92 +[`Client::Authorize`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#ace94a58e27545a933d79db32b387a468 +[`Client::GetDefaultCommunicationScopes`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#a71499da752fbdc2d4326ae0fd36c0dd1 +[`Client::GetDefaultPresenceScopes`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#a7648bd1d2f7d9a86ebd0edb8bef12b5c \ No newline at end of file diff --git a/docs/discord-social-sdk/core-concepts/platform-compatibility.mdx b/docs/discord-social-sdk/core-concepts/platform-compatibility.mdx new file mode 100644 index 0000000000..cd0006cc99 --- /dev/null +++ b/docs/discord-social-sdk/core-concepts/platform-compatibility.mdx @@ -0,0 +1,64 @@ +--- +sidebar_label: Platform Compatibility +--- +import ConsoleAccess from '../partials/callouts/console-access.mdx'; + +[Home](/docs/intro) > [Discord Social SDK](/docs/discord-social-sdk/overview) > [Core Concepts](/docs/discord-social-sdk/core-concepts) > {sidebar_label} + +# Platform Compatibility + +:::info +You can find instructions on how to download the SDK for each platform in the [Getting Started](/docs/discord-social-sdk/getting-started) guide. +::: + +The Discord Social SDK is available for the following platforms: + +## Desktop + +- Standalone C++ (Windows and macOS) +- Unreal Engine (Windows Only) +- Unity (Windows and macOS) + +## Android/iOS (full mobile support & guides coming soon) + +- Standalone C++ +- Unity + +## Console (full console support & guides coming soon) + +- **Xbox Series X|S and Xbox One** + - Standalone C++ + - Unreal Engine + - Unity +- **PlayStation5 and PlayStation4** + - Standalone C++ + - Unreal Engine + - Unity + + + +--- + +## Next Steps + +Configure authentication, explore features, and get started with setup: + + + + Understand OAuth2 scopes and client types for authentication. + + + Explore social features like account linking, friends, and rich presence. + + + Platform-specific setup instructions and download links. + + + +--- + +## Change Log + +| Date | Changes | +|---------------|-----------------| +| July 21, 2025 | initial release | diff --git a/docs/discord-social-sdk/development-guides.mdx b/docs/discord-social-sdk/development-guides.mdx index fa875258a3..cecdf7c255 100644 --- a/docs/discord-social-sdk/development-guides.mdx +++ b/docs/discord-social-sdk/development-guides.mdx @@ -48,7 +48,7 @@ If you are new to the Discord Social SDK, we recommend you start with the [Getti Display detailed game status in Discord profiles. - Implement cross-platform game invites. + Allow players to invite friends to join their game session or party. diff --git a/docs/discord-social-sdk/development-guides/creating-a-unified-friends-list.mdx b/docs/discord-social-sdk/development-guides/creating-a-unified-friends-list.mdx index 3f6435e58d..2b95ae6957 100644 --- a/docs/discord-social-sdk/development-guides/creating-a-unified-friends-list.mdx +++ b/docs/discord-social-sdk/development-guides/creating-a-unified-friends-list.mdx @@ -25,13 +25,18 @@ Before you begin, make sure you have: ### Implementing a Unified Friends List -The Discord friend list is ultimately constructed from two entities: Relationships, and Users. You can query Relationships API to find everyone a user is a friend with, and the Users API to find the necessary extra information for rendering the list, such as whether they are online or not. +The Discord friend list is ultimately constructed from two entities: Relationships, and Users. You can query +Relationships API to find everyone a user is a friend with, and the Users API to find the necessary extra information +for rendering the list, such as whether they are online or not. ### Relationships -[Relationships](/docs/discord-social-sdk/development-guides/managing-relationships) are how Discord models friends, friend requests, and more. All relationships for the current user are loaded when the Client connects. Each relationship has a target user id, and a type, such as `Friend`, `PendingOutgoing`, or `Blocked`. The set of all relationships can be queried with [`Client::GetRelationships`]. +[Relationships](/docs/discord-social-sdk/development-guides/managing-relationships) are how Discord models friends, +friend requests, and more. All relationships for the current user are loaded when the Client connects. Each +relationship has a target user id, and a type, such as `Friend`, `PendingOutgoing`, or `Blocked`. -To allow users to manage their relationships in your game, you should provide a way to accept or reject friend requests, block users, and manage pending requests. See [Development Guide: Managing Relationships in Your Game](/docs/discord-social-sdk/development-guides/managing-relationships) for implementation details. +To allow users to manage their relationships in your game, you should provide a way to accept or reject friend +requests, block users, and manage pending requests. See [Development Guide: Managing Relationships in Your Game](/docs/discord-social-sdk/development-guides/managing-relationships) for implementation details. ### Users @@ -50,13 +55,144 @@ The SDK will only display activities associated with the current game, meaning y See our [Design Guidelines: Status & Rich Presence](/docs/discord-social-sdk/design-guidelines/status-rich-presence) for best practices on displaying presence information. -Let's combine to create a unified friends list. +There are two ways in which you can create a unified friends list in your game: + +1. Using the SDK Unified Friends List helper functions, which automatically group and sort +relationships and users for you. +2. Directly retrieving relationships and users from the SDK, and sorting manually. + +## Approach 1: Using SDK Unified Friends List Helper Functions + +:::info +This approach is recommended as it significantly reduces the amount of code you need to write and maintain compared to +manually fetching and organizing relationships, while ensuring your friends list follows Discord's best practices. +::: + +The Discord Social SDK provides built-in helper functions that automatically group and sort your friends list according +to Discord's [recommended design guidelines](/docs/discord-social-sdk/design-guidelines/unified-friends-list). +This approach is generally simpler and more maintainable than manually fetching and organizing relationships. + +The SDK automatically organizes friends into the three groups we find via [`RelationshipGroupType`]: +- `OnlinePlayingGame`: Friends who are online and currently playing your game +- `OnlineElsewhere`: Friends who are online but not playing your game +- `Offline`: Friends who are offline + +### Step 1: Display the Unified Friends List + +The [`Client::GetRelationshipsByGroup`] method returns a pre-sorted list of relationships for a specific group type. +This eliminates the need to manually filter, categorize, and sort friends yourself. The SDK handles all the logic +for determining which group each friend belongs to based on their online status and game activity, and +automatically sorts users within each group (for example, users who have played your game are moved to the top of +the OnlineElsewhere group). + +Let's create a function that uses the SDK helper functions to display a properly organized friends list: + +```cpp +void DisplayUnifiedFriendsList(const std::shared_ptr &client) { + // Get friends playing the game + const auto onlineInGame = client->GetRelationshipsByGroup( + discordpp::RelationshipGroupType::OnlinePlayingGame + ); + + // Get friends online elsewhere + const auto onlineElsewhere = client->GetRelationshipsByGroup( + discordpp::RelationshipGroupType::OnlineElsewhere + ); + + // Get offline friends + const auto offline = client->GetRelationshipsByGroup( + discordpp::RelationshipGroupType::Offline + ); + + // Display "Online - GameTitle" Friends + std::cout << "\n=== Online - GameTitle (" << onlineInGame.size() << ") ===\n"; + for (const auto& relationship : onlineInGame) { + auto user = relationship.User(); + if (user) { + std::string displayStr = "🟣 " + user->DisplayName(); + + // Add Discord friend indicator + if (relationship.DiscordRelationshipType() == discordpp::RelationshipType::Friend) { + displayStr += " 👾"; + } + + // Add game friend indicator + if (relationship.GameRelationshipType() == discordpp::RelationshipType::Friend) { + displayStr += " 🎮"; + } + + std::cout << displayStr << "\n"; + } + } + + // Display "Online - Elsewhere" Friends + std::cout << "\n=== Online - Elsewhere (" << onlineElsewhere.size() << ") ===\n"; + for (const auto& relationship : onlineElsewhere) { + auto user = relationship.User(); + if (user) { + std::string displayStr = "🟢 " + user->DisplayName(); + + // Add Discord friend indicator + if (relationship.DiscordRelationshipType() == discordpp::RelationshipType::Friend) { + displayStr += " 👾"; + } + + // Add game friend indicator + if (relationship.GameRelationshipType() == discordpp::RelationshipType::Friend) { + displayStr += " 🎮"; + } + + std::cout << displayStr << "\n"; + } + } + + // Display "Offline" Friends + std::cout << "\n=== Offline (" << offline.size() << ") ===\n"; + for (const auto& relationship : offline) { + auto user = relationship.User(); + if (user) { + std::string displayStr = "⚫ " + user->DisplayName(); + + // Add Discord friend indicator + if (relationship.DiscordRelationshipType() == discordpp::RelationshipType::Friend) { + displayStr += " 👾"; + } + + // Add game friend indicator + if (relationship.GameRelationshipType() == discordpp::RelationshipType::Friend) { + displayStr += " 🎮"; + } + + std::cout << displayStr << "\n"; + } + } +} +``` + +### Step 2: Set Up Automatic Updates + +To keep your friends list up-to-date automatically, use the [`Client::SetRelationshipGroupsUpdatedCallback`]. This +callback is triggered whenever any change occurs that might affect the friends list grouping, such as a friend going +online or offline, or when a relationship changes, such as when you accept a friend request, or block a user. + +```cpp +// Set up the unified friends list update callback +client->SetRelationshipGroupsUpdatedCallback([&client](const uint64_t userId) { + std::cout << "👥 Friends list updated for user: " << userId << std::endl; + DisplayUnifiedFriendsList(client); +}); +``` --- -## Step 1: Fetch Relationships +## Approach 2: Manually Fetching Relationships and Users + +In this section we'll show a more manual method which gives you more control over how the friends list is displayed in your game. + +### Step 1: Fetch Relationships -First, let's create a function to see what kind of relationships and information we have to work with: +First, let's create a function that utilises [`Client::GetRelationships`] to query all the relationships and +user information we for our account: ```cpp void DisplayFriendsList(discordpp::Client& client) { @@ -122,7 +258,7 @@ This will output the raw relationship data to the console. You can use this info --- -## Step 2: Organize Relationships +### Step 2: Organize Relationships Based on our design guidelines for a [Unified Friends List](/docs/discord-social-sdk/design-guidelines/unified-friends-list), you should separate the player's friends list into three sections: `Online - GameTitle`, `Online - Elsewhere`, and `Offline`. @@ -219,7 +355,7 @@ void DisplayFriendsList(std::shared_ptr client) { If we build and run our application, we should now see a list of friends separated into three categories: `Online - GameTitle`, `Online - Elsewhere`, and `Offline`. -## Step 3: Monitor Changes to Users +### Step 3: Monitor Changes to Users To monitor for user changes, we're going using the [`Client::SetUserUpdatedCallback`] function. @@ -242,7 +378,7 @@ user list, or similar operations. ::: --- -## Step 4: Monitor Changes in Relationships +### Step 4: Monitor Changes in Relationships Let us setup two callbacks to handle relationship updates. @@ -251,7 +387,7 @@ These examples rebuild the friends list from scratch every time a relationship c recommend maintaining a collection of [`UserHandle`] objects and adding and removing them appropriately. ::: -### Relationship Created Callback +#### Relationship Created Callback This can happen when a user sends or accepts a friend invite, or blocks a user. @@ -266,7 +402,7 @@ client->SetRelationshipCreatedCallback([&client](uint64_t userId, bool isDiscord }); ``` -### Relationship Deleted Callback +#### Relationship Deleted Callback This can happen when a user rejects a friend request or removes a friend. @@ -303,11 +439,15 @@ Now that you have a unified friends list, you can build on your social features ## Change Log -| Date | Changes | -|----------------|-----------------| -| March 17, 2025 | Initial release | +| Date | Changes | +|----------------|------------------------| +| March 17, 2025 | Initial release | +| July 17, 2025 | Add UFL helper methods | {/* Autogenerated Reference Links */} [`Client::GetRelationships`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#ad481849835cd570f0e03adafcf90125d +[`Client::GetRelationshipsByGroup`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#a9f7898d3f3d1ec92b06c662df70746d5 +[`Client::SetRelationshipGroupsUpdatedCallback`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#af12441ef091298f968075b7190851098 [`Client::SetUserUpdatedCallback`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#a3559f375165acedc6d6677ef599b3a4a +[`RelationshipGroupType`]: https://discord.com/developers/docs/social-sdk/namespacediscordpp.html#a503ed2f7b0bfbd435321a0e8b1dfba35 [`UserHandle`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1UserHandle.html#a587bcc838e42dc5c56f840a350070707 \ No newline at end of file diff --git a/docs/discord-social-sdk/development-guides/linked-channels.mdx b/docs/discord-social-sdk/development-guides/linked-channels.mdx index 944fc7c583..dbc3e43341 100644 --- a/docs/discord-social-sdk/development-guides/linked-channels.mdx +++ b/docs/discord-social-sdk/development-guides/linked-channels.mdx @@ -13,7 +13,7 @@ import CommsScopeWarning from '../partials/callouts/oauth-comms-scopes.mdx'; ## Overview -Linked Channels let players connect in-game lobbies with Discord text channels, enabling cross-platform chat between your game and Discord servers. +Linked Channels let players connect in-game lobbies with Discord text channels, enabling chat between your game and Discord servers. When linked: - In-game messages appear in the Discord channel diff --git a/docs/discord-social-sdk/development-guides/managing-relationships.mdx b/docs/discord-social-sdk/development-guides/managing-relationships.mdx index 5f7efb8309..c2ab9a09b5 100644 --- a/docs/discord-social-sdk/development-guides/managing-relationships.mdx +++ b/docs/discord-social-sdk/development-guides/managing-relationships.mdx @@ -29,9 +29,9 @@ Before you begin, make sure you have: ## Understanding Relationship Types Discord models the relationship between two users using the Relationship entity in the SDK. Relationships are not just for friends. They are also used to send and receive friend requests and block other users. - -Note: While the SDK allows you to manage a user's relationships, you should never act without their explicit consent. You should not automatically send or accept friend requests. Only invoke APIs to manage relationships in response to a user action such as clicking a "Send Friend Request" button. - +:::warn +While the SDK allows you to manage a user's relationships, you should never act without their explicit consent. You should not automatically send or accept friend requests. Only invoke APIs to manage relationships in response to a user action such as clicking a "Send Friend Request" button. +::: ### Relationship Types We know that sometimes users will want to be friends with each other across all their games. If they start playing a new game, they can see all of their previous friends and don't start from scratch. But sometimes, they don't want to give out that access and only want to be friends in the current game they are playing. diff --git a/docs/discord-social-sdk/development-guides/sending-direct-messages.mdx b/docs/discord-social-sdk/development-guides/sending-direct-messages.mdx index 22a0b79f9a..2e62e59957 100644 --- a/docs/discord-social-sdk/development-guides/sending-direct-messages.mdx +++ b/docs/discord-social-sdk/development-guides/sending-direct-messages.mdx @@ -141,7 +141,7 @@ Now that you know how to send and receive messages, check out these other Discor Bring players together in a shared lobby with invites, text chat, and voice comms. - Enable cross-platform text chat between a Discord channel and your game. + Enable text chat between a Discord channel and your game. diff --git a/docs/discord-social-sdk/getting-started.mdx b/docs/discord-social-sdk/getting-started.mdx index 386d808169..a07acc1858 100644 --- a/docs/discord-social-sdk/getting-started.mdx +++ b/docs/discord-social-sdk/getting-started.mdx @@ -33,7 +33,7 @@ If you are unsure which platform to choose, we recommend starting with the C++ g :::info -To see a complete list of currently compatible platforms, check out our [Platform Compatibility](/docs/discord-social-sdk/core-concepts#sdk-platform-compatibility) section. +To see a complete list of currently compatible platforms, check out our [Platform Compatibility](/docs/discord-social-sdk/core-concepts/platform-compatibility) section. ::: --- diff --git a/docs/discord-social-sdk/getting-started/partials/getting-started.mdx b/docs/discord-social-sdk/getting-started/partials/getting-started.mdx index 6f2dc6925a..07806bc4ab 100644 --- a/docs/discord-social-sdk/getting-started/partials/getting-started.mdx +++ b/docs/discord-social-sdk/getting-started/partials/getting-started.mdx @@ -19,7 +19,7 @@ Later, you can invite your team members to your new team to collaborate on your 4. Enable the `Public Client` toggle in the `OAuth2` tab. :::warn -**Note:** This guide requires enabling **Public Client** to allow you to get started with the SDK quickly. Most games will not want to ship as a public client. This setting should be reviewed by your team prior to releasing your game. [Learn more about public clients](/docs/discord-social-sdk/core-concepts#oauth2-client-types). +**Note:** This guide requires enabling **Public Client** to allow you to get started with the SDK quickly. Most games will not want to ship as a public client. This setting should be reviewed by your team prior to releasing your game. [Learn more about public clients](/docs/discord-social-sdk/core-concepts/oauth2-scopes#oauth2-client-types). ::: --- diff --git a/docs/discord-social-sdk/overview.mdx b/docs/discord-social-sdk/overview.mdx index 6b376f9b85..e866c63fe8 100644 --- a/docs/discord-social-sdk/overview.mdx +++ b/docs/discord-social-sdk/overview.mdx @@ -36,21 +36,27 @@ Start integrating the SDK into your game with our getting started guides, design + + --- ## Limited Access Features -Discord Social SDK features for text and voice communication are available but have limited access. +Discord Social SDK features for text and voice communication are available but have limited access. :::preview -For more information on how to access these features, please see [Core Concepts: Limited Access Features](/docs/discord-social-sdk/core-concepts#limited-access-features). +For more information on how to access these features, please see [Core Concepts: Communication Features](/docs/discord-social-sdk/core-concepts/communication-features). ::: --- ## Get Help & Join the Community -Need support or looking to connect with other game developers? +Need support or looking to connect with other game developers? - Join our [DDevs Discord Server](https://discord.gg/discord-developers) and get help from the community, share best practices, and discover new ways to enhance your game. Find us in the `#social-sdk-dev-help` channel! - For additional support, you can [file a ticket with Developer Support](https://dis.gd/social-sdk) to report issues. \ No newline at end of file diff --git a/docs/discord-social-sdk/partials/callouts/limited-access.mdx b/docs/discord-social-sdk/partials/callouts/limited-access.mdx index 5d08228a0b..1d7ae843d2 100644 --- a/docs/discord-social-sdk/partials/callouts/limited-access.mdx +++ b/docs/discord-social-sdk/partials/callouts/limited-access.mdx @@ -1,3 +1,6 @@ :::preview -This feature is currently available with [limited access](/docs/discord-social-sdk/core-concepts#limited-access-features). To apply for full access to closed beta features, or to reach out to Discord directly to discuss your game, please fill out [this form](https://discord.com/developers/social-sdk-closed-beta-access-request-form). +This feature is currently available with +[limited access](/docs/discord-social-sdk/core-concepts/communication-features#limited-access). To apply for full access +to closed beta features, or to reach out to Discord directly to discuss your game, please fill out +[this form](https://discord.com/developers/social-sdk-closed-beta-access-request-form). ::: \ No newline at end of file diff --git a/docs/discord-social-sdk/partials/callouts/oauth-comms-scopes.mdx b/docs/discord-social-sdk/partials/callouts/oauth-comms-scopes.mdx index 8eda262266..e8d003ea33 100644 --- a/docs/discord-social-sdk/partials/callouts/oauth-comms-scopes.mdx +++ b/docs/discord-social-sdk/partials/callouts/oauth-comms-scopes.mdx @@ -1,6 +1,6 @@ :::warn To utilize this communication feature, you must enable [`Client::GetDefaultCommunicationScopes`] in your OAuth Scope configuration. -See the [OAuth Scopes Core Concepts Guide](/docs/discord-social-sdk/core-concepts#oauth2-scopes) for more details. +See the [OAuth Scopes Core Concepts Guide](/docs/discord-social-sdk/core-concepts/oauth2-scopes) for more details. ::: {/* Autogenerated Reference Links */} diff --git a/docs/discord-social-sdk/partials/callouts/public-client.mdx b/docs/discord-social-sdk/partials/callouts/public-client.mdx index 3c6adebda4..60b5c2c979 100644 --- a/docs/discord-social-sdk/partials/callouts/public-client.mdx +++ b/docs/discord-social-sdk/partials/callouts/public-client.mdx @@ -1,3 +1,3 @@ :::warn -This method requires enabling **Public Client** for your app. Most games will not want to ship with this enabled. [Learn more](/docs/discord-social-sdk/core-concepts#oauth2-client-types) +This method requires enabling **Public Client** for your app. Most games will not want to ship with this enabled. [Learn more](/docs/discord-social-sdk/core-concepts/oauth2-scopes#oauth2-client-types) ::: \ No newline at end of file diff --git a/docs/discord-social-sdk/partials/callouts/support.mdx b/docs/discord-social-sdk/partials/callouts/support.mdx index e3b89f4387..c8f9c6c069 100644 --- a/docs/discord-social-sdk/partials/callouts/support.mdx +++ b/docs/discord-social-sdk/partials/callouts/support.mdx @@ -1 +1,3 @@ Need help? Join the [Discord Developers Server](https://discord.gg/discord-developers) and share questions in the `#social-sdk-dev-help` channel for support from the community. + +If you encounter a bug while working with the Social SDK, please report it here: https://dis.gd/social-sdk-bug-report diff --git a/docs/events/gateway-events.mdx b/docs/events/gateway-events.mdx index d46320ede7..ae4fc94d71 100644 --- a/docs/events/gateway-events.mdx +++ b/docs/events/gateway-events.mdx @@ -1133,23 +1133,26 @@ Active sessions are indicated with an "online", "idle", or "dnd" string per plat ###### Activity Structure -| Field | Type | Description | -|-----------------|--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------| -| name | string | Activity's name | -| type | integer | [Activity type](/docs/events/gateway-events#activity-object-activity-types) | -| url? | ?string | Stream URL, is validated when type is 1 | -| created_at | integer | Unix timestamp (in milliseconds) of when the activity was added to the user's session | -| timestamps? | [timestamps](/docs/events/gateway-events#activity-object-activity-timestamps) object | Unix timestamps for start and/or end of the game | -| application_id? | snowflake | Application ID for the game | -| details? | ?string | What the player is currently doing | -| state? | ?string | User's current party status, or text used for a custom status | -| emoji? | ?[emoji](/docs/events/gateway-events#activity-object-activity-emoji) object | Emoji used for a custom status | -| party? | [party](/docs/events/gateway-events#activity-object-activity-party) object | Information for the current party of the player | -| assets? | [assets](/docs/events/gateway-events#activity-object-activity-assets) object | Images for the presence and their hover texts | -| secrets? | [secrets](/docs/events/gateway-events#activity-object-activity-secrets) object | Secrets for Rich Presence joining and spectating | -| instance? | boolean | Whether or not the activity is an instanced game session | -| flags? | integer | [Activity flags](/docs/events/gateway-events#activity-object-activity-flags) `OR`d together, describes what the payload includes | -| buttons? | array of [buttons](/docs/events/gateway-events#activity-object-activity-buttons) | Custom buttons shown in the Rich Presence (max 2) | +| Field | Type | Description | +|----------------------|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| name | string | Activity's name | +| type | integer | [Activity type](/docs/events/gateway-events#activity-object-activity-types) | +| url? | ?string | Stream URL, is validated when type is 1 | +| created_at | integer | Unix timestamp (in milliseconds) of when the activity was added to the user's session | +| timestamps? | [timestamps](/docs/events/gateway-events#activity-object-activity-timestamps) object | Unix timestamps for start and/or end of the game | +| application_id? | snowflake | Application ID for the game | +| status_display_type? | ?integer | [Status display type](/docs/events/gateway-events#activity-object-status-display-types); controls which field is displayed in the user's status text in the member list | +| details? | ?string | What the player is currently doing | +| details_url? | ?string | URL that is linked when clicking on the details text | +| state? | ?string | User's current party status, or text used for a custom status | +| state_url? | ?string | URL that is linked when clicking on the state text | +| emoji? | ?[emoji](/docs/events/gateway-events#activity-object-activity-emoji) object | Emoji used for a custom status | +| party? | [party](/docs/events/gateway-events#activity-object-activity-party) object | Information for the current party of the player | +| assets? | [assets](/docs/events/gateway-events#activity-object-activity-assets) object | Images for the presence and their hover texts | +| secrets? | [secrets](/docs/events/gateway-events#activity-object-activity-secrets) object | Secrets for Rich Presence joining and spectating | +| instance? | boolean | Whether or not the activity is an instanced game session | +| flags? | integer | [Activity flags](/docs/events/gateway-events#activity-object-activity-flags) `OR`d together, describes what the payload includes | +| buttons? | array of [buttons](/docs/events/gateway-events#activity-object-activity-buttons) | Custom buttons shown in the Rich Presence (max 2) | :::info Bot users are only able to set `name`, `state`, `type`, and `url`. @@ -1170,6 +1173,18 @@ Bot users are only able to set `name`, `state`, `type`, and `url`. The streaming type currently only supports Twitch and YouTube. Only `https://twitch.tv/` and `https://youtube.com/` urls will work. ::: +###### Status Display Types + +| ID | Name | Example | +|----|---------|----------------------------------------| +| 0 | Name | "Listening to Spotify" | +| 1 | State | "Listening to Rick Astley" | +| 2 | Details | "Listening to Never Gonna Give You Up" | + +:::info +This applies to all activity types. "Listening" was used to serve as a consistent example of what the different fields might be used for. +::: + ###### Activity Timestamps | Field | Type | Description | @@ -1202,8 +1217,10 @@ For Listening and Watching activities, you can include both start and end timest |--------------|--------|----------------------------------------------------------------------------------------------| | large_image? | string | See [Activity Asset Image](/docs/events/gateway-events#activity-object-activity-asset-image) | | large_text? | string | Text displayed when hovering over the large image of the activity | +| large_url? | string | URL that is opened when clicking on the large image | | small_image? | string | See [Activity Asset Image](/docs/events/gateway-events#activity-object-activity-asset-image) | | small_text? | string | Text displayed when hovering over the small image of the activity | +| small_url? | string | URL that is opened when clicking on the small image | ###### Activity Asset Image diff --git a/docs/monetization/implementing-one-time-purchases.md b/docs/monetization/implementing-one-time-purchases.md index 6e3a6aace3..c051061267 100644 --- a/docs/monetization/implementing-one-time-purchases.md +++ b/docs/monetization/implementing-one-time-purchases.md @@ -29,7 +29,8 @@ When creating items for one-time purchase, you can choose between durable and co - You will receive an `ENTITLEMENT_CREATE` event via the Gateway. - This entitlement is now available via the `LIST Entitlements` API endpoint. - This entitlement will be available on `Interaction Payloads` initiated from the entitled user or users in a guild (for guild subscriptions). -- The purchasing user is unable to make another purchase of this specific SKU until you consume the entitlement using the [Consume Entitlement API](/docs/resources/entitlement#consume-an-entitlement) endpoint. +- Users cannot repurchase this SKU until you consume the entitlement using the [Consume Entitlement API](/docs/resources/entitlement#consume-an-entitlement) endpoint. + - In [Test Mode](/docs/monetization/implementing-one-time-purchases#using-application-test-mode), repeated purchases are permitted without consumption for developer convenience. - When you receive an `ENTITLEMENT_CREATE` event for a consumable SKU, you should process the item purchase in your app and consume the entitlement as soon as possible. --- diff --git a/docs/resources/audit-log.mdx b/docs/resources/audit-log.mdx index ccbb74e52c..c111cd472c 100644 --- a/docs/resources/audit-log.mdx +++ b/docs/resources/audit-log.mdx @@ -137,6 +137,7 @@ You should assume that your app may run into any field for the changed object, t | AUTO_MODERATION_BLOCK_MESSAGE | 143 | Message was blocked by Auto Moderation | | | AUTO_MODERATION_FLAG_TO_CHANNEL | 144 | Message was flagged by Auto Moderation | | | AUTO_MODERATION_USER_COMMUNICATION_DISABLED | 145 | Member was timed out by Auto Moderation | | +| AUTO_MODERATION_QUARANTINE_USER | 146 | Member was quarantined by Auto Moderation | | | CREATOR_MONETIZATION_REQUEST_CREATED | 150 | Creator monetization request was created | | | CREATOR_MONETIZATION_TERMS_ACCEPTED | 151 | Creator monetization terms were accepted | | | ONBOARDING_PROMPT_CREATE | 163 | Guild Onboarding Question was created | [Onboarding Prompt Structure](/docs/resources/guild#guild-onboarding-object-onboarding-prompt-structure) | @@ -152,20 +153,20 @@ You should assume that your app may run into any field for the changed object, t ###### Optional Audit Entry Info -| Field | Type | Description | Event Types | -|-----------------------------------|-----------|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| application_id | snowflake | ID of the app whose permissions were targeted | APPLICATION_COMMAND_PERMISSION_UPDATE | -| auto_moderation_rule_name | string | Name of the Auto Moderation rule that was triggered | AUTO_MODERATION_BLOCK_MESSAGE & AUTO_MODERATION_FLAG_TO_CHANNEL & AUTO_MODERATION_USER_COMMUNICATION_DISABLED | -| auto_moderation_rule_trigger_type | string | Trigger type of the Auto Moderation rule that was triggered | AUTO_MODERATION_BLOCK_MESSAGE & AUTO_MODERATION_FLAG_TO_CHANNEL & AUTO_MODERATION_USER_COMMUNICATION_DISABLED | -| channel_id | snowflake | Channel in which the entities were targeted | MEMBER_MOVE & MESSAGE_PIN & MESSAGE_UNPIN & MESSAGE_DELETE & STAGE_INSTANCE_CREATE & STAGE_INSTANCE_UPDATE & STAGE_INSTANCE_DELETE & AUTO_MODERATION_BLOCK_MESSAGE & AUTO_MODERATION_FLAG_TO_CHANNEL & AUTO_MODERATION_USER_COMMUNICATION_DISABLED | -| count | string | Number of entities that were targeted | MESSAGE_DELETE & MESSAGE_BULK_DELETE & MEMBER_DISCONNECT & MEMBER_MOVE | -| delete_member_days | string | Number of days after which inactive members were kicked | MEMBER_PRUNE | -| id | snowflake | ID of the overwritten entity | CHANNEL_OVERWRITE_CREATE & CHANNEL_OVERWRITE_UPDATE & CHANNEL_OVERWRITE_DELETE | -| members_removed | string | Number of members removed by the prune | MEMBER_PRUNE | -| message_id | snowflake | ID of the message that was targeted | MESSAGE_PIN & MESSAGE_UNPIN | -| role_name | string | Name of the role if type is `"0"` (not present if type is `"1"`) | CHANNEL_OVERWRITE_CREATE & CHANNEL_OVERWRITE_UPDATE & CHANNEL_OVERWRITE_DELETE | -| type | string | Type of overwritten entity - role (`"0"`) or member (`"1"`) | CHANNEL_OVERWRITE_CREATE & CHANNEL_OVERWRITE_UPDATE & CHANNEL_OVERWRITE_DELETE | -| integration_type | string | The type of integration which performed the action | MEMBER_KICK & MEMBER_ROLE_UPDATE | +| Field | Type | Description | Event Types | +|-----------------------------------|-----------|------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| application_id | snowflake | ID of the app whose permissions were targeted | APPLICATION_COMMAND_PERMISSION_UPDATE | +| auto_moderation_rule_name | string | Name of the Auto Moderation rule that was triggered | AUTO_MODERATION_BLOCK_MESSAGE & AUTO_MODERATION_FLAG_TO_CHANNEL & AUTO_MODERATION_USER_COMMUNICATION_DISABLED & AUTO_MODERATION_QUARANTINE_USER | +| auto_moderation_rule_trigger_type | string | Trigger type of the Auto Moderation rule that was triggered | AUTO_MODERATION_BLOCK_MESSAGE & AUTO_MODERATION_FLAG_TO_CHANNEL & AUTO_MODERATION_USER_COMMUNICATION_DISABLED & AUTO_MODERATION_QUARANTINE_USER | +| channel_id | snowflake | Channel in which the entities were targeted | MEMBER_MOVE & MESSAGE_PIN & MESSAGE_UNPIN & MESSAGE_DELETE & STAGE_INSTANCE_CREATE & STAGE_INSTANCE_UPDATE & STAGE_INSTANCE_DELETE & AUTO_MODERATION_BLOCK_MESSAGE & AUTO_MODERATION_FLAG_TO_CHANNEL & AUTO_MODERATION_USER_COMMUNICATION_DISABLED & AUTO_MODERATION_QUARANTINE_USER | +| count | string | Number of entities that were targeted | MESSAGE_DELETE & MESSAGE_BULK_DELETE & MEMBER_DISCONNECT & MEMBER_MOVE | +| delete_member_days | string | Number of days after which inactive members were kicked | MEMBER_PRUNE | +| id | snowflake | ID of the overwritten entity | CHANNEL_OVERWRITE_CREATE & CHANNEL_OVERWRITE_UPDATE & CHANNEL_OVERWRITE_DELETE | +| members_removed | string | Number of members removed by the prune | MEMBER_PRUNE | +| message_id | snowflake | ID of the message that was targeted | MESSAGE_PIN & MESSAGE_UNPIN | +| role_name | string | Name of the role if type is `"0"` (not present if type is `"1"`) | CHANNEL_OVERWRITE_CREATE & CHANNEL_OVERWRITE_UPDATE & CHANNEL_OVERWRITE_DELETE | +| type | string | Type of overwritten entity - role (`"0"`) or member (`"1"`) | CHANNEL_OVERWRITE_CREATE & CHANNEL_OVERWRITE_UPDATE & CHANNEL_OVERWRITE_DELETE | +| integration_type | string | The type of integration which performed the action | MEMBER_KICK & MEMBER_ROLE_UPDATE | ### Audit Log Change Object diff --git a/docs/resources/guild.mdx b/docs/resources/guild.mdx index 1339574d15..761a1551fd 100644 --- a/docs/resources/guild.mdx +++ b/docs/resources/guild.mdx @@ -398,17 +398,18 @@ In `GUILD_` events, `pending` will always be included as true or false. In non ` ###### Guild Member Flags -| Flag | Value | Description | Editable | -|---------------------------------|----------|------------------------------------------------------------------------------|----------| -| DID_REJOIN | `1 << 0` | Member has left and rejoined the guild | false | -| COMPLETED_ONBOARDING | `1 << 1` | Member has completed onboarding | false | -| BYPASSES_VERIFICATION | `1 << 2` | Member is exempt from guild verification requirements | true | -| STARTED_ONBOARDING | `1 << 3` | Member has started onboarding | false | -| IS_GUEST | `1 << 4` | Member is a guest and can only access the voice channel they were invited to | false | -| STARTED_HOME_ACTIONS | `1 << 5` | Member has started Server Guide new member actions | false | -| COMPLETED_HOME_ACTIONS | `1 << 6` | Member has completed Server Guide new member actions | false | -| AUTOMOD_QUARANTINED_USERNAME | `1 << 7` | Member's username, display name, or nickname is blocked by AutoMod | false | -| DM_SETTINGS_UPSELL_ACKNOWLEDGED | `1 << 9` | Member has dismissed the DM settings upsell | false | +| Flag | Value | Description | Editable | +|---------------------------------|-----------|------------------------------------------------------------------------------|----------| +| DID_REJOIN | `1 << 0` | Member has left and rejoined the guild | false | +| COMPLETED_ONBOARDING | `1 << 1` | Member has completed onboarding | false | +| BYPASSES_VERIFICATION | `1 << 2` | Member is exempt from guild verification requirements | true | +| STARTED_ONBOARDING | `1 << 3` | Member has started onboarding | false | +| IS_GUEST | `1 << 4` | Member is a guest and can only access the voice channel they were invited to | false | +| STARTED_HOME_ACTIONS | `1 << 5` | Member has started Server Guide new member actions | false | +| COMPLETED_HOME_ACTIONS | `1 << 6` | Member has completed Server Guide new member actions | false | +| AUTOMOD_QUARANTINED_USERNAME | `1 << 7` | Member's username, display name, or nickname is blocked by AutoMod | false | +| DM_SETTINGS_UPSELL_ACKNOWLEDGED | `1 << 9` | Member has dismissed the DM settings upsell | false | +| AUTOMOD_QUARANTINED_GUILD_TAG | `1 << 10` | Member's guild tag is blocked by AutoMod | false | :::info BYPASSES_VERIFICATION allows a member who does not meet verification requirements to participate in a server. diff --git a/docs/resources/message.mdx b/docs/resources/message.mdx index e4b9778ed1..d1aadc9309 100644 --- a/docs/resources/message.mdx +++ b/docs/resources/message.mdx @@ -824,22 +824,22 @@ Files must be attached using a `multipart/form-data` body as described in [Uploa When creating a message, apps must provide a value for **at least one of** `content`, `embeds`, `sticker_ids`, `components`, `files[n]`, or `poll`. ::: -| Field | Type | Description | -|--------------------|-----------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| content?\* | string | Message contents (up to 2000 characters) | -| nonce? | integer or string | Can be used to verify a message was sent (up to 25 characters). Value will appear in the [Message Create event](/docs/events/gateway-events#message-create). | -| tts? | boolean | `true` if this is a TTS message | -| embeds?\* | array of [embed](/docs/resources/message#embed-object) objects | Up to 10 `rich` embeds (up to 6000 characters) | -| allowed_mentions? | [allowed mention object](/docs/resources/message#allowed-mentions-object) | Allowed mentions for the message | -| message_reference? | [message reference](/docs/resources/message#message-reference-structure) | Include to make your message a reply or a forward | -| components?\* | array of [message component](/docs/components/reference#component-object) objects | Components to include with the message | -| sticker_ids?\* | array of snowflakes | IDs of up to 3 [stickers](/docs/resources/sticker#sticker-object) in the server to send in the message | -| files[n]?\* | file contents | Contents of the file being sent. See [Uploading Files](/docs/reference#uploading-files) | -| payload_json? | string | JSON-encoded body of non-file params, only for `multipart/form-data` requests. See [Uploading Files](/docs/reference#uploading-files) | -| attachments? | array of partial [attachment](/docs/resources/message#attachment-object) objects | Attachment objects with filename and description. See [Uploading Files](/docs/reference#uploading-files) | -| flags?\*\* | integer | [Message flags](/docs/resources/message#message-object-message-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) (only `SUPPRESS_EMBEDS`, `SUPPRESS_NOTIFICATIONS` and `IS_COMPONENTS_V2` can be set) | -| enforce_nonce? | boolean | If true and nonce is present, it will be checked for uniqueness in the past few minutes. If another message was created by the same author with the same nonce, that message will be returned and no new message will be created. | -| poll? | [poll](/docs/resources/poll#poll-create-request-object) request object | A poll! | +| Field | Type | Description | +|--------------------|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| content?\* | string | Message contents (up to 2000 characters) | +| nonce? | integer or string | Can be used to verify a message was sent (up to 25 characters). Value will appear in the [Message Create event](/docs/events/gateway-events#message-create). | +| tts? | boolean | `true` if this is a TTS message | +| embeds?\* | array of [embed](/docs/resources/message#embed-object) objects | Up to 10 `rich` embeds (up to 6000 characters) | +| allowed_mentions? | [allowed mention object](/docs/resources/message#allowed-mentions-object) | Allowed mentions for the message | +| message_reference? | [message reference](/docs/resources/message#message-reference-structure) | Include to make your message a reply or a forward | +| components?\* | array of [message component](/docs/components/reference#component-object) objects | Components to include with the message | +| sticker_ids?\* | array of snowflakes | IDs of up to 3 [stickers](/docs/resources/sticker#sticker-object) in the server to send in the message | +| files[n]?\* | file contents | Contents of the file being sent. See [Uploading Files](/docs/reference#uploading-files) | +| payload_json? | string | JSON-encoded body of non-file params, only for `multipart/form-data` requests. See [Uploading Files](/docs/reference#uploading-files) | +| attachments? | array of partial [attachment](/docs/resources/message#attachment-object) objects | Attachment objects with filename and description. See [Uploading Files](/docs/reference#uploading-files) | +| flags?\*\* | integer | [Message flags](/docs/resources/message#message-object-message-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) (only `SUPPRESS_EMBEDS`, `SUPPRESS_NOTIFICATIONS`, `IS_VOICE_MESSAGE`, and `IS_COMPONENTS_V2` can be set) | +| enforce_nonce? | boolean | If true and nonce is present, it will be checked for uniqueness in the past few minutes. If another message was created by the same author with the same nonce, that message will be returned and no new message will be created. | +| poll? | [poll](/docs/resources/poll#poll-create-request-object) request object | A poll! | \* At least one of `content`, `embeds`, `sticker_ids`, `components`, `files[n]`, or `poll` is required. diff --git a/docs/resources/user.mdx b/docs/resources/user.mdx index f31d414156..5d630aabdb 100644 --- a/docs/resources/user.mdx +++ b/docs/resources/user.mdx @@ -119,12 +119,12 @@ Premium types denote the level of premium a user has. Visit the [Nitro](https:// ###### User Primary Guild -| Field | Type | Description | -|-------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| identity_guild_id | ?snowflake | the id of the user's primary guild | -| identity_enabled | ?boolean | whether the user is displaying the primary guild's server tag. This can be `null` if the system clears the identity, e.g. because the server no longer supports tags. | -| tag | ?string | the text of the user's server tag. Limited to 4 characters | -| badge | ?string | the [server tag badge hash](/docs/reference#image-formatting) | +| Field | Type | Description | +|-------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| identity_guild_id | ?snowflake | the id of the user's primary guild | +| identity_enabled | ?boolean | whether the user is displaying the primary guild's server tag. This can be `null` if the system clears the identity, e.g. the server no longer supports tags. This will be `false` if the user manually removes their tag. | +| tag | ?string | the text of the user's server tag. Limited to 4 characters | +| badge | ?string | the [server tag badge hash](/docs/reference#image-formatting) | ### Avatar Decoration Data Object diff --git a/docs/topics/rpc.md b/docs/topics/rpc.md index 64b0608eee..bd9f3cb4ae 100644 --- a/docs/topics/rpc.md +++ b/docs/topics/rpc.md @@ -1004,7 +1004,9 @@ When using `SET_ACTIVITY`, the `activity` object is limited to a `type` of Playi "pid": 9999, "activity": { "state": "In a Group", + "state_url": "https://example.com/groups/50335231-9d9d-4ebd-873b-984787ee4d1d", "details": "Competitive | In a Match", + "details_url": "https://example.com/matches/42340203-2f25-4534-8ff6-2a6509e81207", "timestamps": { "start": time(nullptr), "end": time(nullptr) + (60 * 5 + 23) @@ -1012,8 +1014,10 @@ When using `SET_ACTIVITY`, the `activity` object is limited to a `type` of Playi "assets": { "large_image": "numbani_map", "large_text": "Numbani", + "large_url": "https://example.wiki/maps/Numbani", "small_image": "pharah_profile", - "small_text": "Pharah" + "small_text": "Pharah", + "small_url": "https://example.wiki/characters/Pharah" }, "party": { "id": GameEngine.GetPartyId(), pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy