gpg::PlayerManager

#include <player_manager.h>

获取和设置各种与玩家相关的数据。

摘要

公共类型
FetchCallback typedef
std::function< void(const FetchResponse &)>
定义一个接收FetchResponse 的回调类型。
FetchListCallback typedef
std::function< void(const FetchListResponse &)>
定义一个接收FetchListResponse 的回调类型。
FetchSelfCallback typedef
std::function< void(const FetchSelfResponse &)>
定义一个接收FetchSelfResponse 的回调类型。

公共函数
Fetch(const std::string & player_id, FetchCallback callback)
void
异步加载特定玩家的所有数据。
Fetch(DataSource data_source, const std::string & player_id, FetchCallback callback)
void
异步加载特定玩家的所有数据。
FetchBlocking(const std::string & player_id)
同步加载特定玩家的所有数据，直接返回FetchResponse。
FetchBlocking(DataSource data_source, const std::string & player_id)
同步加载特定玩家的所有数据，直接返回FetchResponse。
FetchBlocking(Timeout timeout, const std::string & player_id)
同步加载特定玩家的所有数据，直接返回FetchResponse。
FetchBlocking(DataSource data_source, Timeout timeout, const std::string & player_id)
同步加载特定玩家的所有数据，直接返回FetchResponse。
FetchConnected(DataSource data_source, FetchListCallback callback)
void
已弃用。
异步加载所有已连接到当前游戏且已登录玩家有权了解的玩家。
FetchConnected(FetchListCallback callback)
void
已弃用。
FetchConnected 的重载函数，使用默认数据源 CACHE_OR_NETWORK。
FetchConnectedBlocking(DataSource data_Source, Timeout timeout) 已弃用。
FetchConnected 的阻塞版本。
FetchConnectedBlocking(DataSource data_source) 已弃用。
FetchConnectedBlocking 的重载函数，使用默认超时时间为 10 年。
FetchConnectedBlocking(Timeout timeout) 已弃用。
FetchConnectedBlocking 的重载函数，使用默认数据源 CACHE_OR_NETWORK。
FetchConnectedBlocking() 已弃用。
FetchConnectedBlocking 的重载函数，使用默认数据源 CACHE_OR_NETWORK 和默认超时时间为 10 年。
FetchInvitable(DataSource data_source, FetchListCallback callback)
void
已弃用。
异步加载所有在本地玩家圈子内（并且可以接收来自本地玩家的邀请）的玩家。
FetchInvitable(FetchListCallback callback)
void
已弃用。
FetchInvitable 的重载函数，使用默认数据源 CACHE_OR_NETWORK。
FetchInvitableBlocking(DataSource data_source, Timeout timeout) 已弃用。
FetchInvitable 的阻塞版本。
FetchInvitableBlocking(DataSource data_source) 已弃用。
FetchInvitableBlocking 的重载函数，使用默认超时时间为 10 年。
FetchInvitableBlocking(Timeout timeout) 已弃用。
FetchInvitableBlocking 的重载函数，使用默认数据源 CACHE_OR_NETWORK。
FetchInvitableBlocking() 已弃用。
FetchInvitableBlocking 的重载函数，使用默认数据源 CACHE_OR_NETWORK 和默认超时时间为 10 年。
FetchRecentlyPlayed(DataSource data_source, FetchListCallback callback)
void
异步加载所有最近玩游戏的玩家。
FetchRecentlyPlayed(FetchListCallback callback)
void
FetchRecentlyPlayed 的重载函数，使用默认数据源 CACHE_OR_NETWORK。
FetchRecentlyPlayedBlocking(DataSource data_source, Timeout timeout)
FetchRecentlyPlayed 的阻塞版本。
FetchRecentlyPlayedBlocking(DataSource data_source)
FetchRecentlyPlayedBlocking 的重载函数，使用默认超时时间为 10 年。
FetchRecentlyPlayedBlocking(Timeout timeout)
FetchRecentlyPlayedBlocking 的重载函数，使用默认数据源 CACHE_OR_NETWORK。
FetchRecentlyPlayedBlocking()
FetchRecentlyPlayedBlocking 的重载函数，使用默认数据源 CACHE_OR_NETWORK 和默认超时时间为 10 年。
FetchSelf(FetchSelfCallback callback)
void
异步加载所有当前已登录玩家的数据。
FetchSelf(DataSource data_source, FetchSelfCallback callback)
void
异步加载所有当前已登录玩家的数据。
FetchSelfBlocking()
同步加载所有当前已登录玩家的数据，直接返回FetchSelfResponse。
FetchSelfBlocking(DataSource data_source)
同步加载所有当前已登录玩家的数据，直接返回FetchSelfResponse。
FetchSelfBlocking(Timeout timeout)
同步加载所有当前已登录玩家的数据，直接返回FetchSelfResponse。
FetchSelfBlocking(DataSource data_source, Timeout timeout)
同步加载所有当前已登录玩家的数据，直接返回FetchSelfResponse。

