Edit

Share via

PFAuthenticationLoginWithXboxRequest

  • Article

PFAuthenticationLoginWithXboxRequest 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.

Syntax

typedef struct PFAuthenticationLoginWithXboxRequest {  
    bool createAccount;  
    PFStringDictionaryEntry const* customTags;  
    uint32_t customTagsCount;  
    PFGetPlayerCombinedInfoRequestParams const* infoRequestParameters;  
    const char* playerSecret;  
    const char* xboxToken;  
} PFAuthenticationLoginWithXboxRequest;

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).

xboxToken   const char*
is null-terminated

Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", "").

Requirements

Header: PFAuthenticationTypes.h

See also

PFAuthenticationTypes members