gpg::LeaderboardManager

#include <leaderboard_manager.h>

获取和设置各种排行榜相关数据。

摘要

公共类型

FetchAllCallback typedef
std::function< void(const FetchAllResponse &)>
定义 FetchAllResponse 类型的回调。
FetchAllScoreSummariesCallback typedef
std::function< void(const FetchAllScoreSummariesResponse &)>
定义 FetchAllScoreSummariesResponse 类型的回调。
FetchCallback typedef
std::function< void(const FetchResponse &)>
定义一个接收 FetchResponse 的回调类型。
FetchScorePageCallback typedef
std::function< void(const FetchScorePageResponse &)>
定义 ScorePageResponse 类型的回调。
FetchScoreSummaryCallback typedef
std::function< void(const FetchScoreSummaryResponse &)>
定义 FetchScoreSummaryResponse 类型的回调。
ShowAllUICallback typedef
std::function< void(const UIStatus &)>
定义一个接收 UIStatus 的回调类型。
ShowUICallback typedef
std::function< void(const UIStatus &)>
定义一个接收 UIStatus 的回调类型。

公共函数

Fetch(const std::string & leaderboard_id, FetchCallback callback)
void
异步加载当前登录玩家的排行榜数据。
Fetch(DataSource data_source, const std::string & leaderboard_id, FetchCallback callback)
void
异步加载当前登录玩家的排行榜数据。
FetchAll(FetchAllCallback callback)
void
异步加载当前登录玩家的所有排行榜数据。
FetchAll(DataSource data_source, FetchAllCallback callback)
void
异步加载当前登录玩家的所有排行榜数据。
FetchAllBlocking()
同步加载当前登录玩家的所有排行榜数据,直接返回 FetchAllResponse
FetchAllBlocking(DataSource data_source)
同步加载当前登录玩家的所有排行榜数据,直接返回 FetchAllResponse
FetchAllBlocking(Timeout timeout)
同步加载当前登录玩家的所有排行榜数据,直接返回 FetchAllResponse
FetchAllBlocking(DataSource data_source, Timeout timeout)
同步加载当前登录玩家的所有排行榜数据,直接返回 FetchAllResponse
FetchAllScoreSummaries(const std::string & leaderboard_id, FetchAllScoreSummariesCallback callback)
void
异步获取特定排行榜的所有分数摘要。
FetchAllScoreSummaries(DataSource data_source, const std::string & leaderboard_id, FetchAllScoreSummariesCallback callback)
void
异步获取特定排行榜的所有分数摘要。
FetchAllScoreSummariesBlocking(const std::string & leaderboard_id)
同步获取特定排行榜的所有分数摘要,直接返回 FetchAllScoreSummariesResponse
FetchAllScoreSummariesBlocking(DataSource data_source, const std::string & leaderboard_id)
同步获取特定排行榜的所有分数摘要,直接返回 FetchAllScoreSummariesResponse
FetchAllScoreSummariesBlocking(Timeout timeout, const std::string & leaderboard_id)
同步获取特定排行榜的所有分数摘要,直接返回 FetchAllScoreSummariesResponse
FetchAllScoreSummariesBlocking(DataSource data_source, Timeout timeout, const std::string & leaderboard_id)
同步获取特定排行榜的所有分数摘要,直接返回 FetchAllScoreSummariesResponse
FetchBlocking(const std::string & leaderboard_id)
同步加载当前登录玩家的排行榜数据,直接返回 FetchResponse
FetchBlocking(DataSource data_source, const std::string & leaderboard_id)
同步加载当前登录玩家的排行榜数据,直接返回 FetchResponse
FetchBlocking(Timeout timeout, const std::string & leaderboard_id)
同步加载当前登录玩家的排行榜数据,直接返回 FetchResponse
FetchBlocking(DataSource data_source, Timeout timeout, const std::string & leaderboard_id)
同步加载当前登录玩家的排行榜数据。
FetchScorePage(const ScorePage::ScorePageToken & token, FetchScorePageCallback callback)
void
异步返回由分数页令牌标识的分数页数据。
FetchScorePage(DataSource data_source, const ScorePage::ScorePageToken & token, FetchScorePageCallback callback)
void
异步返回由分数页令牌标识的分数页数据。
FetchScorePage(const ScorePage::ScorePageToken & token, uint32_t max_results, FetchScorePageCallback callback)
void
异步返回由分数页令牌标识的分数页数据。
FetchScorePage(DataSource data_source, const ScorePage::ScorePageToken & token, uint32_t max_results, FetchScorePageCallback callback)
void
异步返回由分数页令牌标识的分数页数据。
FetchScorePageBlocking(const ScorePage::ScorePageToken & token)
同步返回由分数页令牌标识的分数页数据,直接返回 FetchScorePageResponse
FetchScorePageBlocking(DataSource data_source, const ScorePage::ScorePageToken & token)
同步返回由分数页令牌标识的分数页数据,直接返回 FetchScorePageResponse
FetchScorePageBlocking(Timeout timeout, const ScorePage::ScorePageToken & token)
同步返回由分数页令牌标识的分数页数据,直接返回 FetchScorePageResponse
FetchScorePageBlocking(const ScorePage::ScorePageToken & token, uint32_t max_results)
同步返回由分数页令牌标识的分数页数据,直接返回 FetchScorePageResponse
FetchScorePageBlocking(DataSource data_source, Timeout timeout, const ScorePage::ScorePageToken & token)
同步返回由分数页令牌标识的分数页数据,直接返回 FetchScorePageResponse
FetchScorePageBlocking(DataSource data_source, const ScorePage::ScorePageToken & token, uint32_t max_results)
同步返回由分数页令牌标识的分数页数据,直接返回 FetchScorePageResponse
FetchScorePageBlocking(Timeout timeout, const ScorePage::ScorePageToken & token, uint32_t max_results)
同步返回由分数页令牌标识的分数页数据,直接返回 FetchScorePageResponse
FetchScorePageBlocking(DataSource data_source, Timeout timeout, const ScorePage::ScorePageToken & token, uint32_t max_results)
同步返回由分数页令牌标识的分数页数据,直接返回 FetchScorePageResponse
FetchScoreSummary(const std::string & leaderboard_id, LeaderboardTimeSpan time_span, LeaderboardCollection collection, FetchScoreSummaryCallback callback)
void
异步获取特定排行榜分数摘要的所有数据,该摘要包含给定排行榜的集合和时间范围。
FetchScoreSummary(DataSource data_source, const std::string & leaderboard_id, LeaderboardTimeSpan time_span, LeaderboardCollection collection, FetchScoreSummaryCallback callback)
void
异步获取特定排行榜分数摘要的所有数据,该摘要包含给定排行榜的集合和时间范围。
FetchScoreSummaryBlocking(const std::string & leaderboard_id, LeaderboardTimeSpan time_span, LeaderboardCollection collection)
同步获取特定排行榜分数摘要的所有数据,直接返回 FetchScoreSummaryResponse
FetchScoreSummaryBlocking(DataSource data_source, const std::string & leaderboard_id, LeaderboardTimeSpan time_span, LeaderboardCollection collection)
同步获取特定排行榜分数摘要的所有数据,直接返回 FetchScoreSummaryResponse
FetchScoreSummaryBlocking(Timeout timeout, const std::string & leaderboard_id, LeaderboardTimeSpan time_span, LeaderboardCollection collection)
同步获取特定排行榜分数摘要的所有数据,直接返回 FetchScoreSummaryResponse
FetchScoreSummaryBlocking(DataSource data_source, Timeout timeout, const std::string & leaderboard_id, LeaderboardTimeSpan time_span, LeaderboardCollection collection)
同步获取特定排行榜分数摘要的所有数据,直接返回 FetchScoreSummaryResponse
ScorePageToken(const std::string & leaderboard_id, LeaderboardStart start, LeaderboardTimeSpan time_span, LeaderboardCollection collection) const
获取特定排行榜的分数页令牌,可按分数或玩家开始,涵盖特定时间范围和集合。
ShowAllUI(ShowAllUICallback callback)
void
向用户呈现一个显示所有排行榜信息的界面。
ShowAllUI()
void
已弃用。 优先使用 ShowAllUI(ShowAllUICallback callback)。向用户呈现一个显示所有排行榜信息的界面。此界面会在所有平台上异步显示。
ShowAllUIBlocking()
向用户呈现一个显示所有排行榜信息的界面。
ShowAllUIBlocking(Timeout timeout)
向用户呈现一个显示所有排行榜信息的界面。
ShowUI(const std::string & leaderboard_id, ShowUICallback callback)
void
向用户呈现一个显示特定排行榜信息的界面。
ShowUI(const std::string & leaderboard_id, LeaderboardTimeSpan time_span, ShowUICallback callback)
void
向用户呈现一个显示特定排行榜信息的界面。
ShowUI(const std::string & leaderboard_id)
void
已弃用。 优先使用 ShowUI(ShowUICallback callback)。向用户呈现一个显示特定排行榜信息的界面。此界面会在所有平台上异步显示。
ShowUIBlocking(const std::string & leaderboard_id)
向用户呈现一个显示特定排行榜信息的界面。
ShowUIBlocking(const std::string & leaderboard_id, LeaderboardTimeSpan time_span)
向用户呈现一个显示特定排行榜信息的界面。
ShowUIBlocking(Timeout timeout, const std::string & leaderboard_id)
向用户呈现一个显示特定排行榜信息的界面。
ShowUIBlocking(Timeout timeout, const std::string & leaderboard_id, LeaderboardTimeSpan time_span)
向用户呈现一个显示特定排行榜信息的界面。
SubmitScore(const std::string & leaderboard_id, uint64_t score)
void
为当前登录的玩家向排行榜提交分数。
SubmitScore(const std::string & leaderboard_id, uint64_t score, const std::string & metadata)
void
为当前登录的玩家向与特定 ID 和元数据(例如玩家赚取分数的行为)关联的排行榜提交分数。

