Fence API の概要

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

Awareness API では、フェンスの概念はジオフェンスに基づいています。ジオフェンスとは、地理的領域(ジオフェンス)が定義されており、ユーザーがジオフェンス領域を出入りしたときにアプリがコールバックを受け取る仕組みです。フェンス API は、ジオフェンスのコンセプトを拡張し、地理的近さに加えて、他の多くのコンテキスト条件を含めます。アプリは、コンテキスト状態が遷移するたびにコールバックを受け取ります。たとえば、アプリがヘッドフォンのフェンスを定義している場合は、ヘッドフォンが接続されているときと、プラグが抜かれたときにコールバックを受け取ります。

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

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

フェンス 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);
        }
    }
}