PFAuthenticationLoginWithSteamAsync
Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for API calls which require an authenticated user
Syntax
HRESULT PFAuthenticationLoginWithSteamAsync(
PFServiceConfigHandle serviceConfigHandle,
const PFAuthenticationLoginWithSteamRequest* request,
XAsyncBlock* async
)
Parameters
serviceConfigHandle PFServiceConfigHandle
PFServiceConfigHandle returned from PFServiceConfigCreateHandle call.
request PFAuthenticationLoginWithSteamRequest*
Populated request object.
async XAsyncBlock*
Inout
XAsyncBlock for the async operation.
Return value
Type: HRESULT
Result code for this API operation.
Remarks
This API is available on Win32, Linux, and macOS. Steam sign-in is accomplished with the Steam Session Ticket. More information on the Ticket can be found in the Steamworks SDK, here: https://partner.steamgames.com/documentation/auth. NOTE: For Steam authentication to work, the title must be configured with the Steam Application ID and Web API Key in the PlayFab Game Manager (under Steam in the Add-ons Marketplace). You can obtain a Web API Key from the Permissions page of any Group associated with your App ID in the Steamworks site. If this is the first time a user has signed in with the Steam account and CreateAccount is set to true, a new PlayFab account will be created and linked to the provided account's Steam ID. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Steam account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account. See also ClientLinkSteamAccountAsync, ClientUnlinkSteamAccountAsync. When the asynchronous task is complete, call PFAuthenticationLoginWithSteamGetResult to get the result.
Requirements
Header: PFAuthentication.h