结构体

gpg::LeaderboardManager::FetchAllResponse

包含所有排行榜的数据和响应状态。

gpg::LeaderboardManager::FetchAllScoreSummariesResponse

包含所有排行榜分数摘要的所有数据和响应状态。

gpg::LeaderboardManager::FetchResponse

保存排行榜数据以及响应状态。

gpg::LeaderboardManager::FetchScorePageResponse

返回访问的分数页的响应状态和数据。

gpg::LeaderboardManager::FetchScoreSummaryResponse

指定排行榜分数摘要的数据和响应状态。

公共类型

FetchAllCallback

std::function< void(const FetchAllResponse &)> FetchAllCallback

定义 FetchAllResponse 类型的回调。

FetchAllScoreSummariesCallback

std::function< void(const FetchAllScoreSummariesResponse &)> FetchAllScoreSummariesCallback

定义 FetchAllScoreSummariesResponse 类型的回调。

FetchCallback

std::function< void(const FetchResponse &)> FetchCallback

定义一个接收 FetchResponse 的回调类型。

此回调类型提供给下面的 Fetch(*) 函数。

FetchScorePageCallback

std::function< void(const FetchScorePageResponse &)> FetchScorePageCallback

定义 ScorePageResponse 类型的回调。

FetchScoreSummaryCallback

