公開と登録

Nearby Messages は、近くのデバイスが小さなデータ ペイロードを交換できるパブリッシュ / サブスクライブ API です。デバイスがメッセージを公開すると、近くのデバイスがそのメッセージを受信できるようになります。このガイドでは、Nearby Messages API を使用してメッセージを公開し、メッセージをサブスクライブするためにアプリに実装する必要があるすべての機能について説明します。

近くのデバイスのセットは、Bluetooth を介した小さなトークンの交換によって決定されます。デバイスが近くのデバイスからトークンを検出すると、そのトークンを Nearby Messages サーバーに送信して検証し、アプリの現在のサブスクリプション セットに配信するメッセージがあるかどうかを確認します。

アプリは、デバイスの検出に使用されるメディアのセットと、メディアがトークンのブロードキャストとトークンのスキャンに使用されるかどうかを制御できます。 デフォルトでは、すべてのメディアでブロードキャストとスキャンが行われます。メディアのサブセットで検出を行い、ブロードキャストまたはスキャンを行うかどうかを制御するには、パブリケーションとサブスクリプションを作成するときに追加のパラメータを渡す必要があります。

アクティブに公開とサブスクライブを行っている場合は、「Nearby が使用中です」という通知が表示され、Nearby がアクティブであることをユーザーに知らせます。この通知は、1 つ以上のアプリが Nearby をアクティブに使用している場合にのみ表示されます。これにより、Nearby が不要な場合は電池の消費を抑えることができます。ユーザーは次のオプションを選択できます。

  • アプリに移動して Nearby を無効にする。
  • アプリで Nearby の使用を強制的に停止する。
  • [ニアバイシェアの設定] 画面に移動する。

PublishCallback() と SubscribeCallback() を使用すると、ユーザーがアプリで Nearby の使用を強制的に停止した場合にリッスンできます。この場合、 メソッドがトリガーされます。onExpired()

Nearby Messages API は電池の消費に影響を与える可能性があるため、 フォアグラウンド アクティビティからのみ使用する必要があります（ BLE バックグラウンド サブスクライブを除く）。

Nearby Messages API を使用するには、publish() または subscribe() を呼び出します。アプリは常に 対称的に unpublish() と unsubscribe() で onStop()を行う必要があります。

@Override
public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    ...
    mMessageListener = new MessageListener() {
        @Override
        public void onFound(Message message) {
            Log.d(TAG, "Found message: " + new String(message.getContent()));
        }

        @Override
        public void onLost(Message message) {
            Log.d(TAG, "Lost sight of message: " + new String(message.getContent()));
        }
    }

    mMessage = new Message("Hello World".getBytes());
}

@Override
public void onStart() {
    super.onStart();
    ...
    Nearby.getMessagesClient(this).publish(mMessage);
    Nearby.getMessagesClient(this).subscribe(mMessageListener);
}

@Override
public void onStop() {
    Nearby.getMessagesClient(this).unpublish(mMessage);
    Nearby.getMessagesClient(this).unsubscribe(mMessageListener);
    ...
    super.onStop();
}

メッセージの公開

メッセージを公開するには、メッセージのバイト配列を渡して Nearby.getMessagesClient(Activity).publish() を呼び出します。メッセージは 3 KB 未満にすることをおすすめします。このサイズのメッセージはより迅速に配信できます。ただし、必要なアプリの場合は最大 100 KB までサポートできます。このサービスは、写真や動画などの大きなオブジェクトの交換を目的としたものではありません。

必要に応じて、PublishOptions.setStrategy() を呼び出して使用するストラテジ を設定できます。

次の例では、publish() を呼び出して小さなテキスト メッセージを送信しています。

private void publish(String message) {
    Log.i(TAG, "Publishing message: " + message);
    mActiveMessage = new Message(message.getBytes());
    Nearby.getMessagesClient(this).publish(mActiveMessage);
}

メッセージの公開を停止

メッセージの公開を停止するには、unpublish() を呼び出します。アプリは少なくとも アプリは onStop() メソッドで unpublish を呼び出す必要があります。公開に使用したのと同じ Message オブジェクトを渡します（mActiveMessage この例では）。

次のコード例では、unpublish() を呼び出しています。

private void unpublish() {
    Log.i(TAG, "Unpublishing.");
    if (mActiveMessage != null) {
        Nearby.getMessagesClient(this).unpublish(mActiveMessage);
        mActiveMessage = null;
    }
}

メッセージをサブスクライブする

他のデバイスからのメッセージをサブスクライブするには、Nearby.getMessagesClient(Activity).subscribe() を呼び出します。サブスクライブしたメッセージの受信を処理する MessageListener を渡す必要があります。

必要に応じて、SubscribeOptions.setStrategy() を呼び出して使用するストラテジ を設定できます。

次の例では、メッセージをサブスクライブしています。

public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    ...
    mMessageListener = new MessageListener() {
        @Override
        public void onFound(Message message) {
            Log.d(TAG, "Found message: " + new String(message.getContent()));
        }

        @Override
        public void onLost(Message message) {
            Log.d(TAG, "Lost sight of message: " + new String(message.getContent()));
        }
    }
}

// Subscribe to receive messages.
private void subscribe() {
    Log.i(TAG, "Subscribing.");
    Nearby.getMessagesClient(this).subscribe(mMessageListener, options);
}

サブスクライブを解除する

デバイス メッセージの配信を停止するには、 Nearby.getMessagesClient(Activity).unsubscribe() を呼び出します。サブスクライブに使用したのと同じ MessageListener オブジェクトを渡します（この例ではmMessageListener）。

次のコード例では、サブスクライブを解除しています。

private void unsubscribe() {
    Log.i(TAG, "Unsubscribing.");
    Nearby.getMessagesClient(this).unsubscribe(mMessageListener);
}