gpg::NearbyConnections::Builder

#include <nearby_connections_builder.h>

Builder 类,用于构建 NearbyConnections 对象。

摘要

构造函数和析构函数

Builder()
~Builder()

公共类型

OnInitializationFinishedCallback typedef
std::function< void(InitializationStatus)>
应用在初始化 API 时或初始化失败时调用的回调。
OnLogCallback typedef
std::function< void(LogLevel, const std::string &)>
可以向 SDK 提供的日志记录回调的类型。

公共函数

Create(const PlatformConfiguration & platform)
std::unique_ptr< NearbyConnections >
指定 Builder 针对哪个平台创建 NearbyConnections 对象,然后尝试创建该对象。
SetClientId(int64_t client_id)
为此 API 设置由回调返回的客户端 ID。
SetDefaultOnLog(LogLevel min_level)
指定日志记录应在指定的日志级别使用 DEFAULT_ON_LOG_CALLBACK
SetOnInitializationFinished(OnInitializationFinishedCallback callback)
注册应用在初始化完成后调用的回调。
SetOnLog(OnLogCallback callback, LogLevel min_level)
注册将执行日志记录的回调。
SetOnLog(OnLogCallback callback)
注册将执行日志记录的回调。
SetServiceId(const std::string & service_id)
设置通告时使用的服务 ID。

公共类型

OnInitializationFinishedCallback

std::function< void(InitializationStatus)> OnInitializationFinishedCallback

应用在初始化 API 时或初始化失败时调用的回调。

OnLogCallback

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

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

公共函数

构建器

 Builder()

创建

std::unique_ptr< NearbyConnections > Create(
  const PlatformConfiguration & platform
)

指定 Builder 针对哪个平台创建 NearbyConnections 对象,然后尝试创建该对象。

如果成功,则会向 NearbyConnections 对象返回 unique_ptr。如需了解详情,请参阅有关平台配置的文档。

SetClientId

Builder & SetClientId(
  int64_t client_id
)

为此 API 设置由回调返回的客户端 ID。

客户端 ID 允许将单个对象注册为多个 NearbyConnection 实例的监听器,并告知系统会为哪些实例返回哪些回调。此 ID 在 Android 上没有任何作用。

SetDefaultOnLog

Builder & SetDefaultOnLog(
  LogLevel min_level
)

指定日志记录应在指定的日志级别使用 DEFAULT_ON_LOG_CALLBACK

min_level 指定应用调用默认回调的最低日志级别。

可能的级别为:VERBOSEINFOWARNINGERROR

此规范等同于调用 SetOnLog(OnLogCallback, LogLevel),并将 OnLogCallback 设置为 DEFAULT_ON_LOG_CALLBACKLogLevelmin_level

SetOnInitializationFinished

Builder & SetOnInitializationFinished(
  OnInitializationFinishedCallback callback
)

注册应用在初始化完成后调用的回调。

应用必须在调用 Create 之前调用此方法。应用可能会多次调用回调。例如,如果用户接到电话,然后返回到应用,NearbyConnections 会重新初始化并再次调用此回调。

请注意,必须先调用此回调,然后才能使用 NearbyConnections 对象。

SetOnLog

Builder & SetOnLog(
  OnLogCallback callback,
  LogLevel min_level
)

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

min_level 用于指定最低日志级别。按升序排列,可能的级别为:VERBOSEINFOWARNINGERROR

SetOnLog

Builder & SetOnLog(
  OnLogCallback callback
)

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

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

SetServiceId

Builder & SetServiceId(
  const std::string & service_id
)

设置通告时使用的服务 ID。

此 ID 在 Android 上没有任何作用,但其他平台可能需要使用它才能投放广告。

~构建器

 ~Builder()