Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 2.63 KB

pfauthenticationloginwithxuserrequest.md

File metadata and controls

66 lines (42 loc) · 2.63 KB
Raw
author title description ms.author ms.topic ms.service ms.date
jasonsandlin
PFAuthenticationLoginWithXUserRequest
PFAuthenticationLoginWithXUserRequest data model. 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. Request object for PFAuthenticationLoginWithXUserAsync.
jasonsa
reference
playfab
02/22/2024

PFAuthenticationLoginWithXUserRequest

PFAuthenticationLoginWithXUserRequest data model. 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. Request object for PFAuthenticationLoginWithXUserAsync.

Syntax

typedef struct PFAuthenticationLoginWithXUserRequest {  
    bool createAccount;  
    PFStringDictionaryEntry const* customTags;  
    uint32_t customTagsCount;  
    PFGetPlayerCombinedInfoRequestParams const* infoRequestParameters;  
    const char* playerSecret;  
    XUserHandle user;  
} PFAuthenticationLoginWithXUserRequest;

Members

createAccount   bool

Automatically create a PlayFab account if one is not currently linked to this ID.

customTags   PFStringDictionaryEntry const*
may be nullptr

(Optional) The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

customTagsCount   uint32_t

Count of customTags

infoRequestParameters   PFGetPlayerCombinedInfoRequestParams const*
may be nullptr

(Optional) Flags for which pieces of info to return for the user.

playerSecret   const char*
is null-terminated

(Optional) Player secret that is used to verify API request signatures (Enterprise Only).

user   XUserHandle

XUserHandle returned from XUserAddAsync or XUserAddByIdWithUiAsync.

Requirements

Header: PFAuthenticationTypes.h

See also

PFAuthenticationTypes members