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

更新 : 2007 年 11 月

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

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

Sys.Services.AuthenticationService.set_defaultLoginCompletedCallback(value); 
var defaultLoginCompletedCallback =
Sys.Services.AuthenticationService.get_defaultLoginCompletedCallback();

パラメータ

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

解説

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

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

function LoginComplete(bool validCredentials, serContext, methodName)

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

• validCredentials。ユーザーが認証された場合に true を返します。

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

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

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

メモ :
認証サービスが正常終了したということが、ユーザーの資格情報が有効であることを意味するわけではありません。資格情報が認証されたかどうかを確認するには、validCredentials が true に設定されているかどうかを確認する必要があります。

使用例

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

// This function sets and gets the default
// login completed callback function.
function SetDefaultLoginCompletedCallBack()
{
    // Set the default callback function.
    Sys.Services.AuthenticationService.set_defaultLoginCompletedCallback(OnLoginCompleted);

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

参照

概念

Sys.Services.ProfileService クラス

Sys.Net.WebServiceProxy クラス