std::function< void(const FetchScoreSummaryResponse &)> FetchScoreSummaryCallback

定义 FetchScoreSummaryResponse 类型的回调。

ShowAllUICallback

std::function< void(const UIStatus &)> ShowAllUICallback

定义一个接收 UIStatus 的回调类型。

此回调类型提供给下面的 ShowAllUI* 函数。

ShowUICallback

std::function< void(const UIStatus &)> ShowUICallback

定义一个接收 UIStatus 的回调类型。

此回调类型提供给下面的 ShowUI* 函数。

公共函数

Fetch

void Fetch(
  const std::string & leaderboard_id,
  FetchCallback callback
)

异步加载当前登录玩家的排行榜数据。

在操作完成后调用提供的 FetchCallback。如果不指定 data_source,此函数调用相当于调用 Fetch(DataSource data_source, const std::string& leaderboard_id, FetchCallback callback) 并将 DataSource 指定为 CACHE_OR_NETWORK。

Fetch

void Fetch(
  DataSource data_source,
  const std::string & leaderboard_id,
  FetchCallback callback
)

异步加载当前登录玩家的排行榜数据。

在操作完成后调用提供的 FetchCallback。将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。

FetchAll

void FetchAll(
  FetchAllCallback callback
)

异步加载当前登录玩家的所有排行榜数据。

如果不指定 data_source,此函数调用相当于调用 FetchAll(DataSource data_source, FetchAllCallback callback) 并将 data_source 指定为 CACHE_OR_NETWORK。

FetchAll

