公開と登録

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

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

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

公開と購読がアクティブな場合、「付近のユーザーが使用中」という通知が表示され、付近のユーザーがアクティブであることをユーザーに知らせます。この通知は、1 つ以上のアプリが Nearby を積極的に使用している場合にのみ表示されます。ユーザーは、Nearby が不要な場合はバッテリーを節約できます。ユーザーには次のオプションが用意されています。

  • アプリに移動して Nearby を無効にします。
  • アプリが Nearby を使用することを強制的に停止します。
  • [付近の設定] 画面に移動します。

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

Nearby メッセージ API は電池駆動時間に影響する可能性があるため、フォアグラウンド アクティビティからのみ使用する必要があります(BLE バックグラウンド サブスクライブを除く)。

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

@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);
}