结构体
gpg::PlayerManager::FetchListResponse

包含玩家向量的响应。
gpg::PlayerManager::FetchResponse

特定Player 的data 和 ResponseStatus。
gpg::PlayerManager::FetchSelfResponse

保存所有玩家数据以及响应状态。

公共类型

FetchCallback

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

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

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

FetchListCallback

std::function< void(const FetchListResponse &)> FetchListCallback

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

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

FetchSelfCallback

std::function< void(const FetchSelfResponse &)> FetchSelfCallback

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

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

公共函数

Fetch

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

异步加载特定玩家的所有数据。

在操作完成后调用提供的 FetchCallback。不指定 data_source 使此函数调用等效于调用 Fetch(DataSource data_source, const std::string& player_id, FetchCallback callback)，其中 data_source 指定为 CACHE_OR_NETWORK。

Fetch

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

异步加载特定玩家的所有数据。

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

FetchBlocking

FetchResponse FetchBlocking(
  const std::string & player_id
)

同步加载特定玩家的所有数据，直接返回FetchResponse。

既不指定 data_source 也 不指定 timeout 使此函数调用等效于调用 FetchResponse FetchBlocking(DataSource data_source, timeout timeout)，其中 DataSource 指定为 CACHE_OR_NETWORK，超时时间指定为 10 年。

FetchBlocking

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

同步加载特定玩家的所有数据，直接返回FetchResponse。

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。不指定 timeout 使此函数调用等效于调用 FetchResponse FetchBlocking(DataSource data_source, Timeout timeout)，使用您指定的 data_source 值，超时时间指定为 10 年。

FetchBlocking

FetchResponse FetchBlocking(
  Timeout timeout,
  const std::string & player_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 & player_id
)

同步加载特定玩家的所有数据，直接返回FetchResponse。

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

FetchConnected

void FetchConnected(
  DataSource data_source,
  FetchListCallback callback
)

异步加载所有已连接到当前游戏且已登录玩家有权了解的玩家。

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

请注意，此函数可能会返回 Player 对象，其中 Player.HasLevelInfo 返回 false。在这种情况下，可以通过 Fetch API 重新请求给定玩家来检索级别信息。 已弃用。

FetchConnected

void FetchConnected(
  FetchListCallback callback
)

FetchConnected 的重载函数，使用默认数据源 CACHE_OR_NETWORK。

已弃用。

FetchConnectedBlocking

FetchListResponse FetchConnectedBlocking(
  DataSource data_Source,
  Timeout timeout
)

FetchConnected 的阻塞版本。

允许调用者以毫秒为单位指定超时时间。超过指定时间后，函数返回 ERROR_TIMEOUT。请注意，在 iOS 上，此阻塞版本不能从 UI 线程调用，因为提供数据的底层 plus 服务必须在 UI 线程上运行操作。 已弃用。

FetchConnectedBlocking

FetchListResponse FetchConnectedBlocking(
  DataSource data_source
)

FetchConnectedBlocking 的重载函数，使用默认超时时间为 10 年。

已弃用。

FetchConnectedBlocking

FetchListResponse FetchConnectedBlocking(
  Timeout timeout
)

FetchConnectedBlocking 的重载函数，使用默认数据源 CACHE_OR_NETWORK。

已弃用。

FetchConnectedBlocking

FetchListResponse FetchConnectedBlocking()

FetchConnectedBlocking 的重载函数，使用默认数据源 CACHE_OR_NETWORK 和默认超时时间为 10 年。

已弃用。

FetchInvitable

void FetchInvitable(
  DataSource data_source,
  FetchListCallback callback
)

异步加载所有在本地玩家圈子内（并且可以接收来自本地玩家的邀请）的玩家。

请注意，如果可邀请玩家尚未连接到当前游戏，他们可能不会收到任何邀请通知。

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

请注意，此函数可能会返回 Player 对象，其中 Player.HasLevelInfo 返回 false。在这种情况下，可以通过 Fetch API 重新请求给定玩家来检索级别信息。 已弃用。

FetchInvitable

void FetchInvitable(
  FetchListCallback callback
)

FetchInvitable 的重载函数，使用默认数据源 CACHE_OR_NETWORK。

