gpg::NearbyConnections::Builder

#include <nearby_connections_builder.h>

用于构建 NearbyConnections 对象的 Builder 类。

摘要

构造函数和析构函数
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，回调会返回此 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

 Builder()

Create

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

指定 Builder 要为其创建 NearbyConnections 对象的平台，然后尝试创建该对象。

如果成功，它将返回指向 NearbyConnections 对象的 unique_ptr。有关详细信息，请参阅平台配置文档。

SetClientId

Builder & SetClientId(
  int64_t client_id
)

为此 API 设置客户端 ID，回调会返回此 ID。

客户端 ID 允许单个对象注册为多个 NearbyConnection 实例的监听器，并能区分哪些回调属于哪些实例。此 ID 在 Android 上不起作用。

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。

SetOnInitializationFinished

Builder & SetOnInitializationFinished(
  OnInitializationFinishedCallback callback
)

注册一个回调，应用在初始化完成后会调用此回调。

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

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

SetOnLog

Builder & SetOnLog(
  OnLogCallback callback,
  LogLevel min_level
)

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

min_level 指定最低日志级别。按升序排列，可能的级别包括：VERBOSE、INFO、WARNING 和 ERROR。

SetOnLog

Builder & SetOnLog(
  OnLogCallback callback
)

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

这相当于调用 SetOnLog(OnLogCallback, LogLevel)，其中 LogLevel 为 INFO。

SetServiceId

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

设置一个在广播时使用的服务 ID。

此 ID 在 Android 上不起作用，但其他平台可能需要它才能广播。

~Builder

 ~Builder()