Fence API の概要

Awareness API のフェンスの概念は、ジオフェンシングから取られています。ジオフェンシングでは、地理的領域（ジオフェンス）が定義され、ユーザーがジオフェンス領域に出入りしたときにアプリがコールバックを受け取ります。Fence API は、地理的な近接性に加えて、他の多くのコンテキスト条件を含めるようにジオフェンシングのコンセプトを拡張します。コンテキストの状態が遷移するたびに、アプリはコールバックを受け取ります。たとえば、アプリがヘッドホンのフェンスを定義している場合、ヘッドホンが接続されたときと取り外されたときにコールバックを受け取ります。

Fence API を使用して、次のようなコンテキスト シグナルに基づいてフェンスを定義できます。

  • ユーザーの現在地（緯度/経度）
  • 歩行や運転など、ユーザーの現在のアクティビティ。
  • ヘッドフォンが接続されているかどうかなど、デバイス固有の条件。
  • 近くにあるビーコンとの距離

Fence API を使用すると、複数のコンテキスト シグナルを組み合わせて、AND、OR、NOT のブール演算子でフェンスを作成できます。フェンス条件が満たされるたびに、アプリはコールバックを受け取ります。フェンスの例としては、次のようなものがあります。

  • ユーザーがヘッドフォンを接続して歩き始めます。
  • ユーザーが平日の午後 5 時までに 100 メートルのジオフェンスに入った。
  • ユーザーが特定の BLE ビーコンの範囲に入ります。

次の例は、ユーザーが歩くたびにアクティブになるフェンスを定義する方法を示しています。

AwarenessFence walkingFence = DetectedActivityFence.during(DetectedActivityFence.WALKING);

フェンスを定義したら、次の操作を行う必要があります。

  • updateFences を呼び出して、コールバックを受信するようにフェンスを登録します。
  • フェンスの状態が変化したときに呼び出すことができるコールバックを定義します。

次の例は、フェンスを作成して登録するメソッドを示しています。この例では、フェンスがトリガーされたときにインテントを処理するために、BroadcastReceiver のカスタム サブクラスが使用されています。

Awareness.getFenceClient(this).updateFences(new FenceUpdateRequest.Builder()
    .addFence(FENCE_KEY, exercisingWithHeadphonesFence, mPendingIntent)
    .build())
    .addOnSuccessListener(new OnSuccessListener<Void>() {
        @Override
        public void onSuccess(Void aVoid) {
            Log.i(TAG, "Fence was successfully registered.");
        }
    })
    .addOnFailureListener(new OnFailureListener() {
        @Override
        public void onFailure(@NonNull Exception e) {
            Log.e(TAG, "Fence could not be registered: " + e);
        }
    });
public class FenceReceiver extends BroadcastReceiver {
    @Override
    public void onReceive(Context context, Intent intent) {

        FenceState fenceState = FenceState.extract(intent);

        if (TextUtils.equals(fenceState.getFenceKey(), FENCE_KEY)) {
            String fenceStateStr;
            switch (fenceState.getCurrentState()) {
                case FenceState.TRUE:
                    fenceStateStr = "true";
                    break;
                case FenceState.FALSE:
                    fenceStateStr = "false";
                    break;
                case FenceState.UNKNOWN:
                    fenceStateStr = "unknown";
                    break;
                default:
                    fenceStateStr = "unknown value";
            }
            mLogFragment.getLogView().println("Fence state: " + fenceStateStr);
        }
    }
}