文档管理中心

PlayersClient

展开

Interface Info

public interface PlayersClient

PlayersClient类定义了获取玩家信息的相关方法。

Public Method Summary

展开

Qualifier and Type

Method Name and Description

Task<Player>

getCurrentPlayer()

获取当前登录玩家的Player对象。

Task<Player>

getGamePlayer()

获取当前登录玩家的Player对象。返回的Player对象中只有getDisplayName 、getOpenId、getUnionId有值,其他方法返回空。

Task<Player>

getGamePlayer(boolean isRequirePlayerId)

获取当前登录玩家的Player对象,支持同时获取playerId和openId。

Task<String>

getCachePlayerId()

获取本地缓存的当前登录玩家的playerId。

Task<Void>

savePlayerInfo(AppPlayerInfo appPlayerInfo)

保存玩家在当前游戏内的信息。

注意

此接口即将废弃,如需保存玩家角色信息,请使用savePlayerRole方法。

Task<Void>

vipCheck()

检查智慧屏会员权益。在华为帐号授权后,游戏登录前调用。

注意

此接口只支持智慧屏。

Task<Void>

savePlayerRole(PlayerRoleInfo playerRoleInfo)

保存玩家在当前游戏内的角色信息。

Public Methods

getCurrentPlayer

展开

Method

public Task<Player> getCurrentPlayer()

获取当前登录的玩家对象。

Returns

展开

Type

Description

Task<Player>

玩家对象。

getGamePlayer

展开

Method

public Task<Player> getGamePlayer()

获取当前登录的玩家对象。

Returns

展开

Type

Description

Task<Player>

玩家对象。返回的Player对象中只有getDisplayName 、getOpenId、getUnionId有值,其他方法返回空。

getGamePlayer

展开

Method

public Task<Player> getGamePlayer(boolean isRequirePlayerId)

获取当前登录的玩家对象。

Parameters

展开

Name

Description

isRequirePlayerId

是否需要返回playerId。

  • true:返回的Player对象中包含playerId。
  • false:返回的Player对象中不包含playerId,效果等同于getGamePlayer()。
说明

此参数仅在playerId替换为openId时才需要设置。

Returns

展开

Type

Description

Task<Player>

玩家对象。

getCachePlayerId

展开

Method

public Task<String> getCachePlayerId()

获取本地缓存的当前登录玩家的playerId。

Returns

展开

Type

Description

Task<String>

玩家的playerId。

savePlayerInfo

展开

Method

public Task<Void> savePlayerInfo(AppPlayerInfo appPlayerInfo)

保存玩家在游戏内的信息,如等级、区服等。

Parameters

展开

Name

Description

AppPlayerInfo

玩家在游戏内的具体信息。

Returns

展开

Type

Description

Task<Void>

保存结果。

vipCheck

展开

Method

public Task<Void> vipCheck()

智慧屏校验会员开通和有效期信息。在华为帐号授权后,游戏登录前调用。

注意

此接口只支持智慧屏。

Returns

展开

Type

Description

Task<Void>

校验结果。

您需要在接口返回的Task中设置两个回调监听,使用OnSuccessListener可以获取到校验成功场景返回的数据,使用OnFailureListener可以获取到此次校验请求失败的相关信息。在OnFailureListener中您需要判断该方式回调的异常对象是否是一个ApiException实例对象,然后根据ApiException实例中包含的getStatusCode()进行一些必要错误场景的处理,返回码参见通用返回码。

savePlayerRole

展开

Method

public Task<Void> savePlayerRole(PlayerRoleInfo playerRoleInfo)

保存玩家在游戏内的角色信息,如区服、角色名称等。

Parameters

展开

Name

Description

playerRoleInfo

玩家在游戏内的角色信息,具体请参见PlayerRoleInfo。

Returns

展开

Type

Description

Task<Void>

保存结果。

搜索
请输入您想要搜索的关键词