void FetchAll(
  DataSource data_source,
  FetchAllCallback callback
)

异步加载当前登录玩家的所有排行榜数据。

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。

FetchAllBlocking

FetchAllResponse FetchAllBlocking()

同步加载当前登录玩家的所有排行榜数据,直接返回 FetchAllResponse

既不指定 data_source 也不指定 timeout 时,此函数调用相当于调用 FetchAllResponse FetchAllBlocking (DataSource data_source, Timeout timeout) 并将 data_source 指定为 CACHE_OR_NETWORK,将 timeout 指定为 10 年。

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  DataSource data_source
)

同步加载当前登录玩家的所有排行榜数据,直接返回 FetchAllResponse

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。如果不指定 timeout,此函数调用相当于调用 FetchAllResponseFetchAllBlocking(DataSource data_source, Timeout timeout),其中 data_source 的值为您指定的值,timeout 指定为 10 年。

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  Timeout timeout
)

同步加载当前登录玩家的所有排行榜数据,直接返回 FetchAllResponse

将 timeout 指定为任意毫秒数。如果不指定 data_source,此函数调用相当于调用 FetchAllResponseFetchAllBlocking(DataSource data_source, Timeout timeout),其中 data_source 指定为 CACHE_OR_NETWORK,timeout 包含您指定的值。

FetchAllBlocking

FetchAllResponse FetchAllBlocking(
  DataSource data_source,
  Timeout timeout
)

同步加载当前登录玩家的所有排行榜数据,直接返回 FetchAllResponse

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。将 timeout 指定为任意毫秒数。

FetchAllScoreSummaries

void FetchAllScoreSummaries(
  const std::string & leaderboard_id,
  FetchAllScoreSummariesCallback callback
)

异步获取特定排行榜的所有分数摘要。

如果不指定 data_source,此函数调用相当于调用 FetchAllScoreSummaries(DataSource data_source, const std::string& leaderboard_id, FetchAllScoreSummariesCallback callback) 并将 data_source 指定为 CACHE_OR_NETWORK。

FetchAllScoreSummaries

void FetchAllScoreSummaries(
  DataSource data_source,
  const std::string & leaderboard_id,
  FetchAllScoreSummariesCallback callback
)

异步获取特定排行榜的所有分数摘要。

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。

FetchAllScoreSummariesBlocking

FetchAllScoreSummariesResponse FetchAllScoreSummariesBlocking(
  const std::string & leaderboard_id
)

同步获取特定排行榜的所有分数摘要,直接返回 FetchAllScoreSummariesResponse

既不指定 data_source 也不指定 timeout 时,此函数调用相当于调用 FetchAllScoreSummariesResponse FetchAllScoreSummariesBlocking( DataSource data_source, const std::string& leaderboard_id),其中 data_source 指定为 CACHE_OR_NETWORK,将 timeout 指定为 10 年。

FetchAllScoreSummariesBlocking

FetchAllScoreSummariesResponse FetchAllScoreSummariesBlocking(
  DataSource data_source,
  const std::string & leaderboard_id
)

同步获取特定排行榜的所有分数摘要,直接返回 FetchAllScoreSummariesResponse

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。如果不指定 timeout,此函数调用相当于调用 FetchAllScoreSummariesResponse FetchAllScoreSummariesBlocking(DataSource data_source, const std::string& leaderboard_id),其中 data_source 的值为您指定的值,timeout 指定为 10 年。

FetchAllScoreSummariesBlocking

FetchAllScoreSummariesResponse FetchAllScoreSummariesBlocking(
  Timeout timeout,
  const std::string & leaderboard_id
)

同步获取特定排行榜的所有分数摘要,直接返回 FetchAllScoreSummariesResponse

以毫秒为单位指定 timeout。如果不指定 data_source,此函数调用相当于调用 FetchAllScoreSummariesResponse FetchAllScoreSummariesBlocking(DataSource data_source, std::string const &leaderboard_id),其中 data_source 指定为 CACHE_OR_NETWORK,timeout 包含您为其指定的值。

FetchAllScoreSummariesBlocking

FetchAllScoreSummariesResponse FetchAllScoreSummariesBlocking(
  DataSource data_source,
  Timeout timeout,
  const std::string & leaderboard_id
)

同步获取特定排行榜的所有分数摘要,直接返回 FetchAllScoreSummariesResponse

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。以毫秒为单位指定 timeout。

