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,这些 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 指定应用程序调用默认回调函数的最低日志级别。

可能的级别为:VERBOSEINFOWARNINGERROR

此规范等效于使用 OnLogCallback 设置为 DEFAULT_ON_LOG_CALLBACKLogLevelmin_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
)

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

这等效于使用 LogLevelINFO 调用 SetOnLog(OnLogCallback, LogLevel)

SetServiceId

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

设置在进行广告宣传时使用的服务 ID。

此 ID 在 Android 上没有任何作用,但其他平台可能需要它才能进行广告宣传。

~Builder

 ~Builder()