The RankingsClient class defines the APIs related to leaderboards, for example, APIs for obtaining leaderboard data and setting the leaderboard switch.

Public Method Summary

Public Methods

public Task<Intent> getTotalRankingsIntent()

Obtains the Intent object of the leaderboard list screen.

Return Values

You need to set two callback listeners in the Task returned by the API. OnSuccessListener obtains the data returned in the success scenario, and OnFailureListener obtains the information about the request failure. In OnFailureListener, you need to check whether the exception object called back in this mode is an ApiException instance object, and resolve the failure according to getStatusCode() contained in the ApiException instance.

public Task<Intent> getRankingIntent(String rankingId, int timeDimension)

Obtains the Intent object of the screen for a specified leaderboard in a specified time frame.

Input Parameters

Return Values

You need to set two callback listeners in the Task returned by the API. OnSuccessListener obtains the data returned in the success scenario, and OnFailureListener obtains the information about the request failure. In OnFailureListener, you need to check whether the exception object called back in this mode is an ApiException instance object, and resolve the failure according to getStatusCode() contained in the ApiException instance.

public Task<Intent> getRankingIntent(String rankingId)

Obtains the Intent object of the screen for a specified leaderboard in all time frames.

Input Parameters

Return Values

You need to set two callback listeners in the Task returned by the API. OnSuccessListener obtains the data returned in the success scenario, and OnFailureListener obtains the information about the request failure. In OnFailureListener, you need to check whether the exception object called back in this mode is an ApiException instance object, and resolve the failure according to getStatusCode() contained in the ApiException instance.

public Task<RankingScore> getCurrentPlayerRankingScore(String rankingId, int timeDimension)

Obtains the score of a player on a specified leaderboard in a specified time frame.

Input Parameters

Return Values

You need to set two callback listeners in the Task returned by the API. OnSuccessListener obtains the data returned in the success scenario, and OnFailureListener obtains the information about the request failure. In OnFailureListener, you need to check whether the exception object called back in this mode is an ApiException instance object, and resolve the failure according to getStatusCode() contained in the ApiException instance.

public Task<List<Ranking>> getRankingSummary(boolean isRealTime)

Obtains all leaderboard data. You can specify whether to obtain the data from Huawei game server or the local cache.

Input Parameters

Return Values

You need to set two callback listeners in the Task returned by the API. OnSuccessListener obtains the data returned in the success scenario, and OnFailureListener obtains the information about the request failure. In OnFailureListener, you need to check whether the exception object called back in this mode is an ApiException instance object, and resolve the failure according to getStatusCode() contained in the ApiException instance.

public Task<Ranking> getRankingSummary(String rankingId, boolean isRealTime)

Obtains the data of a specified leaderboard. You can specify whether to obtain the data from Huawei game server or the local cache.

Input Parameters

Return Values

You need to set two callback listeners in the Task returned by the API. OnSuccessListener obtains the data returned in the success scenario, and OnFailureListener obtains the information about the request failure. In OnFailureListener, you need to check whether the exception object called back in this mode is an ApiException instance object, and resolve the failure according to getStatusCode() contained in the ApiException instance.

public Task<RankingsClient.RankingScores> getMoreRankingScores(String rankingId,long offsetPlayerRank, int maxResults, int pageDirection, int timeDimension)

Obtains scores on a leaderboard in pagination mode.

Input Parameters

Return Values

You need to set two callback listeners in the Task returned by the API. OnSuccessListener obtains the data returned in the success scenario, and OnFailureListener obtains the information about the request failure. In OnFailureListener, you need to check whether the exception object called back in this mode is an ApiException instance object, and resolve the failure according to getStatusCode() contained in the ApiException instance.

public Task<RankingsClient.RankingScores> getPlayerCenteredRankingScores(String rankingId, int timeDimension, int maxResults, boolean isRealTime)

Obtains scores of a leaderboard with the current player's score displayed in the center. The data can be obtained from the local cache. For example, if a player ranks fifth on a leaderboard, this method can be used to obtain the scores of a specified number of players before and after the current player.

Input Parameters

Return Values

You need to set two callback listeners in the Task returned by the API. OnSuccessListener obtains the data returned in the success scenario, and OnFailureListener obtains the information about the request failure. In OnFailureListener, you need to check whether the exception object called back in this mode is an ApiException instance object, and resolve the failure according to getStatusCode() contained in the ApiException instance.

public Task<RankingsClient.RankingScores> getPlayerCenteredRankingScores(String rankingId, int timeDimension,int maxResults, long offsetPlayerRank, int pageDirection)

