構文
パラメーター
entityId PartyString
ローカル ユーザーに関連付ける PlayFab エンティティ ID。
titlePlayerEntityToken PartyString
ローカル ユーザーに関連付ける PlayFab エンティティ トークン。
localUser PartyLocalUser**ライブラリによって割り当てられる出力 出力するローカル ユーザー オブジェクト。
戻り値
PartyError ローカル ユーザーの作成が成功した場合はc_partyErrorSuccess、それ以外の場合はエラー コード。エラー コードの人間が判読可能な形式は、GetErrorMessage() から取得できます。
解説
このメソッドはentityId として PlayFab エンティティ ID を、titlePlayerEntityToken として PlayFab エンティティ トークンを受け取ります。entityId の長さが c_maxEntityIdStringLength 以下であること以外に、これらの値に対する同期的な検証は行われません。ライブラリが、ネットワークの作成、ネットワークへの認証、音声テキスト変換の実行など、ユーザー認証や承認が必要な操作を実行するときに、Party サービスは、トークンが有効であり、有効期限が切れておらず、提供されたエンティティ ID に関連付けられており、その操作の実行を承認されていることを検証します。これらの条件が満たされていない場合、操作は失敗します。PlayFab エンティティ ID とエンティティ トークンは、PlayFab ログイン操作の出力から取得でき、このメソッドへの入力として提供できます。PlayFab エンティティ ID は、
title_player_account 型である必要があります。これは、ほとんどの開発者にとって、最も伝統的な意味での “プレイヤー” を表します。他のサポートされているエンティティ タイプを表すユーザーを作成するには、代わりに CreateLocalUserWithEntityType() を使用してください。 提供される
entityId と titlePlayerEntityToken は、Initialize() に渡されたのと同じ Title ID を使用して取得されている必要があります。 Party ライブラリは、CreateNewNetwork() や PartyNetwork::AuthenticateLocalUser() のように、ローカル ユーザーの認証や承認が必要な後続の操作で使用するために、提供された PlayFab エンティティ トークンのコピーを作成します。この呼び出しに提供されたトークンが有効期限切れであるか、それ以外の場合に無効な場合、有効なトークンが必要な操作は失敗します。新しい有効なトークンは、PartyLocalUser::UpdateEntityToken() を呼び出すことによって Party ライブラリに提供できます。
このメソッドと PartyLocalUser::UpdateEntityToken() に提供されるエンティティ トークンの有効期限を監視するのは呼び出し元の責任です。トークンが有効期限に近づいているか、有効期限を過ぎた場合、PlayFab ログイン操作を実行して新しいトークンを取得し、PartyLocalUser::UpdateEntityToken() を呼び出して Party ライブラリに提供する必要があります。以前に提供したトークンが有効期間の半分に達したときに、新しいトークンを取得することをお勧めします。低電力状態に入る可能性があるプラットフォームや、アプリケーションが長時間実行を一時停止する可能性のあるプラットフォームでは、トークンの更新が期限切れになる前にできなくなる可能性があるため、実行が再開されたときにトークンの有効期限を確認する必要があります。
任意の時点で同時に存在できる PartyLocalUser オブジェクトは
c_maxLocalUsersPerDeviceCount 個までです。別のローカル ユーザーを作成することでその制限を超える場合、このメソッドは同期的に失敗します。 正常に戻ると、このメソッドは、新しいユーザーを配列に同期的に追加するので、GetLocalUsers() によって以前に返された配列のメモリを無効にします。StartProcessingStateChanges() も配列のメモリを無効にします。返される
localUser オブジェクトは、PartyDestroyLocalUserCompletedStateChange が生成され、そのオブジェクトを参照するすべての状態変化が FinishProcessingStateChanges() に返されるまで有効です。
要件
ヘッダー: Party.h関連項目
PartyManagerPartyDestroyLocalUserCompletedStateChange
PartyManager::Initialize
PartyManager::GetLocalUsers
PartyManager::CreateLocalUserWithEntityType
PartyManager::DestroyLocalUser
PartyManager::CreateNewNetwork
PartyNetwork::AuthenticateLocalUser
PartyNetwork::RemoveLocalUser
PartyNetwork::CreateInvitation
PartyNetwork::RevokeInvitation
PartyNetwork::CreateEndpoint
PartyLocalUser::UpdateEntityToken
PartyLocalDevice::CreateChatControl