メインコンテンツまでスキップ

setNextDataFieldPath

setNextDataFieldPath

WebSocket(Socket)Providerの次ページ要求時に使用する「次データキー」のフィールドパスを設定します。

パラメータ

  • provInstNameString): Provider Instanceの名前。"piName""piName.provInfoName"のどちらの形式も可能
  • blockPathString): 応答OutBlock内で次ページキーが格納されているフィールドパス(例: "E2738OutBlock2.nextbutton_attr"

戻り値: boolean — 成功した場合はtrue、該当のPIが存在しない場合やSocketProvInfoでない場合はfalse

説明

WebSocket(SocketProvInfo)専用です。REST API Providerには適用されません。

サーバー応答の特定のOutBlockフィールドから「次の要求に使用するキー」を読み取るよう設定します。以降requestNextDataを呼び出すと、そのフィールドの値が自動的に次の要求に含まれます。

Example

// E2738_0 PI의 응답에서 E2738OutBlock2.nextbutton_attr 필드를 다음 키로 사용
$vm.setNextDataFieldPath('E2738_0', 'E2738OutBlock2.nextbutton_attr');

// 이후 다음 페이지 요청
if ($vm.hasMoreNextData('E2738_0')) {
$vm.requestNextData('E2738_0');
}

関連

  • $vm.requestNextData(provInstName) — 次のページのデータを要求
  • $vm.hasMoreNextData(provInstName) — 次のページの有無を確認