gpg:: PlayerManager
#include <player_manager.h>
获取和设置各种与玩家相关的数据。
摘要
公共类型 |
|
---|---|
FetchCallback
|
typedefstd::function< void(const FetchResponse &)>
定义用于接收 FetchResponse 的回调类型。 |
FetchListCallback
|
typedefstd::function< void(const FetchListResponse &)>
定义用于接收 FetchListResponse 的回调类型。 |
FetchSelfCallback
|
typedefstd::function< void(const FetchSelfResponse &)>
定义用于接收 FetchSelfResponse 的回调类型。 |
结构体 |
|
---|---|
gpg:: |
包含玩家矢量的响应。 |
gpg:: |
特定播放器的 |
gpg:: |
包含所有玩家数据以及响应状态。 |
公共类型
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(*)
函数。
公共函数
提取
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。
提取
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,timeout 指定为 10 年。
FetchBlocking
FetchResponse FetchBlocking( DataSource data_source, const std::string & player_id )
同步加载特定玩家的所有数据,直接返回 FetchResponse。
将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。如果不指定超时时间,此函数调用等同于调用 FetchResponse FetchBlocking(DataSource data_source, Timeout timeout),其中指定了 data_source 值,并将超时时间指定为 10 年。
FetchBlocking
FetchResponse FetchBlocking( Timeout timeout, const std::string & player_id )
同步加载特定玩家的所有数据,直接返回 FetchResponse。
将超时指定为任意毫秒数。如果不指定 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。将超时指定为任意毫秒数。
FetchConnected
void FetchConnected( DataSource data_source, FetchListCallback callback )
异步加载已连接到当前游戏且已登录玩家有权了解的所有玩家。
在操作完成时调用所提供的 FetchCallback。将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。
请注意,如果 Player.HasLevelInfo 返回 false,此函数可能会返回 Player 对象。在这种情况下,您可以通过 Fetch API 重新请求指定玩家,以检索等级信息。 已废弃。
FetchConnected
void FetchConnected( FetchListCallback callback )
FetchConnected 的过载,使用默认的 data_source 为 CACHE_OR_NETWORK。
FetchConnectedBlocking
FetchListResponse FetchConnectedBlocking( DataSource data_Source, Timeout timeout )
FetchConnected 的阻塞版本。
允许调用方指定超时时间(以毫秒为单位)。指定时间过后,该函数会返回 ERROR_TIMEOUT
。请注意,在 iOS 上,无法从界面线程调用此阻塞版本,因为提供数据的底层 Plus 服务必须在界面线程上运行操作。
已废弃。
FetchConnectedBlocking
FetchListResponse FetchConnectedBlocking( DataSource data_source )
FetchConnectedBlocking 的过载,其默认超时时间为 10 年。
FetchConnectedBlocking
FetchListResponse FetchConnectedBlocking( Timeout timeout )
FetchConnectedBlocking 的过载,使用默认的 data_source 为 CACHE_OR_NETWORK。
FetchConnectedBlocking
FetchListResponse FetchConnectedBlocking()
FetchConnectedBlocking 的过载,其默认 data_source 为 CACHE_OR_NETWORK,默认超时为 10 年。
FetchInvitable
void FetchInvitable( DataSource data_source, FetchListCallback callback )
异步加载本地玩家圈子中的所有玩家(并且可以接收本地玩家发来的邀请)。
请注意,如果可邀请的玩家尚未连接到当前游戏,则可能不会收到任何邀请通知。
在操作完成时调用所提供的 FetchCallback。将 data_source 指定为 CACHE_OR_NETWORK 或 NETWORK_ONLY。
请注意,如果 Player.HasLevelInfo 返回 false,此函数可能会返回 Player 对象。在这种情况下,您可以通过 Fetch API 重新请求指定玩家,以检索等级信息。 已废弃。
FetchInvitable
void FetchInvitable( FetchListCallback callback )
FetchInvitable 的过载,使用默认的 data_source 为 CACHE_OR_NETWORK。
FetchInvitableBlocking
FetchListResponse FetchInvitableBlocking( DataSource data_source, Timeout timeout )
FetchInvitable 的阻塞版本。
允许调用方指定超时时间(以毫秒为单位)。指定时间过后,该函数会返回 ERROR_TIMEOUT
。请注意,在 iOS 上,无法从界面线程调用此阻塞版本,因为提供数据的底层 Plus 服务必须在界面线程上运行操作。
已废弃。
FetchInvitableBlocking
FetchListResponse FetchInvitableBlocking( DataSource data_source )
FetchInvitableBlocking 的过载,其默认超时时间为 10 年。
FetchInvitableBlocking
FetchListResponse FetchInvitableBlocking( Timeout timeout )
FetchInvitableBlocking 的过载,其使用默认 data_source 为 CACHE_OR_NETWORK。
FetchInvitableBlocking
FetchListResponse FetchInvitableBlocking()
FetchInvitableBlocking 的过载,其默认 data_source 为 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 的过载,使用默认的 data_source 为 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 的过载,该方法使用默认的 data_source 为 CACHE_OR_NETWORK。
FetchRecentlyPlayedBlocking
FetchListResponse FetchRecentlyPlayedBlocking()
FetchRecentlyPlayedBlocking 的过载,其默认 data_source 为 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。如果不指定超时时间,此函数调用等同于调用 FetchSelfResponse FetchSelfBlocking(DataSource data_source, Timeout timeout),其中指定了 data_source 值,并将超时时间指定为 10 年。
FetchSelfBlocking
FetchSelfResponse FetchSelfBlocking( Timeout timeout )
同步加载当前所有已登录玩家的所有数据,直接返回 FetchSelfResponse。
将超时指定为任意毫秒数。如果未指定 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。将超时指定为任意毫秒数。