已弃用。

FetchInvitableBlocking

FetchListResponse FetchInvitableBlocking(
  DataSource data_source,
  Timeout timeout
)

FetchInvitable 的阻塞版本。

允许调用者以毫秒为单位指定超时时间。超过指定时间后，函数返回 ERROR_TIMEOUT。请注意，在 iOS 上，此阻塞版本不能从 UI 线程调用，因为提供数据的底层 plus 服务必须在 UI 线程上运行操作。 已弃用。

FetchInvitableBlocking

FetchListResponse FetchInvitableBlocking(
  DataSource data_source
)

FetchInvitableBlocking 的重载函数，使用默认超时时间为 10 年。

已弃用。

FetchInvitableBlocking

FetchListResponse FetchInvitableBlocking(
  Timeout timeout
)

FetchInvitableBlocking 的重载函数，使用默认数据源 CACHE_OR_NETWORK。

已弃用。

FetchInvitableBlocking

FetchListResponse FetchInvitableBlocking()

FetchInvitableBlocking 的重载函数，使用默认数据源 CACHE_OR_NETWORK 和默认超时时间为 10 年。

已弃用。

FetchRecentlyPlayed

void FetchRecentlyPlayed(
  DataSource data_source,
  FetchListCallback callback
)

异步加载所有最近玩游戏的玩家。

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

FetchRecentlyPlayed

void FetchRecentlyPlayed(
  FetchListCallback callback
)

FetchRecentlyPlayed 的重载函数，使用默认数据源 CACHE_OR_NETWORK。

FetchRecentlyPlayedBlocking

FetchListResponse FetchRecentlyPlayedBlocking(
  DataSource data_source,
  Timeout timeout
)

FetchRecentlyPlayed 的阻塞版本。

允许调用者以毫秒为单位指定超时时间。超过指定时间后，函数返回 ERROR_TIMEOUT。

FetchRecentlyPlayedBlocking

FetchListResponse FetchRecentlyPlayedBlocking(
  DataSource data_source
)

FetchRecentlyPlayedBlocking 的重载函数，使用默认超时时间为 10 年。

FetchRecentlyPlayedBlocking

FetchListResponse FetchRecentlyPlayedBlocking(
  Timeout timeout
)

FetchRecentlyPlayedBlocking 的重载函数，使用默认数据源 CACHE_OR_NETWORK。

FetchRecentlyPlayedBlocking

FetchListResponse FetchRecentlyPlayedBlocking()

FetchRecentlyPlayedBlocking 的重载函数，使用默认数据源 CACHE_OR_NETWORK 和默认超时时间为 10 年。

FetchSelf

void FetchSelf(
  FetchSelfCallback callback
)

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

在操作完成后调用提供的 FetchSelfCallback。不指定 data_source 使此函数调用等效于调用 FetchSelf(DataSource data_source, FetchSelfCallback callback)，其中 data_source 指定为 CACHE_OR_NETWORK。

FetchSelf

void FetchSelf(
  DataSource data_source,
  FetchSelfCallback callback
)

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

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

FetchSelfBlocking

FetchSelfResponse FetchSelfBlocking()

同步加载所有当前已登录玩家的数据，直接返回FetchSelfResponse。

不指定 data_source 或 timeout 使此函数调用等效于调用 FetchSelfResponse FetchSelfBlocking(DataSource data_source, Timeout timeout)，其中 data_source 指定为 CACHE_OR_NETWORK，timeout 指定为 10 年。

FetchSelfBlocking

FetchSelfResponse FetchSelfBlocking(
  DataSource data_source
)

同步加载所有当前已登录玩家的数据，直接返回FetchSelfResponse。

将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。不指定 timeout 使此函数调用等效于调用 FetchSelfResponse FetchSelfBlocking(DataSource data_source, Timeout timeout)，使用您指定的 data_source 值，并将 timeout 指定为 10 年。

FetchSelfBlocking

FetchSelfResponse FetchSelfBlocking(
  Timeout timeout
)

同步加载所有当前已登录玩家的数据，直接返回FetchSelfResponse。

将 timeout 指定为任意毫秒数。不指定 data_source 使此函数调用等效于调用 FetchSelfResponse FetchSelfBlocking(DataSource data_source, Timeout timeout)，其中 data_source 指定为 CACHE_OR_NETWORK，timeout 包含您指定的值。

FetchSelfBlocking

FetchSelfResponse FetchSelfBlocking(
  DataSource data_source,
  Timeout timeout
)

同步加载所有当前已登录玩家的数据，直接返回FetchSelfResponse。

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