OnlineIdAuthenticator Clase

Definición

Espacio de nombres:

Windows.Security.Authentication.OnlineId

Proporciona una aplicación con la capacidad de iniciar la solicitud de autenticación para obtener tokens de notación de objetos JavaScript (JSON) para usarlos con el servicio o solicitar vales que se pueden usar para obtener datos a los que el usuario ha dado su consentimiento para la aplicación mediante Live ConnectAPI.

En una aplicación de escritorio, antes de usar una instancia de esta clase de una manera que muestre la interfaz de usuario, deberá asociar el objeto con el identificador de ventana de su propietario. Para obtener más información y ejemplos de código, consulta Mostrar objetos de interfaz de usuario de WinRT que dependen de CoreWindow.

Nota:

Si va a desarrollar para Windows 10 o una versión posterior, use las API Windows.Security.Authentication.Web.Core en su lugar. Para obtener más información, consulte Administrador de cuentas 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

Herencia

Object Platform::Object IInspectable OnlineIdAuthenticator

Atributos

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Requisitos de Windows

Familia de dispositivos	Windows 10 (se introdujo en la versión 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (se introdujo en la versión v1.0)

Ejemplos

En el ejemplo siguiente se muestra cómo controlar una solicitud de autenticación de usuario.

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

Constructores

OnlineIdAuthenticator()

Crea una instancia de OnlineIdAuthenticator. En una aplicación de escritorio, antes de usar una instancia de esta clase de una manera que muestre la interfaz de usuario, deberá asociar el objeto con el identificador de ventana de su propietario. Para obtener más información y ejemplos de código, consulta Mostrar objetos de interfaz de usuario de WinRT que dependen de CoreWindow. Nota: Si va a desarrollar para Windows 10 o una versión posterior, use las API Windows.Security.Authentication.Web.Core en su lugar. Para obtener más información, consulte Administrador de cuentas web.

Propiedades

ApplicationId	Devuelve el identificador de la aplicación como GUID. Nota: Si está desarrollando para Windows 10 o superior, use las API Windows.Security.Authentication.Web.Core en su lugar. Para obtener más información, consulte Administrador de cuentas web.
AuthenticatedSafeCustomerId	Devuelve el identificador de un usuario que se ha autenticado correctamente para la aplicación. Nota: Si está desarrollando para Windows 10 o superior, use las API Windows.Security.Authentication.Web.Core en su lugar. Para obtener más información, consulte Administrador de cuentas web.
CanSignOut	Indica si un usuario puede cerrar la sesión de la aplicación y si se muestra el vínculo de cierre de sesión en la aplicación. Nota: Si está desarrollando para Windows 10 o superior, use las API Windows.Security.Authentication.Web.Core en su lugar. Para obtener más información, consulte Administrador de cuentas web.

Métodos

AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest>, CredentialPromptType)	Inicia la solicitud de autenticación asincrónica con varios OnlineIdServiceTicketRequests y proporciona la capacidad de controlar la experiencia del usuario estableciendo CredentialPromptType para obtener los vales. Si un usuario ha iniciado sesión en un sistema de Windows 8 con una cuenta microsoft, este usuario se usará para la solicitud de autenticación. Nota: Si está desarrollando para Windows 10 o superior, use las API Windows.Security.Authentication.Web.Core en su lugar. Para obtener más información, consulte Administrador de cuentas web.
AuthenticateUserAsync(OnlineIdServiceTicketRequest)	Inicia la solicitud de autenticación asincrónica con un OnlineIdServiceTicketRequest mostrando el símbolo del sistema de credenciales si es necesario para recopilar las credenciales o el consentimiento y obtener el vale. Si un usuario ha iniciado sesión en un sistema de Windows 8 con una cuenta microsoft, este usuario se usará para la solicitud de autenticación. Nota: Si está desarrollando para Windows 10 o superior, use las API Windows.Security.Authentication.Web.Core en su lugar. Para obtener más información, consulte Administrador de cuentas web.
SignOutUserAsync()	Permite a los usuarios cerrar la sesión de la aplicación. Nota: Si está desarrollando para Windows 10 o superior, use las API Windows.Security.Authentication.Web.Core en su lugar. Para obtener más información, consulte Administrador de cuentas web.