Sys.Services AuthenticationService の logout メソッド
更新 : 2007 年 11 月
現在認証されているユーザーをログアウトします。
Sys.Services.AuthenticationService.logout(redirectUrl, logoutCompletedCallback, failedCallback, userContext);
パラメータ
パラメータ |
説明 |
|---|---|
redirectUrl |
正常にログアウトしたときにブラウザのリダイレクト先となる URL。既定値は null です。 |
logoutCompletedCallback |
ログアウトが完了すると呼び出される関数。既定値は null です。 |
failedCallback |
ログアウトが失敗すると呼び出される関数。既定値は null です。 |
userContext |
コールバック関数に渡すユーザー コンテキスト情報。 |
解説
redirectUrl が null または空の文字列の場合は、認証 Web サービスの呼び出しが完了し、完了コールバック関数が呼び出された後に、ページはそれ自身にリダイレクトされます。これにより、ユーザー関連のあらゆるデータがページからクリアされます。
redirectUrl が null でないか、空ではない文字列の場合は、Web サービスが正常に呼び出された後に、ページは指定された URL にリダイレクトされます。この URL の指定には、絶対仮想パス、相対仮想パス、完全修飾ドメイン名とパスのいずれかを使用できます。
Web サービスの呼び出しが失敗した場合、ページはリダイレクトも更新もされません。代わりに、失敗コールバック関数が呼び出されます。
使用例
logout メソッドを使用してユーザーの資格情報をチェックする方法を次の例に示します。このコードは、Sys.Services.AuthenticationService クラスの概要で説明しているコード例の一部です。
// This function calls the logout method of the
// authentication service to clear the forms
// authentication cookie.
function OnClickLogout()
{
// Clear the forms authentication cookie.
Sys.Services.AuthenticationService.logout(null,
null, null, null);
}
参照
概念
Sys.Services.ProfileService クラス