OnlineIdAuthenticator Klasse

Definition

Namespace:

Windows.Security.Authentication.OnlineId

Stellt eine App mit der Möglichkeit bereit, die Authentifizierungsanforderung zu starten, um JSON-Token (JavaScript Object Notation) abzurufen, die mit Ihrem Dienst verwendet werden können oder Tickets anfordern, die verwendet werden können, um Daten abzurufen, denen der Benutzer mithilfe der Live ConnectAPI zugestimmt hat.

Bevor Sie in einer Desktop-App eine instance dieser Klasse so verwenden, dass die Benutzeroberfläche angezeigt wird, müssen Sie das Objekt dem Fensterhandle des Besitzers zuordnen. Weitere Informationen und Codebeispiele finden Sie unter Anzeigen von WinRT-UI-Objekten, die von CoreWindow abhängen.

Hinweis

Wenn Sie für Windows 10 oder höher entwickeln, verwenden Sie stattdessen die Windows.Security.Authentication.Web.Core-APIs. Weitere Informationen finden Sie unter Web Account Manager.

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

Vererbung

Object Platform::Object IInspectable OnlineIdAuthenticator

Attribute

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows-Anforderungen

Gerätefamilie	Windows 10 (eingeführt in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (eingeführt in v1.0)

Beispiele

Im folgenden Beispiel wird gezeigt, wie eine Benutzerauthentifizierungsanforderung behandelt wird.

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();
                });
}

Konstruktoren

OnlineIdAuthenticator()

Erstellt eine instance des OnlineIdAuthenticators. Bevor Sie in einer Desktop-App eine instance dieser Klasse so verwenden, dass die Benutzeroberfläche angezeigt wird, müssen Sie das Objekt dem Fensterhandle des Besitzers zuordnen. Weitere Informationen und Codebeispiele finden Sie unter Anzeigen von WinRT-UI-Objekten, die von CoreWindow abhängen. Hinweis Wenn Sie für Windows 10 oder höher entwickeln, verwenden Sie stattdessen die Windows.Security.Authentication.Web.Core-APIs. Weitere Informationen finden Sie unter Web Account Manager.

Eigenschaften

ApplicationId	Gibt die ID der Anwendung als GUID zurück. Hinweis Wenn Sie für Windows 10 oder höher entwickeln, verwenden Sie stattdessen die Windows.Security.Authentication.Web.Core-APIs. Weitere Informationen finden Sie unter Web Account Manager.
AuthenticatedSafeCustomerId	Gibt die ID eines Benutzers zurück, der erfolgreich für Ihre App authentifiziert wurde. Hinweis Wenn Sie für Windows 10 oder höher entwickeln, verwenden Sie stattdessen die Windows.Security.Authentication.Web.Core-APIs. Weitere Informationen finden Sie unter Web Account Manager.
CanSignOut	Gibt an, ob sich ein Benutzer von der App abmelden kann und ob der Abmeldelink in der App angezeigt werden soll. Hinweis Wenn Sie für Windows 10 oder höher entwickeln, verwenden Sie stattdessen die Windows.Security.Authentication.Web.Core-APIs. Weitere Informationen finden Sie unter Web Account Manager.

Methoden

AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest>, CredentialPromptType)	Startet die asynchrone Authentifizierungsanforderung mit mehreren OnlineIdServiceTicketRequests und bietet die Möglichkeit, die Benutzererfahrung zu steuern, indem CredentialPromptType festgelegt wird, um die Tickets zu erhalten. Wenn ein Benutzer mit einem Microsoft-Konto bei einem Windows 8-System angemeldet ist, wird dieser Benutzer für die Authentifizierungsanforderung verwendet. Hinweis Wenn Sie für Windows 10 oder höher entwickeln, verwenden Sie stattdessen die Windows.Security.Authentication.Web.Core-APIs. Weitere Informationen finden Sie unter Web Account Manager.
AuthenticateUserAsync(OnlineIdServiceTicketRequest)	Startet die asynchrone Authentifizierungsanforderung mit einer OnlineIdServiceTicketRequest , indem die Anmeldeinformationsaufforderung angezeigt wird, falls erforderlich, um Anmeldeinformationen oder Zustimmung zu sammeln und das Ticket zu erhalten. Wenn ein Benutzer mit einem Microsoft-Konto bei einem Windows 8-System angemeldet ist, wird dieser Benutzer für die Authentifizierungsanforderung verwendet. Hinweis Wenn Sie für Windows 10 oder höher entwickeln, verwenden Sie stattdessen die Windows.Security.Authentication.Web.Core-APIs. Weitere Informationen finden Sie unter Web Account Manager.
SignOutUserAsync()	Ermöglicht Es Benutzern, sich von Ihrer App abzumelden. Hinweis Wenn Sie für Windows 10 oder höher entwickeln, verwenden Sie stattdessen die Windows.Security.Authentication.Web.Core-APIs. Weitere Informationen finden Sie unter Web Account Manager.