Fence API の概要

Awareness API では、フェンスというコンセプトは、ジオフェンス(ジオフェンス)が定義されており、ユーザーがジオフェンスのリージョンに出入りしたときにコールバックを受信します。Fence API は、ジオフェンスの概念を拡張し、地理的近接性に加えて、他の多くのコンテキスト条件を含めます。アプリは、コンテキスト状態が遷移するたびにコールバックを受け取ります。たとえば、アプリでヘッドフォン用のフェンスを定義する場合、ヘッドフォンを接続している場合と、電源に接続していない場合にコールバックを行います。

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

  • ユーザーの現在地(緯度と経度)
  • ウォーキングや車など、ユーザーの現在のアクティビティ。
  • デバイス固有の条件(ヘッドフォンが接続されているかどうかなど)
  • 付近のビーコンへのアクセス

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

  • ユーザーがヘッドフォンを接続して歩き始めます。
  • ユーザーが平日の午後 5 時までに 100 m のジオフェンスに入る。
  • ユーザーが特定の 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);
        }
    }
}