文档管理中心

此版本文档已归档不再维护,推荐您使用最新版本

API参考游戏服务客户端API参考游戏接口jos.gamesPlayersClient

com.huawei.hms.jos.games.PlayersClient

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

Public Method Summary

ReturnMethod
Task<Player>getCurrentPlayer()
获取当前登录玩家的Player对象。
Task<String>

getCachePlayerId()

获取本地缓存的当前登录玩家的playerId。
Task<PlayerExtraInfo>

getPlayerExtraInfo(String transactionId)

获取玩家附加信息。
Task<String>

submitPlayerEvent(String playerId,String eventId,String eventType)

上报玩家的行为事件。
Task<void>

savePlayerInfo(AppPlayerInfo appPlayerInfo)

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

Public Methods

public Task<Player> getCurrentPlayer()

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

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

调用示例

收起
自动换行
深色代码主题
复制
  1. Task<Player> task = client.getCurrentPlayer();
  2. task.addOnSuccessListener(new OnSuccessListener<Player>() {
  3.   @Override
  4.    public void onSuccess(Player player) {
  5.        String playerId = player.getPlayerId();
  6.    }
  7.    }).addOnFailureListener(new OnFailureListener() {
  8.    @Override
  9.    public void onFailure(Exception e) {
  10.        if  (e instanceof ApiException) {
  11.            (ApiException) e).getStatusCode()
  12.        }
  13.    }
  14. });

public Task<String> getCachePlayerId()

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

返回值

玩家的playerId。

public Task<PlayerExtraInfo> getPlayerExtraInfo(String transactionId)

获取玩家附加信息。

请求参数

Parameter Name

Parameter Description

transactionId

玩家进入游戏时,应用调用submitPlayerEvent方法上报玩家事件时游戏服务器返回的transactionId。

如果存在transactionId则传入,不存在则传null。

返回值

Type

Description

PlayerExtraInfo

异步返回玩家附加信息。

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

public Task<String> submitPlayerEvent(String playerId,String eventId,String eventType)

上报玩家进入游戏或退出游戏时的行为事件。

请求参数

Parameter Name

Parameter Description

playerId

当前登录玩家的playerId

eventId

玩家事件ID。

  • eventTypeGAMEBEGIN时,eventId为开发者生成的随机数,应用内唯一,不超过64位。

  • eventTypeGAMEEND时,eventId为玩家进入游戏时调用submitPlayerEvent返回的transactionId。

eventType

事件类型。

  • GAMEBEGIN:进入游戏

  • GAMEEND:退出游戏

返回值

Type

Description

String

仅当eventTypeGAMEBEGIN时,该值返回游戏服务器为玩家分配的transactionId,其他场景返回null。

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

public Task<void> savePlayerInfo(AppPlayerInfo appPlayerInfo)

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

请求参数

Parameter Name

Parameter Description

AppPlayerInfo

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

返回值

无。

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


本页面可能包含由第三方许可的内容,请参考具体描述
在 API参考 中进行搜索
请输入您想要搜索的关键词