PFMultiplayerSetEntityToken

  • [アーティクル]

エンティティの代わりにライブラリ アクションを実行するときに認証に使用するトークンを設定します。 トークンがエンティティに対して以前に設定されている場合は、以前のトークンが置き換えられます。

構文

HRESULT PFMultiplayerSetEntityToken(  
    PFMultiplayerHandle handle,  
    const PFEntityKey* entity,  
    const char* entityToken  
)

パラメーター

handle PFMultiplayerHandle

PFMultiplayer API インスタンスのハンドル。

entityPFEntityKey*

トークンに関連付ける PlayFab エンティティ キー。

entityToken char*
が null で終わる

TBD

戻り値

型: HRESULT

S_OKローカル ユーザーの作成に成功した場合。それ以外の場合はエラー コード。 人間が読める形式のエラー コードは、PFMultiplayerGetErrorMessage() を介して取得できます。

解説

このメソッドは、PlayFab エンティティ キーを entity として、PlayFab エンティティ トークンを token として取得します。 ロビーの作成や更新など、認証または承認を必要とするエンティティに代わってライブラリが操作を実行すると、ライブラリは操作に使用するエンティティに関連付けられているトークンを検索します。 エンティティに対して前もってトークンが設定されていない場合、その操作は同期的に失敗します。 非同期操作中に、PlayFab サービスはトークンが有効であり、期限切れでないこと、提供されたエンティティ ID に関連付けられていること、そして操作を実行する権限があることを確認します。 これらの条件が満たされないと、操作は失敗します。

PlayFab エンティティ キーと PlayFab エンティティ トークンは、PlayFab ログイン操作の出力から取得し、このメソッドへの入力として提供できます。

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

マルチプレイヤー ライブラリは、PFMultiplayerCreateAndJoinLobby などローカル ユーザーの認証または承認を必要とする今後の操作で使用するために、指定した PlayFab エンティティ トークンのコピーを作成します。 この呼び出しに提供されたトークンの有効期限が切れているか無効な場合、有効なトークンを必要とする操作は失敗します。 同じエンティティ キーを使用してこのメソッドをもう一度呼び出すことで、新しい有効なトークンをマルチプレイヤー ライブラリに提供できます。

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

これらの値に対して同期検証は実行されません。

要件

ヘッダー: PFMultiplayer.h

関連項目

PFMultiplayer メンバー
PFMultiplayerInitialize