gpg:: GameServices:: Builder
#include <builder.h>
用于创建和配置 GameServices 类的实例。
摘要
构造函数和析构函数 |
|
---|---|
Builder()
|
|
~Builder()
|
公共类型 |
|
---|---|
OnAuthActionFinishedCallback
|
typedefstd::function< void(AuthOperation, AuthStatus)>
可提供给 SDK 的身份验证操作完成回调的类型。 |
OnAuthActionStartedCallback
|
typedefstd::function< void(AuthOperation)>
可提供给 SDK 的身份验证操作启动回调的类型。 |
OnLogCallback
|
typedefstd::function< void(LogLevel, const std::string &)>
可向 SDK 提供的日志记录回调类型。 |
OnMultiplayerInvitationEventCallback
|
typedefstd::function< void(MultiplayerEvent, std::string, MultiplayerInvitation)>
可向 SDK 提供的多人游戏邀请回调的类型。 |
OnTurnBasedMatchEventCallback
|
typedefstd::function< void(MultiplayerEvent event, std::string, TurnBasedMatch)>
可提供给 SDK 的基于回合的多人游戏事件回调的类型。 |
公共函数 |
|
---|---|
AddOauthScope(const std::string & scope)
|
Builder &
请求的范围超出了所需的 Play 游戏范围。
|
Create(const PlatformConfiguration & platform)
|
std::unique_ptr< GameServices >
接受平台配置,并尝试返回新实例化的 GameServices 对象。
|
EnableSnapshots()
|
Builder &
启用快照。
|
SetDefaultOnLog(LogLevel min_level)
|
Builder &
指定日志记录应在指定的日志级别使用 DEFAULT_ON_LOG_CALLBACK。
|
SetLogging(OnLogCallback callback, LogLevel min_level)
|
Builder &
|
SetLogging(OnLogCallback callback)
|
Builder &
|
SetOnAuthActionFinished(OnAuthActionFinishedCallback callback)
|
Builder &
注册要在授权完成时调用的回调。
|
SetOnAuthActionStarted(OnAuthActionStartedCallback callback)
|
Builder &
注册要在授权开始时调用的回调。
|
SetOnLog(OnLogCallback callback, LogLevel min_level)
|
Builder &
注册用于执行日志记录的回调。
|
SetOnLog(OnLogCallback callback)
|
Builder &
注册用于执行日志记录的回调。
|
SetOnMultiplayerInvitationEvent(OnMultiplayerInvitationEventCallback callback)
|
Builder &
注册一个回调,以便在发生多人游戏邀请事件时调用。
|
SetOnTurnBasedMatchEvent(OnTurnBasedMatchEventCallback callback)
|
Builder &
注册一个回调,以便在基于回合的多人游戏比赛发生事件时调用。
|
SetShowConnectingPopup(bool show_popup)
|
Builder &
设置在登录流程开始时是否应自动显示“正在连接”弹出式窗口。
|
公共类型
OnAuthActionFinishedCallback
std::function< void(AuthOperation, AuthStatus)> OnAuthActionFinishedCallback
可提供给 SDK 的身份验证操作完成回调的类型。
OnAuthActionStartedCallback
std::function< void(AuthOperation)> OnAuthActionStartedCallback
可提供给 SDK 的身份验证操作启动回调的类型。
OnMultiplayerInvitationEventCallback
std::function< void(MultiplayerEvent, std::string, MultiplayerInvitation)> OnMultiplayerInvitationEventCallback
可向 SDK 提供的多人游戏邀请回调的类型。
对于更新型事件,Valid() 仅针对 MultiplayerInvitation 返回 true。
OnTurnBasedMatchEventCallback
std::function< void(MultiplayerEvent event, std::string, TurnBasedMatch)> OnTurnBasedMatchEventCallback
可提供给 SDK 的基于回合的多人游戏事件回调的类型。
对于更新型事件,Valid() 仅针对 TurnBasedMatch 参数返回 true。
公共函数
AddOauthScope
Builder & AddOauthScope( const std::string & scope )
请求的范围超出了所需的 Play 游戏范围。
如需详细了解授权范围,请访问 https://developers.google.com/+/api/oauth#scopes。
Builder
Builder()
创建
std::unique_ptr< GameServices > Create( const PlatformConfiguration & platform )
接受平台配置,并尝试返回新实例化的 GameServices 对象。
如果提供无效的 PlatformConfiguration(即 !platform.Valid()),则会返回 nullptr;如果已实例化其他 GameServices 对象,也可能会返回 nullptr。
如需了解详情,请参阅 IosPlatformConfiguration、AndroidPlatformConfiguration 和 PlatformConfiguration 的文档:https://developers.google.com/games/services/cpp/api/platform__configuration_8h
EnableSnapshots
Builder & EnableSnapshots()
启用快照。
这等同于 AddOauthScope(kSnapshotScope)
。如需了解详情,请参阅 SnapshotManager。
SetDefaultOnLog
Builder & SetDefaultOnLog( LogLevel min_level )
指定日志记录应在指定的日志级别使用 DEFAULT_ON_LOG_CALLBACK。
min_level 用于指定调用默认回调的最低日志级别。可能的级别包括:详细、信息、警告和错误。这相当于调用 SetOnLog(OnLogCallback, LogLevel),并将 OnLogCallback 设置为 DEFAULT_ON_LOG_CALLBACK,LogLevel 设置为 min_level。
SetLogging
Builder & SetLogging( OnLogCallback callback, LogLevel min_level )
已废弃。 请优先使用 SetOnLog 和 SetDefaultOnLog。注册用于执行日志记录的回调。min_level 用于指定调用回调的最低日志级别。可能的级别包括:详细、信息、警告和错误。
SetLogging
Builder & SetLogging( OnLogCallback callback )
已废弃。 请优先使用 SetOnLog 和 SetDefaultOnLog。注册将用于执行日志记录的回调。这与将 LogLevel 设为 INFO 调用 SetLogging(OnLogCallback, LogLevel) 相同。
SetOnAuthActionFinished
Builder & SetOnAuthActionFinished( OnAuthActionFinishedCallback callback )
注册要在授权完成时调用的回调。
SetOnAuthActionStarted
Builder & SetOnAuthActionStarted( OnAuthActionStartedCallback callback )
注册要在授权开始时调用的回调。
SetOnLog
Builder & SetOnLog( OnLogCallback callback, LogLevel min_level )
注册用于执行日志记录的回调。
min_level 用于指定调用回调的最低日志级别。可能的级别包括:详细、信息、警告和错误。
SetOnLog
Builder & SetOnLog( OnLogCallback callback )
注册用于执行日志记录的回调。
这相当于调用 SetOnLog(OnLogCallback, LogLevel),并将 LogLevel 设为 INFO。
SetOnMultiplayerInvitationEvent
Builder & SetOnMultiplayerInvitationEvent( OnMultiplayerInvitationEventCallback callback )
注册一个回调,以便在发生多人游戏邀请事件时调用。
SetOnTurnBasedMatchEvent
Builder & SetOnTurnBasedMatchEvent( OnTurnBasedMatchEventCallback callback )
注册一个回调,以便在基于回合的多人游戏比赛发生事件时调用。
SetShowConnectingPopup
Builder & SetShowConnectingPopup( bool show_popup )
设置在登录流程开始时是否应自动显示“正在连接”弹出式窗口。
默认情况下,此功能处于启用状态。
~Builder
~Builder()