endSession

endSession メソッドは、ランタイム・セッション終了のマークを付けます。ランタイム・サーバーは、このメソッドを受信すると、履歴へのログの記録やメモリーのクリアなどを行います。

endSession(String sessionID)

sessionID - セッションを識別する一意の文字列。

endSession メソッドが呼び出されない場合、ランタイム・セッションはタイムアウトになります。タイムアウト期間は、sessionTimeout プロパティーを使用して構成可能です。

戻り値

ランタイム・サーバーは、以下の属性が設定された Response オブジェクトを使用して endSession メソッドに応答します。

セッション ID
ApiVersion
StatusCode
AdvisoryMessages

例

次の例で、endSession メソッドと、応答の解析方法を示します。sessionId は、このセッションを開始したstartSession 呼び出しで使用されるセッションを識別する同じ文字列です。

response = api.endSession(sessionId);
    // check if response is successful or not
    if(response.getStatusCode() == Response.STATUS_SUCCESS)
    {
        System.out.println("endSession call processed with no warnings or errors");
    }
    else if(response.getStatusCode() == Response.STATUS_WARNING)
    {
        System.out.println("endSession call processed with a warning");
    }
    else
    {
        System.out.println("endSession call processed with an error");
    }
    // For any non-successes, there should be advisory messages explaining why
    if(response.getStatusCode() != Response.STATUS_SUCCESS)
        printDetailMessageOfWarningOrError("endSession",
			response.getAdvisoryMessages());