FetchBlocking

FetchResponse FetchBlocking(
  const std::string & leaderboard_id
)

同步加载当前登录玩家的排行榜数据,直接返回 FetchResponse

既不指定 data_source 也不指定 timeout 时,此函数调用相当于调用 FetchResponse FetchBlocking(DataSource data_source, Timeout timeout) 并将 data_source 指定为 CACHE_OR_NETWORK,将 timeout 指定为 10 年。

FetchBlocking

FetchResponse FetchBlocking(
  DataSource data_source,
  const std::string & leaderboard_id
)

同步加载当前登录玩家的排行榜数据,直接返回 FetchResponse

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。如果不指定 timeout,此函数调用相当于调用 FetchResponse FetchBlocking(DataSource data_source, Timeout timeout),其中 data_source 的值为您指定的值,timeout 指定为 10 年。

FetchBlocking

FetchResponse FetchBlocking(
  Timeout timeout,
  const std::string & leaderboard_id
)

同步加载当前登录玩家的排行榜数据,直接返回 FetchResponse

将 timeout 指定为任意毫秒数。如果不指定 data_source,此函数调用相当于调用 FetchResponse FetchBlocking(DataSource data_source, Timeout timeout),其中 data_source 指定为 CACHE_OR_NETWORK,timeout 包含您指定的值。

FetchBlocking

FetchResponse FetchBlocking(
  DataSource data_source,
  Timeout timeout,
  const std::string & leaderboard_id
)

同步加载当前登录玩家的排行榜数据。

直接返回 FetchResponse。将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。将 timeout 指定为任意毫秒数。

FetchScorePage

void FetchScorePage(
  const ScorePage::ScorePageToken & token,
  FetchScorePageCallback callback
)

异步返回由分数页令牌标识的分数页数据。

既不指定 data_source 也不指定 max_results 时,此函数调用相当于调用 FetchScorePage(DataSource data_source, const ScorePage::ScorePageToken& token, uint32_t max_results, FetchScorePageCallback callback) 并将 data_source 指定为 CACHE_OR_NETWORK,将 max_results 指定为 20。

FetchScorePage

void FetchScorePage(
  DataSource data_source,
  const ScorePage::ScorePageToken & token,
  FetchScorePageCallback callback
)

异步返回由分数页令牌标识的分数页数据。

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。如果不指定 max_results,此函数调用相当于调用 FetchScorePage(DataSource data_source, const ScorePage::ScorePageToken& token, uint32_t max_results, FetchScorePageCallback callback),其中 data_source 的值为您指定的值,max_results 指定为 20。

FetchScorePage

void FetchScorePage(
  const ScorePage::ScorePageToken & token,
  uint32_t max_results,
  FetchScorePageCallback callback
)

异步返回由分数页令牌标识的分数页数据。

max_results 指定了结果分数页中包含的最大分数数量,最大不超过 25。如果不指定 data_source,此函数调用相当于调用 FetchScorePage(DataSource data_source, const ScorePage::ScorePageToken& token, uint32_t max_results, FetchScorePageCallback callback),其中 data_source 指定为 CACHE_OR_NETWORK,max_results 包含您指定的值。

FetchScorePage

void FetchScorePage(
  DataSource data_source,
  const ScorePage::ScorePageToken & token,
  uint32_t max_results,
  FetchScorePageCallback callback
)

异步返回由分数页令牌标识的分数页数据。

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。max_results 指定了结果分数页中包含的最大分数数量,最大不超过 25。

FetchScorePageBlocking

FetchScorePageResponse FetchScorePageBlocking(
  const ScorePage::ScorePageToken & token
)

同步返回由分数页令牌标识的分数页数据,直接返回 FetchScorePageResponse

既不指定 data_source、timeout 也不指定 max_results 时,此函数调用相当于调用 FetchScorePageResponse FetchScorePageBlocking(DataSource data_source, Timeout timeout, const ScorePage::ScorePageToken& token, uint32_t max_results) 并将 data_source 指定为 CACHE_OR_NETWORK,将 timeout 指定为 10 年,将 max_results 指定为 20。

FetchScorePageBlocking

FetchScorePageResponse FetchScorePageBlocking(
  DataSource data_source,
  const ScorePage::ScorePageToken & token
)

