OnlineIdAuthenticator Classe

Définition

Espace de noms:

Windows.Security.Authentication.OnlineId

Fournit une application avec la possibilité de démarrer la demande d’authentification pour obtenir des jetons JSON (JavaScript Object Notation) à utiliser avec votre service ou des tickets de demande qui peuvent être utilisés pour obtenir des données auxquelles l’utilisateur a consenti pour votre application à l’aide de l’API Live Connect.

Dans une application de bureau, avant d’utiliser un instance de cette classe d’une manière qui affiche l’interface utilisateur, vous devez associer l’objet au handle de fenêtre de son propriétaire. Pour plus d’informations et des exemples de code, consultez Afficher des objets d’interface utilisateur WinRT qui dépendent de CoreWindow.

Notes

Si vous développez pour Windows 10 ou une version ultérieure, utilisez plutôt les API Windows.Security.Authentication.Web.Core. Pour plus d’informations, consultez Gestionnaire de comptes 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

Héritage

Object Platform::Object IInspectable OnlineIdAuthenticator

Attributs

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Configuration requise pour Windows

Famille d’appareils	Windows 10 (introduit dans 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v1.0)

Exemples

L’exemple suivant montre comment gérer une demande d’authentification utilisateur.

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

Constructeurs

OnlineIdAuthenticator()

Crée un instance du OnlineIdAuthenticator. Dans une application de bureau, avant d’utiliser un instance de cette classe d’une manière qui affiche l’interface utilisateur, vous devez associer l’objet au handle de fenêtre de son propriétaire. Pour plus d’informations et des exemples de code, consultez Afficher des objets d’interface utilisateur WinRT qui dépendent de CoreWindow. Notes Si vous développez pour Windows 10 ou une version ultérieure, utilisez plutôt les API Windows.Security.Authentication.Web.Core. Pour plus d’informations, consultez Gestionnaire de comptes web.

Propriétés

ApplicationId	Retourne l’ID de l’application en tant que GUID. Notes Si vous développez pour Windows 10 ou une version ultérieure, utilisez plutôt les API Windows.Security.Authentication.Web.Core. Pour plus d’informations, consultez Gestionnaire de comptes web.
AuthenticatedSafeCustomerId	Retourne l’ID d’un utilisateur qui a été correctement authentifié pour votre application. Notes Si vous développez pour Windows 10 ou une version ultérieure, utilisez plutôt les API Windows.Security.Authentication.Web.Core. Pour plus d’informations, consultez Gestionnaire de comptes web.
CanSignOut	Indique si un utilisateur peut se déconnecter de l’application et s’il doit afficher le lien de déconnexion dans l’application. Notes Si vous développez pour Windows 10 ou une version ultérieure, utilisez plutôt les API Windows.Security.Authentication.Web.Core. Pour plus d’informations, consultez Gestionnaire de comptes web.

Méthodes

AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest>, CredentialPromptType)	Démarre la demande d’authentification asynchrone avec plusieurs OnlineIdServiceTicketRequests et permet de contrôler l’expérience utilisateur en définissant CredentialPromptType pour obtenir les tickets. Si un utilisateur est connecté à un système Windows 8 avec un compte Microsoft, cet utilisateur sera utilisé pour la demande d’authentification. Notes Si vous développez pour Windows 10 ou une version ultérieure, utilisez plutôt les API Windows.Security.Authentication.Web.Core. Pour plus d’informations, consultez Gestionnaire de comptes web.
AuthenticateUserAsync(OnlineIdServiceTicketRequest)	Démarre la demande d’authentification asynchrone avec une demande OnlineIdServiceTicketRequest en affichant l’invite d’informations d’identification si nécessaire pour collecter les informations d’identification ou le consentement et obtenir le ticket. Si un utilisateur est connecté à un système Windows 8 avec un compte Microsoft, cet utilisateur sera utilisé pour la demande d’authentification. Notes Si vous développez pour Windows 10 ou une version ultérieure, utilisez plutôt les API Windows.Security.Authentication.Web.Core. Pour plus d’informations, consultez Gestionnaire de comptes web.
SignOutUserAsync()	Permet aux utilisateurs de se déconnecter de votre application. Notes Si vous développez pour Windows 10 ou une version ultérieure, utilisez plutôt les API Windows.Security.Authentication.Web.Core. Pour plus d’informations, consultez Gestionnaire de comptes web.