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