> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PartyLocalUser::UpdateEntityToken

> 更新与此本地用户关联的 PlayFab 实体令牌，以用于将来的经过身份验证的操作。

更新与此本地用户关联的 PlayFab 实体令牌，以用于将来的经过身份验证的操作。

## Syntax

```cpp theme={null}
PartyError UpdateEntityToken(  
    PartyString entityToken  
)  
```

### Parameters

**`entityToken`**   [PartyString](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/typedefs.md)

要与本地用户关联的新 PlayFab 实体令牌。

### Return value

PartyError

如果调用成功，则返回 `c_partyErrorSuccess`；否则返回错误代码。可通过 [PartyManager::GetErrorMessage()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_geterrormessage.md) 检索错误代码的可读形式。

## Remarks

此方法将 PlayFab 实体令牌作为 `entityToken`。不会对此值执行同步验证。当库执行需要用户身份验证或授权的操作（例如创建网络、身份验证到网络或执行语音转文本转录）时，Party 服务将验证该令牌是否有效、是否未过期、是否与提供给 [PartyManager::CreateLocalUser()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluser.md) 或 [PartyManager::CreateLocalUserWithEntityType()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluserwithentitytype.md) 调用的相同实体 ID 关联，以及是否被授权执行操作。如果不满足这些条件，操作将失败。\
\
 可以从 PlayFab 登录操作的输出中获取 PlayFab 实体令牌，然后将其作为输入提供给此方法。该令牌必须与最初指定给 [PartyManager::CreateLocalUser()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluser.md) 或 [PartyManager::CreateLocalUserWithEntityType()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluserwithentitytype.md) 的相同 PlayFab 实体 ID 和类型相关联。   \
\
 提供的 `entityToken` 必须使用传递给 [PartyManager::Initialize()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_initialize.md) 的相同游戏 ID 获取。   \
\
 Party 库复制所提供的 PlayFab 实体令牌以用于需要本地用户身份验证或授权的后续操作，例如 [PartyManager::CreateNewNetwork()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createnewnetwork.md) 或 [PartyNetwork::AuthenticateLocalUser()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_authenticatelocaluser.md)。如果提供给此调用的令牌已过期或以其他方式无效，则需要有效令牌的操作将失败。可以通过再次调用此方法向 Party 库提供新的有效令牌。   \
\
 调用方负责监视提供给此方法以及 [PartyManager::CreateLocalUser()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluser.md) 或 [PartyManager::CreateLocalUserWithEntityType()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluserwithentitytype.md) 的实体令牌的过期时间。当令牌接近或超过过期时间时，应通过执行 PlayFab 登录操作获取新令牌，并通过调用此方法将其提供给 Party 库。我们建议在先前提供的令牌的有效期过半时获取新令牌。在可能进入低功耗状态或以其他方式导致应用程序长时间暂停执行的平台上，令牌可能在过期之前无法刷新，此时应在执行恢复后立即检查令牌是否过期。

## Requirements

**Header:** Party.h

## See also

[PartyLocalUser](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyLocalUser/partylocaluser.md)\
[PartyManager::GetErrorMessage](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_geterrormessage.md)\
[PartyManager::CreateLocalUser](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluser.md)\
[PartyManager::CreateLocalUserWithEntityType](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluserwithentitytype.md)\
[PartyManager::CreateNewNetwork](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createnewnetwork.md)\
[PartyNetwork::AuthenticateLocalUser](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_authenticatelocaluser.md)


## Related topics

- [PlayFab Party 发行说明](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/release-notes.md)
- [PartyManager::CreateLocalUserWithEntityType](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluserwithentitytype.md)
- [PartyManager::CreateLocalUser](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_createlocaluser.md)
- [PartyManager::Initialize](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_initialize.md)
- [PartyNetwork::AuthenticateLocalUser](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyNetwork/methods/partynetwork_authenticatelocaluser.md)