同步返回由分数页令牌标识的分数页数据,直接返回 FetchScorePageResponse

既不指定 timeout 也不指定 max_results 时,此函数调用相当于调用 FetchScorePageResponse FetchScorePageBlocking(DataSource data_source, Timeout timeout, const ScorePage::ScorePageToken& token, uint32_t max_results),其中 data_source 的值为您指定的值,timeout 指定为 10 年,max_results 指定为 20。

FetchScorePageBlocking

FetchScorePageResponse FetchScorePageBlocking(
  Timeout timeout,
  const ScorePage::ScorePageToken & token
)

同步返回由分数页令牌标识的分数页数据,直接返回 FetchScorePageResponse

以毫秒为单位指定 timeout。既不指定 data_source 也不指定 max_results 时,此函数调用相当于调用 FetchScorePageResponse FetchScorePageBlocking(DataSource data_source, Timeout timeout, const ScorePage::ScorePageToken& token, uint32_t max_results),其中 data_source 指定为 CACHE_OR_NETWORK,timeout 包含您指定的值,max_results 指定为 20。

FetchScorePageBlocking

FetchScorePageResponse FetchScorePageBlocking(
  const ScorePage::ScorePageToken & token,
  uint32_t max_results
)

同步返回由分数页令牌标识的分数页数据,直接返回 FetchScorePageResponse

为 max_results 指定不超过 25 的值。既不指定 data_source 也不指定 timeout 时,此函数调用相当于调用 FetchScorePageResponse FetchScorePageBlocking(DataSource data_source, Timeout timeout, const ScorePage::ScorePageToken& token, uint32_t max_results) 并将 data_source 指定为 CACHE_OR_NETWORK,将 timeout 指定为 10 年,max_results 包含您指定的值。

FetchScorePageBlocking

FetchScorePageResponse FetchScorePageBlocking(
  DataSource data_source,
  Timeout timeout,
  const ScorePage::ScorePageToken & token
)

同步返回由分数页令牌标识的分数页数据,直接返回 FetchScorePageResponse

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。如果不指定 max_value,此函数调用相当于调用 FetchScorePageResponse FetchScorePageBlocking(DataSource data_source, Timeout timeout, const ScorePage::ScorePageToken& token, uint32_t max_results),其中 data_source 和 timeout 包含您指定的值,max_results 指定为 20。

FetchScorePageBlocking

FetchScorePageResponse FetchScorePageBlocking(
  DataSource data_source,
  const ScorePage::ScorePageToken & token,
  uint32_t max_results
)

同步返回由分数页令牌标识的分数页数据,直接返回 FetchScorePageResponse

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY,将 max_results 指定为不超过 25 的值。如果不指定 timeout,此函数调用相当于调用 FetchScorePageResponse FetchScorePageBlocking(DataSource data_source, Timeout timeout, const ScorePage::ScorePageToken& token, uint32_t max_results),其中 data_source 和 max_results 包含您指定的值,timeout 指定为 10 年。

FetchScorePageBlocking

FetchScorePageResponse FetchScorePageBlocking(
  Timeout timeout,
  const ScorePage::ScorePageToken & token,
  uint32_t max_results
)

同步返回由分数页令牌标识的分数页数据,直接返回 FetchScorePageResponse

以毫秒为单位指定 timeout,并将 max_results 指定为不超过 25 的值。如果不指定 data_source,此函数调用相当于调用 FetchScorePageResponse FetchScorePageBlocking(DataSource data_source, Timeout timeout, const ScorePage::ScorePageToken& token, uint32_t max_results),其中 timeout 和 max_results 包含您指定的值,data_source 指定为 CACHE_OR_NETWORK。

FetchScorePageBlocking

FetchScorePageResponse FetchScorePageBlocking(
  DataSource data_source,
  Timeout timeout,
  const ScorePage::ScorePageToken & token,
  uint32_t max_results
)

同步返回由分数页令牌标识的分数页数据,直接返回 FetchScorePageResponse

将 DataSource 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。将 Timeout 指定为任意毫秒数。将 max_results 指定为不超过 25 的值。

FetchScoreSummary

void FetchScoreSummary(
  const std::string & leaderboard_id,
  LeaderboardTimeSpan time_span,
  LeaderboardCollection collection,
  FetchScoreSummaryCallback callback
)

异步获取特定排行榜分数摘要的所有数据,该摘要包含给定排行榜的集合和时间范围。

