executeBatch
executeBatch メソッドを使用して、ランタイム・サーバーへの 1 つの要求で、複数のメソッドを実行できます。
function callExecuteBatch(commandsToExecute, callback) {
if (!commandsToExecute)
return ;
InteractAPI.executeBatch(commandsToExecute.ssid,
commandsToExecute.commands, callback);
}
- session ID - セッション ID を識別する文字列。このセッション ID は、このメソッド呼び出しによって実行されるすべてのコマンドに使用されます。
- commands - コマンド・オブジェクトの配列 (実行するコマンドごとに 1 つずつ)。
- callback - メソッドが成功した場合、コールバック関数は onSuccess を呼び出します。メソッドが失敗した場合、コールバック関数は onError を呼び出します。
このメソッドの呼び出しの結果は、Command 配列内の各メソッドを明示的に呼び出す場合と同じです。このメソッドは、ランタイム・サーバーへの実際の要求の数を最小限に抑えます。ランタイム・サーバーは、各メソッドを連続して実行します。各呼び出しに対するエラーや警告は、そのメソッド呼び出しに対応するレスポンス・オブジェクトで取得されます。エラーが発生した場合、executeBatch はバッチの残りの呼び出しを続行します。メソッドの実行結果がエラーになった場合、BatchResponse オブジェクトの最上位のステータスがそのエラーを示します。エラーがない場合、警告が出ている可能性があれば、最上位のステータスがそれを示します。警告がない場合、最上位のステータスがバッチ実行の成功を示します。
戻り値
ランタイム・サーバーは、BatchResponse オブジェクトを使用して、executeBatch に応答します。