gpg::GameServices::Builder

#include <builder.h>

用于创建和配置 GameServices 类的实例。

摘要

构造函数和析构函数

Builder()
~Builder()

公共类型

OnAuthActionFinishedCallback typedef
std::function< void(AuthOperation, AuthStatus)>
可向 SDK 提供的身份验证操作完成回调的类型。
OnAuthActionStartedCallback typedef
std::function< void(AuthOperation)>
可向 SDK 提供的身份验证操作启动的回调函数的类型。
OnLogCallback typedef
std::function< void(LogLevel, const std::string &)>
可以向 SDK 提供的日志记录回调的类型。
OnMultiplayerInvitationEventCallback typedef
std::function< void(MultiplayerEvent, std::string, MultiplayerInvitation)>
可以向 SDK 提供的多人游戏邀请回调的类型。
OnTurnBasedMatchEventCallback typedef
std::function< void(MultiplayerEvent event, std::string, TurnBasedMatch)>
可以向 SDK 提供的基于回合的多人游戏事件回调函数的类型。

公共函数

AddOauthScope(const std::string & scope)
请求的范围超出了要求的 Play 游戏范围。
Create(const PlatformConfiguration & platform)
std::unique_ptr< GameServices >
采用平台配置并尝试返回新实例化的 GameServices 对象。
EnableSnapshots()
启用快照。
SetDefaultOnLog(LogLevel min_level)
指定日志记录应在指定的日志级别使用 DEFAULT_ON_LOG_CALLBACK。
SetLogging(OnLogCallback callback, LogLevel min_level) 已弃用。 首选 SetOnLog 和 SetDefaultOnLog。注册一个将用于执行日志记录的回调。min_level 用于指定调用该回调函数时的最低日志级别。可能的级别为:VERBOSE、INFO、WARNING 和 ERROR。
SetLogging(OnLogCallback callback) 已弃用。 首选 SetOnLog 和 SetDefaultOnLog。注册一个用于执行日志记录的回调,这与使用 INFO 的 LogLevel 调用 SetLogging(OnLogCallback, LogLevel) 相同。
SetOnAuthActionFinished(OnAuthActionFinishedCallback callback)
注册在授权完成后调用的回调。
SetOnAuthActionStarted(OnAuthActionStartedCallback callback)
注册在授权开始时调用的回调。
SetOnLog(OnLogCallback callback, LogLevel min_level)
注册用于执行日志记录的回调。
SetOnLog(OnLogCallback callback)
注册用于执行日志记录的回调。
SetOnMultiplayerInvitationEvent(OnMultiplayerInvitationEventCallback callback)
注册在多人游戏邀请事件发生时调用的回调。
SetOnTurnBasedMatchEvent(OnTurnBasedMatchEventCallback callback)
注册在回合制多人游戏对局发生事件时调用的回调。
SetShowConnectingPopup(bool show_popup)
设置是否应在登录流程开始时自动显示“正在连接”弹出式窗口。

公共类型

OnAuthActionFinishedCallback

std::function< void(AuthOperation, AuthStatus)> OnAuthActionFinishedCallback

可向 SDK 提供的身份验证操作完成回调的类型。

OnAuthActionStartedCallback

std::function< void(AuthOperation)> OnAuthActionStartedCallback

可向 SDK 提供的身份验证操作启动的回调函数的类型。

OnLogCallback

std::function< void(LogLevel, const std::string &)> OnLogCallback

可以向 SDK 提供的日志记录回调的类型。

OnMultiplayerInvitationEventCallback

std::function< void(MultiplayerEvent, std::string, MultiplayerInvitation)> OnMultiplayerInvitationEventCallback

可以向 SDK 提供的多人游戏邀请回调的类型。

Valid() 只会针对 UPDATED 事件针对 MultiplayerInvitation 返回 true。

OnTurnBasedMatchEventCallback

std::function< void(MultiplayerEvent event, std::string, TurnBasedMatch)> OnTurnBasedMatchEventCallback

可以向 SDK 提供的基于回合的多人游戏事件回调函数的类型。

Valid() 仅针对 UPDATED 事件针对 TurnBasedMatch 参数返回 true。

公共函数

AddOauthScope

Builder & AddOauthScope(
  const std::string & scope
)

请求的范围超出了要求的 Play 游戏范围。

如需详细了解授权范围,请访问 https://developers.google.com/+/api/oauth#scopes

构建器

 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 用于指定调用默认回调函数时的最低日志级别。可能的级别为:VERBOSE、INFO、WARNING 和 ERROR。这等同于调用 SetOnLog(OnLogCallback, LogLevel),并将 OnLogCallback 设置为 DEFAULT_ON_LOG_CALLBACK 且 LogLevel 为 min_level。

SetLogging

Builder & SetLogging(
  OnLogCallback callback,
  LogLevel min_level
)

已弃用。 首选 SetOnLog 和 SetDefaultOnLog。注册一个将用于执行日志记录的回调。min_level 用于指定调用该回调函数时的最低日志级别。可能的级别为:VERBOSE、INFO、WARNING 和 ERROR。

SetLogging

Builder & SetLogging(
  OnLogCallback callback
)

已弃用。 首选 SetOnLog 和 SetDefaultOnLog。注册一个用于执行日志记录的回调,这与使用 INFO 的 LogLevel 调用 SetLogging(OnLogCallback, LogLevel) 相同。

SetOnAuthActionFinished

Builder & SetOnAuthActionFinished(
  OnAuthActionFinishedCallback callback
)

注册在授权完成后调用的回调。

SetOnAuthActionStarted

Builder & SetOnAuthActionStarted(
  OnAuthActionStartedCallback callback
)

注册在授权开始时调用的回调。

SetOnLog

Builder & SetOnLog(
  OnLogCallback callback,
  LogLevel min_level
)

注册用于执行日志记录的回调。

min_level 用于指定调用回调函数的最低日志级别。可能的级别为:VERBOSE、INFO、WARNING 和 ERROR。

SetOnLog

Builder & SetOnLog(
  OnLogCallback callback
)

注册用于执行日志记录的回调。

这等同于调用 LogLevel 为 INFO 的 SetOnLog(OnLogCallback, LogLevel)

SetOnMultiplayerInvitationEvent

Builder & SetOnMultiplayerInvitationEvent(
  OnMultiplayerInvitationEventCallback callback
)

注册在多人游戏邀请事件发生时调用的回调。

SetOnTurnBasedMatchEvent

Builder & SetOnTurnBasedMatchEvent(
  OnTurnBasedMatchEventCallback callback
)

注册在回合制多人游戏对局发生事件时调用的回调。

SetShowConnectingPopup

Builder & SetShowConnectingPopup(
  bool show_popup
)

设置是否应在登录流程开始时自动显示“正在连接”弹出式窗口。

此选项默认处于启用状态。

~构建器

 ~Builder()