公開と登録

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

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

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

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

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

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

Nearby Messages 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() メソッドで公開停止を呼び出す必要があります。公開に使用したのと同じ 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);
}