My Project
Loading...
Searching...
No Matches
Public Attributes | List of all members
PlayFab.ClientModels.LoginWithSteamRequest Class Reference

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 (requires sign-in). 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. More...

Inheritance diagram for PlayFab.ClientModels.LoginWithSteamRequest:
PlayFab.SharedModels.PlayFabRequestCommon PlayFab.SharedModels.PlayFabBaseModel

Public Attributes

bool? CreateAccount
 Automatically create a PlayFab account if one is not currently linked to this ID.
 
Dictionary< string, string > CustomTags
 The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
 
string EncryptedRequest
 Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).
 
GetPlayerCombinedInfoRequestParams InfoRequestParameters
 Flags for which pieces of info to return for the user.
 
string PlayerSecret
 Player secret that is used to verify API request signatures (Enterprise Only).
 
string SteamTicket
 Authentication token for the user, returned as a byte array from Steam, and converted to a string (for example, the byte 0x08 should become "08").
 
string TitleId
 Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.
 
- Public Attributes inherited from PlayFab.SharedModels.PlayFabRequestCommon
PlayFabAuthenticationContext AuthenticationContext
 

Additional Inherited Members

- Public Member Functions inherited from PlayFab.SharedModels.PlayFabBaseModel
string ToJson ()
 

Detailed Description

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 (requires sign-in). 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.


The documentation for this class was generated from the following file: