エントリーキー無効化関数
警告
以下の内容は iOS バージョン 4.4.2 以上に該当します。
概要
本ドキュメントでは、NetFUNNEL iOS エージェントが提供する関数を利用し、アプリケーションに保存されたエントリーキーを削除する機能について案内します。
エントリーキーの無効化
NetFUNNEL iOS エージェントは、待機状態が発生すると UserDefaults（アプリデータ）にキーを保存します。
エントリーパスを使用する場合、そのキーを再利用することで再度待機せずに入場が可能です。
「エントリーキー無効化」は、特定のタイミングでエントリーキーを無効化し、再び待機状態へ誘導したい場合に使用する機能です。
Netfunnel.shared.nfClear('{{PROJECT_KEY}}', '{{SEGMENT_KEY}}');
| パラメーター | 型 | 説明 |
|---|---|---|
projectKey | String? | 削除対象のプロジェクトキー |
segmentKey | String? | 削除対象のセグメントキー |
備考
エントリーキー無効化は、入力されたパラメータによって削除範囲が異なります。
projectKey と segmentKey の組み合わせにより、セグメント単位・プロジェクト単位・全体データ削除が区別されます。
| 区分 | projectKey | segmentKey | 削除範囲 |
|---|---|---|---|
| 1 | O | O | 対象プロジェクト内の特定セグメントのエントリーキーのみ削除 |
| 2 | O | X | 対象プロジェクト内のすべてのセグメントのエントリーキー削除 |
| 3 | X | X | 全てのプロジェクトおよびセグメントのエントリーキーを削除 |
// 例1: "service_1"プロジェクト内 "segKey_1234"セグメントのエントリーキーのみ削除
Netfunnel.shared.nfClear("service_1", "segKey_1234");
// 例2: "service_1"プロジェクト内のすべてのセグメントのエントリーキーを削除
Netfunnel.shared.nfClear("service_1", null);
// 例3: 全プロジェクト・全セグメントのエントリーキーをすべて削除
Netfunnel.shared.nfClear();