Sys.Services の AuthenticationService の defaultLogoutCompletedCallback プロパティ

更新 : 2007 年 11 月

既定のログアウト完了コールバック関数の名前を取得または設定します。

メモ :
クライアント API プロパティのプロパティ値を取得または設定するには、名前のプレフィックスが get_ および set_ のプロパティ アクセサ メソッドを呼び出す必要があります。たとえば、cancel のプロパティの値を取得または設定するには、get_cancel メソッドまたは set_cancel メソッドを呼び出します。

Sys.Services.AuthenticationService.set_defaultLogoutCompletedCallback(value); 
var defaultLogoutCompletedCallback = 
    Sys.Services.AuthenticationService.get_defaultLogoutCompletedCallback();

パラメータ

パラメータ	説明
value	既定のログアウト完了コールバック関数の名前を含む文字列。

解説

defaultLogoutCompletedCallback プロパティに割り当てた関数は、ログアウト処理が正常終了した場合の既定のコールバック関数として使用されます。この既定のコールバック関数をオーバーライドするには、別の関数の名前を logout メソッドに渡します。

このコールバック関数を実装するには、次のシグネチャを使用する必要があります。

function LogoutComplete(result, userContext, methodName)

コールバック関数に渡されるパラメータは次のとおりです。

• result。null を返します。このパラメータは、今後使用するために予約されています。

• userContext。logout メソッドに渡すユーザー コンテキスト情報です。

• methodName。呼び出し元メソッドの名前です。

認証サービス ログアウトが正常終了すると、コールバック関数が非同期に呼び出されます。

使用例

defaultLogoutCompletedCallback プロパティを使用する方法の例を次に示します。このコードは、Sys.Services.AuthenticationService クラスの概要で説明しているコード例の一部です。

// This function sets and gets the default
// logout completed callback function.
function SetDefaultLogoutCompletedCallBack()
{
    // Set the default callback function.
    Sys.Services.AuthenticationService.set_defaultLogoutCompletedCallback(OnLogoutCompleted);

    // Get the default callback function.
    var callBack =     
        Sys.Services.AuthenticationService.get_defaultLogoutCompletedCallback();
}

参照

概念

Sys.Services.ProfileService クラス

Sys.Net.WebServiceProxy クラス