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