-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Social SDK: Add OAuth Communications Scope warnings #7653
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.
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
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -88,6 +88,76 @@ The Discord Social SDK is available for the following platforms: | |||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## 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 needs 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 following scope | ||||||
|
||||||
| The communications features are currently available but have limited access. Those features **require** the following scope | |
| The communications features are currently available but have limited access. Those features **require** the scope |
I think this reads a little better
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 7 additions & 0 deletions
7
docs/discord-social-sdk/partials/callouts/oauth-comms-scopes.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| :::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. | ||
| ::: | ||
|
|
||
| {/* Autogenerated Reference Links */} | ||
| [`Client::GetDefaultCommunicationScopes`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#a71499da752fbdc2d4326ae0fd36c0dd1 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure which is grammatically correct but I think this reads better