PartyLocalUser::UpdateEntityToken

  • [アーティクル]

今後の認証された操作で使用するために、このローカル ユーザーに関連付けられている PlayFab エンティティ トークンを更新します。

構文

PartyError UpdateEntityToken(  
    PartyString entityToken  
)

パラメーター

entityToken PartyString

ローカル ユーザーに関連付ける新しい PlayFab エンティティ トークン。

戻り値

PartyError

呼び出しが成功した場合は c_partyErrorSuccess、それ以外の場合はエラー コードになります。 人間が読める形式のエラー コードは、PartyManager::GetErrorMessage() を介して取得できます。

備考

このメソッドは、PlayFab エンティティ トークンを entityToken として取得します。 この値に対して同期検証は実行されません。 ライブラリが、ネットワークの作成、ネットワークへの認証、音声からテキストへの変換などユーザー認証または承認を必要とする操作を実行するとき、パーティー サービスは、トークンが有効で期限切れではなく、PartyManager::CreateLocalUser() 呼び出しまたは PartyManager::CreateLocalUserWithEntityType() 呼び出しに提供されたエンティティ ID と同じ ID に関連付けられていて、操作の実行を承認されていることを検証します。 これらの条件が満たされない場合、操作は失敗します。

PlayFab エンティティ トークンは、PlayFab ログイン操作の出力から取得し、このメソッドへの入力として提供できます。 トークンは、PartyManager::CreateLocalUser() または PartyManager::CreateLocalUserWithEntityType() に最初に指定されたのと同じ PlayFab エンティティ ID と型に関連付ける必要があります。

指定された entityToken は、PartyManager::Initialize() に渡されたのと同じタイトル ID を使用して取得されている必要があります。

パーティー ライブラリは、PartyManager::CreateNewNetwork() や PartyNetwork::AuthenticateLocalUser() などローカル ユーザーの認証または承認を必要とする今後の操作で使用するために、指定した PlayFab エンティティ トークンのコピーを作成します。 この呼び出しに提供されたトークンの有効期限が切れているか、無効な場合、有効なトークンを必要とする操作は失敗します。 このメソッドの別の呼び出しによって、新しい有効なトークンをパーティー ライブラリに提供できます。

呼び出し元は、このメソッドおよび PartyManager::CreateLocalUser() または PartyManager::CreateLocalUserWithEntityType() に指定されたエンティティ トークンの有効期限を監視する責任があります。 トークンの有効期限が近づいたり過ぎたりした場合は、PlayFab のログイン操作を行って新しいトークンを取得し、このメソッドを呼び出してパーティー ライブラリに提供する必要があります。 前に供給されたトークンの有効期間が半分を過ぎた時点で、新しいトークンを取得することをおすすめします。 低電力状態になるなどしてアプリケーションの実行が長時間停止し、トークンが期限切れ前に更新されない可能性があるプラットフォームでは、実行が再開された時点でトークンの期限切れをチェックする必要があります。

要件

ヘッダー: Party.h

関連項目

PartyLocalUser
PartyManager::GetErrorMessage
PartyManager::CreateLocalUser
PartyManager::CreateLocalUserWithEntityType
PartyManager::CreateNewNetwork
PartyNetwork::AuthenticateLocalUser