将 DAILY、WEEKLY 或 ALL_TIME 指定为时间范围。将 PUBLIC 或 SOCIAL 指定为集合。如果不指定 data_source,此函数调用相当于调用 FetchScoreSummary(DataSource data_source, const std::string& leaderboard_id, LeaderboardTimeSpan time_span, LeaderboardCollection collection, FetchScoreSummaryCallback callback),其中 data_source 指定为 CACHE_OR_NETWORK,collection 和 time_span 包含您指定的值。

FetchScoreSummary

void FetchScoreSummary(
  DataSource data_source,
  const std::string & leaderboard_id,
  LeaderboardTimeSpan time_span,
  LeaderboardCollection collection,
  FetchScoreSummaryCallback callback
)

异步获取特定排行榜分数摘要的所有数据,该摘要包含给定排行榜的集合和时间范围。

将 CACHE_OR_NETWORK 或 NETWORK_ONLY 指定为 data_source。将 DAILY、WEEKLY 或 ALL_TIME 指定为 time_span。将 PUBLIC 或 SOCIAL 指定为 collection。

FetchScoreSummaryBlocking

FetchScoreSummaryResponse FetchScoreSummaryBlocking(
  const std::string & leaderboard_id,
  LeaderboardTimeSpan time_span,
  LeaderboardCollection collection
)

同步获取特定排行榜分数摘要的所有数据,直接返回 FetchScoreSummaryResponse

将 DAILY、WEEKLY 或 ALL_TIME 指定为时间范围。将 PUBLIC 或 SOCIAL 指定为集合。既不指定 data_source 也不指定 timeout 时,此函数相当于调用 FetchScoreSummaryResponse FetchScoreSummaryBlocking(DataSource data_source, Timeout timeout, const std::string& leaderboard_id, LeaderboardTimeSpan time_span, LeaderboardCollection collection),其中 data_source 指定为 CACHE_OR_NETWORK,timeout 指定为 10 年,time_span 和 collection 包含您指定的值。

FetchScoreSummaryBlocking

FetchScoreSummaryResponse FetchScoreSummaryBlocking(
  DataSource data_source,
  const std::string & leaderboard_id,
  LeaderboardTimeSpan time_span,
  LeaderboardCollection collection
)

同步获取特定排行榜分数摘要的所有数据,直接返回 FetchScoreSummaryResponse

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。将 DAILY、WEEKLY 或 ALL_TIME 指定为时间范围。将 PUBLIC 或 SOCIAL 指定为集合。如果不指定 timeout,此函数相当于调用 FetchScoreSummaryResponse FetchScoreSummaryBlocking(DataSource data_source, Timeout timeout, const std::string& leaderboard_id, LeaderboardTimeSpan time_span, LeaderboardCollection collection),其中 data_source 的值为您指定的值,timeout 指定为 10 年,time_span 和 collection 包含您指定的值。

FetchScoreSummaryBlocking

FetchScoreSummaryResponse FetchScoreSummaryBlocking(
  Timeout timeout,
  const std::string & leaderboard_id,
  LeaderboardTimeSpan time_span,
  LeaderboardCollection collection
)

同步获取特定排行榜分数摘要的所有数据,直接返回 FetchScoreSummaryResponse

以毫秒为单位指定 timeout。将 DAILY、WEEKLY 或 ALL_TIME 指定为时间范围。将 PUBLIC 或 SOCIAL 指定为集合。如果不指定 data_source,此函数相当于调用 FetchScoreSummaryResponse FetchScoreSummaryBlocking(DataSource data_source, Timeout timeout, const std::string& leaderboard_id, LeaderboardTimeSpan time_span, LeaderboardCollection collection),其中 timeout 指定为 10 年,data_source、time_span 和 collection 包含您指定的值。

FetchScoreSummaryBlocking

FetchScoreSummaryResponse FetchScoreSummaryBlocking(
  DataSource data_source,
  Timeout timeout,
  const std::string & leaderboard_id,
  LeaderboardTimeSpan time_span,
  LeaderboardCollection collection
)

同步获取特定排行榜分数摘要的所有数据,直接返回 FetchScoreSummaryResponse

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。以毫秒为单位指定 timeout。将 DAILY、WEEKLY 或 ALL_TIME 指定为时间范围。将 PUBLIC 或 SOCIAL 指定为集合。

