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 >
BuilderNearbyConnections オブジェクトを作成して作成するプラットフォームを指定します。
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

 Builder()

作成

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

BuilderNearbyConnections オブジェクトを作成して作成するプラットフォームを指定します。

成功すると、NearbyConnections オブジェクトに unique_ptr を返します。詳しくは、プラットフォームの構成のドキュメントをご覧ください。

SetClientId

Builder & SetClientId(
  int64_t client_id
)

コールバックによって返されるこの API のクライアント ID を設定します。

クライアント ID を使用すると、1 つのオブジェクトを複数の NearbyConnection インスタンスのリスナーとして登録し、各インスタンスでどのコールバックが返されるかを把握できます。この ID は Android では機能しません。

SetDefaultOnLog

Builder & SetDefaultOnLog(
  LogLevel min_level
)

指定したログレベルで DEFAULT_ON_LOG_CALLBACK をロギングに使用するよう指定します。

min_level は、アプリがデフォルトのコールバックを呼び出す最小ログレベルを指定します。

有効なレベルは VERBOSEINFOWARNINGERROR です。

この仕様は、OnLogCallbackDEFAULT_ON_LOG_CALLBACK に設定し、LogLevelmin_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
)

ロギングを行うコールバックを登録します。

これは、INFO の LogLevel で SetOnLog(OnLogCallback, LogLevel) を呼び出す場合と同じです。

SetServiceId

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

アドバタイジングに使用されるサービス ID を設定します。

この ID は Android では機能しませんが、他のプラットフォームでは広告掲載に必要になる場合があります。

~ビルダー

 ~Builder()