onCheckUpdateValid

応答（または購読データ）が正常に届いたあと、連携するData Setに実際に反映してよいかを判断する時点で呼び出されます。

パラメータ

provInstName（string）: Provider Instanceの名前

戻り値: 戻り値は使用されません。代わりに、この関数の中で$vm.setCancelData(provInstName, true)を呼び出すと、後続のData Setへの反映がキャンセルされます。

説明

通常の要求が成功したとき、または購読で新しいデータが届いたときに、Data Setへ実際に反映する直前に一度だけ呼び出されます。反映を止めたい場合は、この関数の中で$vm.setCancelData(provInstName, true)を呼び出します。反映の可否を決めるのは戻り値ではなく、このAPI呼び出しです。 通常の要求の応答更新（onResponseUpdateBefore）とリアルタイム購読データの更新（onPushUpdateBefore）の両方で共通して呼び出され、「この値を画面に反映してよいか」を最後に確認する役割を担います。

Example

function onCheckUpdateValid(provInstName) {
  if (shouldSkipUpdate(provInstName)) {
    $vm.setCancelData(provInstName, true);
  }
}

関連と注意事項

通常の要求が成功したときはonResponseUpdateBefore/onResponseUpdateAfterの前に、購読データを受信したときはonPushUpdateBefore/onPushUpdateAfterの前に、共通して呼び出されます。
失敗（エラー）応答の経路では呼び出されません。成功経路専用です。
$vm.setCancelData(provInstName, true)を呼び出すと、その後のonResponseUpdateBefore/onPushUpdateBefore自体がまったく呼び出されず、反映は丸ごとキャンセルされます。

onCheckUpdateValid​

onCheckUpdateValid