エントリーキー無効化関数
警告
以下の内容は Android バージョン 4.4.2 以上に該当します。
概要
本ドキュメントでは、NetFUNNEL Android Agent がアプリケーションに保存されたエントリーキー(入場キー)を削除するために提供する関数について説明します。
エントリーキーの無効化
キュー待ちが発生すると、NetFUNNEL Android Agent はエントリーキーを SharedPreferences(アプリデータ)の専用 xml に保存します。
エントリーパスを使用する場合、そのキーを再利用することで再度待機することなく入場できます。
ただし、特定のタイミングでエントリーキーを無効化し、再度キュー待ち処理を誘導したい場合にこの関数を利用します。
Netfunnel.nfClear(
activity,
"{{PROJECT_KEY}}",
"{{SEGMENT_KEY}}"
)
| パラメーター | 型 | 説明 |
|---|---|---|
activity | Activity | 現在のアクティビティ画面 |
projectKey | String? | 削除したいプロジェクトキー |
segmentKey | String? | 削除したいセグメントキー |
備考
入力されたパラメータによって削除の範囲が異なります。 projectKey および segmentKey の組み合わせにより、特定セグメント、プロジェクト全体、もしくは全データの削除を選択できます。
| 区分 | projectKey | segmentKey | 削除範囲 |
|---|---|---|---|
| 1 | O | O | 対象プロジェクトの特定セグメントのエントリーキーのみ削除 |
| 2 | O | X | 対象プロジェクト内、すべてのセグメントのエントリーキーを削除 |
| 3 | X | X | すべてのプロジェクトおよびセグメントのエントリーキーを全削除 |
// 例1: "service_1" プロジェクト内 "segKey_1234" セグメントのエントリーキーのみ削除
Netfunnel.nfClear(activity, "service_1", "segKey_1234")
// 例2: "service_1" プロジェクトのすべてのセグメントのエントリーキーを削除
Netfunnel.nfClear(activity, "service_1", null)
// 例3: すべてのプロジェクトおよびセグメントのエントリーキーを全削除
Netfunnel.nfClear(activity, null, null)