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()

创建

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 指定应用调用默认回调的最低日志级别。

可能的级别包括:VERBOSEINFOWARNINGERROR

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

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 设备上没有任何作用,但其他平台可能需要此 ID 才能投放广告。

~Builder

 ~Builder()