author | title | description | ms.author | ms.topic | ms.service | ms.date |
---|---|---|---|---|---|---|
jasonsandlin |
PFAuthenticationServerLoginWithXboxAsync |
Signs the user in using a Xbox Live Token from an external server backend, returning a session identifier that can subsequently be used for API calls which require an authenticated user |
jasonsa |
reference |
playfab |
02/22/2024 |
Signs the user in using a Xbox Live Token from an external server backend, returning a session identifier that can subsequently be used for API calls which require an authenticated user
HRESULT PFAuthenticationServerLoginWithXboxAsync(
PFServiceConfigHandle serviceConfigHandle,
const char* secretKey,
const PFAuthenticationServerLoginWithXboxRequest* request,
XAsyncBlock* async
)
serviceConfigHandle
PFServiceConfigHandle
PFServiceConfigHandle returned from PFServiceConfigCreateHandle call.
secretKey
char*
In_z
Title Secret Key used to authenticate the service request.
request
PFAuthenticationServerLoginWithXboxRequest*
Populated request object.
async
XAsyncBlock*
Inout
XAsyncBlock for the async operation.
Type: HRESULT
Result code for this API operation.
This API is available on Win32, Linux, and macOS. If this is the first time a user has signed in with the Xbox Live account and CreateAccount is set to true, a new PlayFab account will be created and linked to the Xbox Live account. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Xbox Live account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account. See also ServerLinkXboxAccountAsync, ServerUnlinkXboxAccountAsync. When the asynchronous task is complete, call PFAuthenticationServerLoginWithXboxGetResult to get the result.
Header: PFAuthentication.h