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

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

SetClientId

Builder & SetClientId(
  int64_t client_id
)

この API のクライアント ID を設定します。この 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 を設定します。

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

~Builder

 ~Builder()