Skip to content

Conversation

@markmandel
Copy link
Contributor

@markmandel markmandel commented Apr 15, 2025

This PR includes changelog and related updates to documentation so it can be merged atomically.

Details include:

  • The changelog for the release.
  • Updated mappings for doxygen docs.
  • Updated Provisional Account docs for Unity Services.
  • Added links on Provisional Account docs to all other services.
  • Add PlayStation4 and Xbox One support to supported platforms list.
  • Trailing spaces cleanup.

@markmandel markmandel requested a review from a team as a code owner April 15, 2025 00:22
@markmandel markmandel requested review from colinloretz and huderlem and removed request for a team April 15, 2025 00:22
@markmandel markmandel force-pushed the release/social-sdk-1.1 branch from b10f272 to a5c06d9 Compare April 15, 2025 00:54
- For OIDC, a provisional account's display name will be the value of the preferred_username claim, if specified in the ID token. This field is optional and should be between 1 and 32 characters. If not specified, the user's display name will default to the user's unique username, which Discord generates on creation.
- For Steam session tickets, the display name of the user's Steam account is used as the provisional account's display name.
- For EOS Auth Access Tokens or ID Tokens, the name of the user's Epic account is used as the provisional account's display name. EOS Connect ID Tokens do not expose any username, and thus the game will need to configure the display name with [`Client::UpdateProvisionalAccountDisplayName`].
- For OIDC, a provisional account's display name will be the value of the preferred_username claim, if specified in the

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's format "preferred_username" as code using single backticks.

name will default to the user's unique username, which Discord generates on creation.
- For [Steam session tickets](https://partner.steamgames.com/doc/features/auth), the display name of the user's Steam
account is used as the provisional account's display name.
- For [EOS Auth Access](https://dev.epicgames.com/docs/epic-account-services/auth/auth-interface) Tokens or ID Tokens,

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The word "Access" shouldn't be included in the hyperlink.

the name of the user's Epic account is used as the provisional account's display name. EOS Connect ID Tokens do
not expose any username, and thus the game will need to configure the display name with
[`Client::UpdateProvisionalAccountDisplayName`].
- For [Unity Services ID Tokens](https://docs.unity.com/ugs/en-us/manual/authentication/manual/unity-player-accounts),

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should instead link here (this is also where the dev portal links to), which is the documentation that deals with ID tokens (rather than access tokens): https://services.docs.unity.com/docs/client-auth/

This PR includes changelog and related updates to documentation so
it can be merged atomically.

Details include:

* The changelog for the release.
* Updated mappings for doxygen docs.
* Updated Provisional Account docs for Unity Services.
* Added links on Provisional Account docs to all other services.
* Add PlayStation4 and Xbox One support to supported platforms list.
* Trailing spaces cleanup.
@markmandel markmandel force-pushed the release/social-sdk-1.1 branch from 4fbaf92 to 9362136 Compare April 15, 2025 22:59
@markmandel markmandel merged commit b74dcc7 into discord:main Apr 15, 2025
4 checks passed
@markmandel markmandel deleted the release/social-sdk-1.1 branch April 15, 2025 23:00
mazylol pushed a commit to mazylol/discord-api-docs that referenced this pull request Jul 3, 2025
* Discord Social SDK 1.1 Release

This PR includes changelog and related updates to documentation so
it can be merged atomically.

Details include:

* The changelog for the release.
* Updated mappings for doxygen docs.
* Updated Provisional Account docs for Unity Services.
* Added links on Provisional Account docs to all other services.
* Add PlayStation4 and Xbox One support to supported platforms list.
* Trailing spaces cleanup.

* Review updates.

* Change date, so it displays on top.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants