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 Games 范围的范围。
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。注册一个用于执行日志记录的回调。与调用 SetLogging(OnLogCallback, LogLevel) 并将 LogLevel 设置为 INFO 的效果相同。
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 Games 范围的范围。

有关授权范围的详细信息,请参见 https://developers.google.com/+/api/oauth#scopes

Builder

 Builder()

Create

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。注册一个用于执行日志记录的回调。与调用 SetLogging(OnLogCallback, LogLevel) 并将 LogLevel 设置为 INFO 的效果相同。

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
)

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

这等同于调用 SetOnLog(OnLogCallback, LogLevel) 并将 LogLevel 设置为 INFO。

SetOnMultiplayerInvitationEvent

Builder & SetOnMultiplayerInvitationEvent(
  OnMultiplayerInvitationEventCallback callback
)

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

SetOnTurnBasedMatchEvent

Builder & SetOnTurnBasedMatchEvent(
  OnTurnBasedMatchEventCallback callback
)

注册一个在发生回合制多人游戏匹配事件时调用的回调。

SetShowConnectingPopup

Builder & SetShowConnectingPopup(
  bool show_popup
)

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

默认情况下,此功能已启用。

~Builder

 ~Builder()