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 を設定します。
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 を使用すると、1 つのオブジェクトを複数の NearbyConnection インスタンスのリスナーとして登録し、どのコールバックがどのインスタンスに対して返されるかがわかります。この ID は Android では何も行われません。

SetDefaultOnLog

Builder & SetDefaultOnLog(
  LogLevel min_level
)

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

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

指定可能なレベルは VERBOSE、INFO、WARNING、ERROR です。

この仕様は、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 は、最小ログレベルを指定します。昇順にできるレベルは、VERBOSE、INFO、WARNING、ERROR です。

SetOnLog

Builder & SetOnLog(
  OnLogCallback callback
)

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

これは、LogLevel に INFO を指定して SetOnLog(OnLogCallback, LogLevel) を呼び出すことと同等です。

SetServiceId

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

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

Android ではこの ID は行われませんが、他のプラットフォームでは広告を掲載するためにこの ID が必要になる場合があります。

施工者

 ~Builder()