Bewerken

Delen via

PartyXblManager::GetEntityIdsFromXboxLiveUserIds

  • Artikel

Queues an asynchronous operation to retrieve a list of mappings between PlayFab Entity Ids and known Xbox Live User Ids.

Syntax

PartyError GetEntityIdsFromXboxLiveUserIds(  
    uint32_t xboxLiveUserIdCount,  
    const uint64_t* xboxLiveUserIds,  
    const PartyXblLocalChatUser* localChatUser,  
    void* asyncIdentifier  
)

Parameters

xboxLiveUserIdCount   uint32_t

The number of Xbox Live User Ids in the xboxLiveUserIds array.

xboxLiveUserIds   uint64_t*
input array of size xboxLiveUserIdCount

An array of size xboxLiveUserIdCount containing the Xbox Live User Ids for which the library will query the PlayFab Entity Id.

localChatUser   PartyXblLocalChatUser*

Local chat user that will be used to communicate with PlayFab. The local chat user will be logged in to PlayFab if needed.

asyncIdentifier   void*
optional

An optional, app-defined, pointer-sized context value that can be used to associate the completion state change with this call.

Return value

PartyError

c_partyErrorSuccess if the operation started or an error code otherwise. The human-readable form of the error code can be retrieved via GetErrorMessage().

Remarks

Each Xbox Live User Id will only map to a PlayFab Entity Id if this Xbox Live User has already been linked to a PlayFab account. A PlayFab account is automatically created and linked when calling PartyXblManager::LoginToPlayFab for the first time. The LoginWithXbox API provided by the PlayFab SDK can also be used to link an account.

If the PartyXblGetEntityIdsFromXboxLiveUserIdsCompletedStateChange associated with the completion of this call indicates a failure with a result of PartyXblStateChangeResult::PlayFabUserNotAuthorized, the operation can be retried no more than one time after successfully calling LoginToPlayFab().

If the PartyXblGetEntityIdsFromXboxLiveUserIdsCompletedStateChange associated with the completion of this call indicates a failure with a result of PartyXblStateChangeResult::PlayFabRateLimitExceeded, the operation can be retried after a brief delay.

Requirements

Header: PartyXboxLive.h

See also

PartyXblManager
PartyXblGetEntityIdsFromXboxLiveUserIdsCompletedStateChange