endSession
endSession メソッドは、ランタイム・セッション終了のマークを付けます。ランタイム・サーバーは、このメソッドを受信すると、履歴へのログの記録やメモリーのクリアなどを行います。
function callEndSession(commandsToExecute, callback) {
var ssId = document.getElementById('es_sessionId').value;
InteractAPI.endSession(ssId, callback);
}
- session ID - セッションを識別する一意の文字列。
- callback - メソッドが成功した場合、コールバック関数は onSuccess を呼び出します。メソッドが失敗した場合、コールバック関数は onError を呼び出します。
endSession メソッドが呼び出されない場合、ランタイム・セッションはタイムアウトになります。タイムアウト期間は、sessionTimeout プロパティーを使用して構成可能です。
戻り値
ランタイム・サーバーは、以下の属性が設定された Response オブジェクトを使用して endSession メソッドに応答します。
- セッション ID
- ApiVersion
- OfferList
- プロファイル
- StatusCode
- AdvisoryMessages