ScorePageToken

ScorePage::ScorePageToken ScorePageToken(
  const std::string & leaderboard_id,
  LeaderboardStart start,
  LeaderboardTimeSpan time_span,
  LeaderboardCollection collection
) const 

获取特定排行榜的分数页令牌,可按分数或玩家开始,涵盖特定时间范围和集合。

ScorePageToken 用于允许分页浏览分数页的各种 Leaderboard 函数。由此函数创建的令牌将始终从请求范围的开头开始。

ShowAllUI

void ShowAllUI(
  ShowAllUICallback callback
)

向用户呈现一个显示所有排行榜信息的界面。

它会异步调用 ShowAllUICallback

ShowAllUI

void ShowAllUI()

已弃用。 优先使用 ShowAllUI(ShowAllUICallback callback)。向用户呈现一个显示所有排行榜信息的界面。此界面会在所有平台上异步显示。

ShowAllUIBlocking

UIStatus ShowAllUIBlocking()

向用户呈现一个显示所有排行榜信息的界面。

它会同步返回 UIStatus。如果不指定 timeout,此函数调用相当于调用 ShowAllUIBlocking(Timeout timeout) 并将 timeout 指定为 10 年。

ShowAllUIBlocking

UIStatus ShowAllUIBlocking(
  Timeout timeout
)

向用户呈现一个显示所有排行榜信息的界面。

它会同步返回 UIStatus。将 timeout 指定为任意毫秒数。

ShowUI

void ShowUI(
  const std::string & leaderboard_id,
  ShowUICallback callback
)

向用户呈现一个显示特定排行榜信息的界面。

它会异步调用 ShowUICallback

ShowUI

void ShowUI(
  const std::string & leaderboard_id,
  LeaderboardTimeSpan time_span,
  ShowUICallback callback
)

向用户呈现一个显示特定排行榜信息的界面。

它会异步调用 ShowUICallback,并会最初选择传入的 LeaderboardTimeSpan

ShowUI

void ShowUI(
  const std::string & leaderboard_id
)

已弃用。 优先使用 ShowUI(ShowUICallback callback)。向用户呈现一个显示特定排行榜信息的界面。此界面会在所有平台上异步显示。

ShowUIBlocking

UIStatus ShowUIBlocking(
  const std::string & leaderboard_id
)

向用户呈现一个显示特定排行榜信息的界面。

它会同步返回 UIStatus。如果不指定 timeout,此函数调用相当于调用 ShowUIBlocking(const string& leaderboard_id, Timeout timeout) 并将 timeout 指定为 10 年。

ShowUIBlocking

UIStatus ShowUIBlocking(
  const std::string & leaderboard_id,
  LeaderboardTimeSpan time_span
)

向用户呈现一个显示特定排行榜信息的界面。

它会同步返回 UIStatus。如果不指定 timeout,此函数调用相当于调用 ShowUIBlocking(const string& leaderboard_id, Timeout timeout) 并将 timeout 指定为 10 年。此界面最初会选择传入的 LeaderboardTimeSpan

ShowUIBlocking

UIStatus ShowUIBlocking(
  Timeout timeout,
  const std::string & leaderboard_id
)

向用户呈现一个显示特定排行榜信息的界面。

它会同步返回 UIStatus。将 timeout 指定为任意毫秒数。

ShowUIBlocking

UIStatus ShowUIBlocking(
  Timeout timeout,
  const std::string & leaderboard_id,
  LeaderboardTimeSpan time_span
)

向用户呈现一个显示特定排行榜信息的界面。

它会同步返回 UIStatus。将 timeout 指定为任意毫秒数。此界面最初会选择传入的 LeaderboardTimeSpan

SubmitScore

void SubmitScore(
  const std::string & leaderboard_id,
  uint64_t score
)

为当前登录的玩家向排行榜提交分数。

如果分数比同一玩家之前提交的分数差(由排行榜配置定义),则忽略该分数。

SubmitScore

void SubmitScore(
  const std::string & leaderboard_id,
  uint64_t score,
  const std::string & metadata
)

为当前登录的玩家向与特定 ID 和元数据(例如玩家赚取分数的行为)关联的排行榜提交分数。

如果分数比同一玩家之前提交的分数差(由排行榜配置定义),则忽略该分数。