Obtains scores of a leaderboard with the current player's score displayed in the center. The data can be obtained only from Huawei game server.

Input Parameters

Return Values

You need to set two callback listeners in the Task returned by the API. OnSuccessListener obtains the data returned in the success scenario, and OnFailureListener obtains the information about the request failure. In OnFailureListener, you need to check whether the exception object called back in this mode is an ApiException instance object, and resolve the failure according to getStatusCode() contained in the ApiException instance.

public Task<RankingsClient.RankingScores> getRankingTopScores(String rankingId, int timeDimension, int maxResults, long offsetPlayerRank, int pageDirection)

Obtains scores on the first page of a leaderboard. The data can be obtained only from Huawei game server.

Input Parameters

Return Values

You need to set two callback listeners in the Task returned by the API. OnSuccessListener obtains the data returned in the success scenario, and OnFailureListener obtains the information about the request failure. In OnFailureListener, you need to check whether the exception object called back in this mode is an ApiException instance object, and resolve the failure according to getStatusCode() contained in the ApiException instance.

public Task<RankingsClient.RankingScores> getRankingTopScores(String rankingId, int timeDimension, int maxResults, boolean isRealTime)

Obtains scores on the first page of a leaderboard. The data can be obtained only from the local cache.

Input Parameters

Return Values

You need to set two callback listeners in the Task returned by the API. OnSuccessListener obtains the data returned in the success scenario, and OnFailureListener obtains the information about the request failure. In OnFailureListener, you need to check whether the exception object called back in this mode is an ApiException instance object, and resolve the failure according to getStatusCode() contained in the ApiException instance.

public void submitRankingScore(String rankingId, long score, String scoreTips)

Asynchronously submits the score of the current player with a custom unit.

This method is submitted asynchronously. To be specific, if the device is not connected to the network when the app client calls this method, the HMS SDK caches the data locally. The data is submitted to the Huawei server when network connection is restored and the user logs in again. It is unnecessary for developers to pay attention to the execution result of this method.

Input Parameters

public void submitRankingScore(String rankingId, long score)

Asynchronously submits the score of the current player without a custom unit.

This method is submitted asynchronously. To be specific, if the device is not connected to the network when the app client calls this method, the HMS SDK caches the data locally. The data is submitted to the Huawei server when network connection is restored and the user logs in again. It is unnecessary for developers to pay attention to the execution result of this method.

Input Parameters

public Task<ScoreSubmissionInfo> submitScoreWithResult(String rankingId, long score, String scoreTips)

Synchronously submits the score of the current player with a custom unit.

This method submits requests synchronously. That is, requests are immediately sent to Huawei game server after an app client calls this method, and the execution result is returned immediately.

Input Parameters

Return Values

You need to set two callback listeners in the Task returned by the API. OnSuccessListener obtains the data returned in the success scenario, and OnFailureListener obtains the information about the request failure. In OnFailureListener, you need to check whether the exception object called back in this mode is an ApiException instance object, and resolve the failure according to getStatusCode() contained in the ApiException instance.

public Task<ScoreSubmissionInfo> submitScoreWithResult(String rankingId, long score)

Synchronously submits the score of the current player without a custom unit.

This method submits requests synchronously. That is, requests are immediately sent to Huawei game server after an app client calls this method, and the execution result is returned immediately.

Input Parameters

Return Values

You need to set two callback listeners in the Task returned by the API. OnSuccessListener obtains the data returned in the success scenario, and OnFailureListener obtains the information about the request failure. In OnFailureListener, you need to check whether the exception object called back in this mode is an ApiException instance object, and resolve the failure according to getStatusCode() contained in the ApiException instance.

public Task<Integer> getRankingSwitchStatus()

Obtains the leaderboard switch setting. Indicates whether a player agrees to report their scores to leaderboards. The switch is disabled by default upon first sign-in of the player.

Return Values

You need to set two callback listeners in the Task returned by the API. OnSuccessListener obtains the data returned in the success scenario, and OnFailureListener obtains the information about the request failure. In OnFailureListener, you need to check whether the exception object called back in this mode is an ApiException instance object, and resolve the failure according to getStatusCode() contained in the ApiException instance.

public Task<Integer> setRankingSwitchStatus(int status)

Sets the leaderboard switch.

Input Parameters

Return Values

You need to set two callback listeners in the Task returned by the API. OnSuccessListener obtains the data returned in the success scenario, and OnFailureListener obtains the information about the request failure. In OnFailureListener, you need to check whether the exception object called back in this mode is an ApiException instance object, and resolve the failure according to getStatusCode() contained in the ApiException instance.