OnlineIdAuthenticator クラス

定義

名前空間:

Windows.Security.Authentication.OnlineId

サービスで使用する JavaScript Object Notation (JSON) トークンを取得するための認証要求を開始したり、Live ConnectAPI を使用してユーザーがアプリに同意したデータを取得するために使用できるチケットを要求したりする機能をアプリに提供します。

デスクトップ アプリでは、UI を表示する方法でこのクラスのインスタンスを使用する前に、オブジェクトを所有者のウィンドウ ハンドルに関連付ける必要があります。 詳細とコード例については、「 CoreWindow に依存する WinRT UI オブジェクトを表示する」を参照してください。

注意

Windows 10 以降用に開発している場合は、代わりに Windows.Security.Authentication.Web.Core API を使用してください。 詳細については、「 Web アカウント マネージャー」を参照してください。

public ref class OnlineIdAuthenticator sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class OnlineIdAuthenticator final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class OnlineIdAuthenticator

function OnlineIdAuthenticator()

Public NotInheritable Class OnlineIdAuthenticator

継承

Object Platform::Object IInspectable OnlineIdAuthenticator

属性

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows の要件

デバイス ファミリ	Windows 10 (10.0.10240.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)

例

次の例は、ユーザー認証要求を処理する方法を示しています。

function signIn() {
    var authenticator = new Windows.Security.Authentication.OnlineId.OnlineIdAuthenticator();
    var serviceTicketRequest = new Windows.Security.Authentication.OnlineId.OnlineIdServiceTicketRequest(
        "wl.basic wl.contacts_photos wl.calendars", "DELEGATION");

    sdkSample.displayStatus("Signing in...");

    authenticator.authenticateUserAsync(serviceTicketRequest)
        .done(function (authResult) {

            if ((authResult.tickets.size == 1) && (authResult.tickets[0].errorCode == 0)) {
                sdkSample.isSignedIn = true;
                sdkSample.displayStatus("Authorization succeeded.");
                sdkSample.accessToken = authResult.tickets[0];
                sdkSample.canSignOut = authenticator.canSignOut;
            }
        },

            function (authStatus) {
                if (authStatus && (authStatus.name !== "Canceled")) {
                    showErrorMessage("Autorization failed: " + authStatus.message);
                } else {
                    sdkSample.displayStatus("");
                }
                    showAccountStatus();
                });
}

コンストラクター

OnlineIdAuthenticator()

OnlineIdAuthenticator のインスタンスを作成します。 デスクトップ アプリでは、UI を表示する方法でこのクラスのインスタンスを使用する前に、オブジェクトを所有者のウィンドウ ハンドルに関連付ける必要があります。 詳細とコード例については、「 CoreWindow に依存する WinRT UI オブジェクトを表示する」を参照してください。 注意 Windows 10 以降用に開発している場合は、代わりに Windows.Security.Authentication.Web.Core API を使用してください。 詳細については、「 Web アカウント マネージャー」を参照してください。

プロパティ

ApplicationId	アプリケーションの ID を GUID として返 します。 注意 Windows 10以上の開発を行う場合は、代わりに Windows.Security.Authentication.Web.Core API を使用してください。 詳細については、「 Web アカウント マネージャー」を参照してください。
AuthenticatedSafeCustomerId	アプリに対して正常に認証されたユーザーの ID を返します。 注意 Windows 10以上の開発を行う場合は、代わりに Windows.Security.Authentication.Web.Core API を使用してください。 詳細については、「 Web アカウント マネージャー」を参照してください。
CanSignOut	ユーザーがアプリからサインアウトできるかどうかを示し、アプリにサインアウト リンクを表示するかどうかを示します。 注意 Windows 10以上の開発を行う場合は、代わりに Windows.Security.Authentication.Web.Core API を使用してください。 詳細については、「 Web アカウント マネージャー」を参照してください。

メソッド

AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest>, CredentialPromptType)	複数の OnlineIdServiceTicketRequests を使用して非同期認証要求を開始し、 CredentialPromptType を設定してチケットを取得することでユーザー エクスペリエンスを制御する機能を提供します。 ユーザーが Microsoft アカウントを使用して Windows 8 システムにサインインしている場合、このユーザーは認証要求に使用されます。 注意 Windows 10以上の開発を行う場合は、代わりに Windows.Security.Authentication.Web.Core API を使用してください。 詳細については、「 Web アカウント マネージャー」を参照してください。
AuthenticateUserAsync(OnlineIdServiceTicketRequest)	資格情報または同意を収集してチケットを取得するために必要な場合は、資格情報プロンプトを表示して、1 つの OnlineIdServiceTicketRequest で非同期認証要求を開始します。 ユーザーが Microsoft アカウントを使用して Windows 8 システムにサインインしている場合、このユーザーは認証要求に使用されます。 注意 Windows 10以上の開発を行う場合は、代わりに Windows.Security.Authentication.Web.Core API を使用してください。 詳細については、「 Web アカウント マネージャー」を参照してください。
SignOutUserAsync()	ユーザーがアプリからサインアウトできるようにします。 注意 Windows 10以上の開発を行う場合は、代わりに Windows.Security.Authentication.Web.Core API を使用してください。 詳細については、「 Web アカウント マネージャー」を参照してください。