初期化設定
このドキュメントは、Netfunnel.initialize()関数で使用できるすべての初期化設定を説明します。
必須パラメータ
初期化関数にはclientIdパラメータが必要です。
Client IDの取得
Client IDの取得方法と初期化例については、クイックスタートドキュメントを参照してください。
ネットワーク設定
NetFUNNELサーバー通信のためのネットワーク動作とタイムアウトを制御します。
| パラメータ | デフォルト値 | 範囲 |
|---|---|---|
networkTimeout | 3000 | 100–10000 |
retryCount | 0 | 0–10 |
useNetworkRecoveryMode | false | true/false |
networkTimeout
NetFUNNELサーバーAPIリクエストが一時的な失敗と見なされる前の最大タイムアウト期間です。
| 属性 | 値 |
|---|---|
| 単位 | ミリ秒(ms) |
| 範囲 | 100–10000 |
| デフォルト値 | 3000 |
| 適用対象 | NetFUNNELサーバーエンドポイントのみ |
動作:
- タイムアウト内に応答なし → 一時的な失敗
- 即座のエラー応答 → タイムアウト待機なし
- 各再試行は同じタイムアウト設定を使用します
例:
networkTimeout: 1000→ 1秒タイムアウトnetworkTimeout: 5000→ 5秒タイムアウト
retryCount
NetFUNNELサーバーAPI呼び出しでの一時的な失敗に対する追加再試行回数です。
| 属性 | 値 |
|---|---|
| 範囲 | 0–10 |
| デフォルト値 | 0 |
| 公式 | 総試行回数 = (設定値) + 1 |
| 適用対象 | NetFUNNELサーバーエンドポイントのみ |
動作:
- 一時的な失敗 → 再試行トリガー（再試行回数 > 0の場合）
- 永続的な失敗 → すべての再試行試行を消耗
例:
retryCount: 0→ 総1回試行（再試行なし）retryCount: 2→ 総3回試行（初期 + 2回再試行）
useNetworkRecoveryMode
待機室が表示された状態でネットワーク接続が切断された場合、待機室を維持し、再接続を試みます。
| 属性 | 値 |
|---|---|
| 型 | Boolean |
| デフォルト値 | false |
| 動作 | trueの場合、networkTimeout基準で再接続を試みて待機室を維持 |
使用ケース:
- ユーザーが一時的なネットワーク中断を経験する可能性がある場合
- ユーザーがネットワーク問題によりキュー位置を失わないように保護
デバッグ設定
printLog
トラブルシューティングのためのデバッグログ出力を有効にします。
| 属性 | 値 |
|---|---|
| 型 | Boolean |
| デフォルト値 | false |
| 適用対象 | 開発およびデバッグ |
例:
Netfunnel.initialize({
clientId: 'your-client-id',
printLog: true // コンソールロギングを有効化
});
使用時期:
- 開発およびテスト中
- 統合問題のトラブルシューティング時
- NetFUNNEL動作の理解
注意: パフォーマンス向上のため、本番環境では無効にしてください。
エラー処理設定
errorBypass
エラー発生時にトラフィック制御をバイパスします。
| 属性 | 値 |
|---|---|
| 型 | Boolean |
| デフォルト値 | false |
| 動作 | trueの場合、NetFUNNELがエラーに遭遇するとサービスアクセスを許可します |
使用ケース:
- NetFUNNELが利用できない場合の優雅な性能低下
- NetFUNNEL問題中にもサービスが継続するように保証
サーバー構成
serverUrl
カスタムNetFUNNELサーバーアドレスです。
| 属性 | 値 |
|---|---|
| 型 | String |
| デフォルト値 | デフォルトNetFUNNELサーバーURL |
使用時期:
- カスタムNetFUNNELサーバー展開
- オンプレミスインストール
- 特殊なネットワーク構成
errorUrl
カスタムNetFUNNELエラーページHTMLアドレスです。
| 属性 | 値 |
|---|---|
| 型 | String |
| デフォルト値 | デフォルトエラーページURL |
使用時期:
- カスタムエラーページデザイン
- ブランドエラー体験
- ローカライズされたエラーメッセージ
待機室設定
useNetfunnelTemplate
コンソールからカスタムNetFUNNEL待機室テンプレートを使用します。
| 属性 | 値 |
|---|---|
| 型 | Boolean |
| デフォルト値 | true |
| 動作 | trueの場合、コンソールで構成したカスタムテンプレートを使用します |
使用時期:
- カスタムブランド待機室
- ローカライズされた待機室コンテンツ
- 特殊な待機室デザイン
ユーザー識別
userId
ブラックリスト/ホワイトリスト確認のためのエンドユーザー固有識別子です。
| 属性 | 値 |
|---|---|
| 型 | String |
| デフォルト値 | null |
使用ケース:
- ユーザー別アクセス制御
- ブラックリスト/ホワイトリスト管理
- VIPユーザー処理
例:
Netfunnel.initialize({
clientId: 'your-client-id',
userId: 'user_12345' // アクセス制御のためのユーザー識別子
});
完全な構成例
import Netfunnel from 'netfunnel-rn-agent';
Netfunnel.initialize({
// 必須
clientId: 'your-client-id',
// ネットワーク設定
networkTimeout: 3000,
retryCount: 0,
useNetworkRecoveryMode: false,
// デバッグ
printLog: false,
// エラー処理
errorBypass: false,
// サーバー構成
serverUrl: undefined, // デフォルト値を使用
errorUrl: undefined, // デフォルト値を使用
// 待機室
useNetfunnelTemplate: true,
// ユーザー識別
userId: null
});
パラメータ検証
clientId
- 必須
- 型: String
- 検証: 空文字列は不可
- ソース: NetFUNNELコンソール → プロフィールアイコン →
統合資格情報（Integration Credentials）
networkTimeout
- オプション
- 型: Number
- 範囲: 100–10000（ミリ秒）
- デフォルト値: 3000
retryCount
- オプション
- 型: Number
- 範囲: 0–10
- デフォルト値: 0
printLog
- オプション
- 型: Boolean
- デフォルト値: false
errorBypass
- オプション
- 型: Boolean
- デフォルト値: false
useNetfunnelTemplate
- オプション
- 型: Boolean
- デフォルト値: true
userId
- オプション
- 型: Stringまたはnull
- デフォルト値: null
useNetworkRecoveryMode
- オプション
- 型: Boolean
- デフォルト値: false
関連ドキュメント
- インストールと初期化: 初期化例を含む設定ガイド
- APIリファレンス: 関数仕様と使用方法
- トラブルシューティング: 一般的な問題と解決方法