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