OnlineIdAuthenticator Classe

Definição

Namespace:

Windows.Security.Authentication.OnlineId

Fornece a um aplicativo a capacidade de iniciar a solicitação de autenticação para obter tokens JSON (JavaScript Object Notation) a serem usados com seu serviço ou solicitar tíquetes que podem ser usados para obter dados que o usuário consentiu para seu aplicativo usando o Live ConnectAPI.

Em um aplicativo da área de trabalho, antes de usar uma instância dessa classe de uma maneira que exiba a interface do usuário, você precisará associar o objeto ao identificador de janela do proprietário. Para obter mais informações e exemplos de código, consulte Exibir objetos de interface do usuário do WinRT que dependem do CoreWindow.

Observação

Se você estiver desenvolvendo para o Windows 10 ou posterior, use as APIs Windows.Security.Authentication.Web.Core . Para obter mais informações, consulte Gerenciador de contas Da 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

Herança

Object Platform::Object IInspectable OnlineIdAuthenticator

Atributos

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Requisitos do Windows

Família de dispositivos	Windows 10 (introduzida na 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduzida na v1.0)

Exemplos

O exemplo a seguir mostra como lidar com uma solicitação de autenticação de usuário.

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

Construtores

OnlineIdAuthenticator()

Cria uma instância do OnlineIdAuthenticator. Em um aplicativo da área de trabalho, antes de usar uma instância dessa classe de uma maneira que exiba a interface do usuário, você precisará associar o objeto ao identificador de janela do proprietário. Para obter mais informações e exemplos de código, consulte Exibir objetos de interface do usuário do WinRT que dependem do CoreWindow. Observação Se você estiver desenvolvendo para o Windows 10 ou posterior, use as APIs Windows.Security.Authentication.Web.Core . Para obter mais informações, consulte Gerenciador de contas Da Web.

Propriedades

ApplicationId	Retorna a ID do aplicativo como um GUID. Observação Se você estiver desenvolvendo para o Windows 10 ou superior, use as APIs Windows.Security.Authentication.Web.Core . Para obter mais informações, consulte Gerenciador de contas Da Web.
AuthenticatedSafeCustomerId	Retorna a ID de um usuário que foi autenticado com êxito para seu aplicativo. Observação Se você estiver desenvolvendo para o Windows 10 ou superior, use as APIs Windows.Security.Authentication.Web.Core . Para obter mais informações, consulte Gerenciador de contas Da Web.
CanSignOut	Indica se um usuário pode sair do aplicativo e se deve mostrar o link de saída no aplicativo. Observação Se você estiver desenvolvendo para o Windows 10 ou superior, use as APIs Windows.Security.Authentication.Web.Core . Para obter mais informações, consulte Gerenciador de contas Da Web.

Métodos

AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest>, CredentialPromptType)	Inicia a solicitação de autenticação assíncrona com vários OnlineIdServiceTicketRequests e fornece a capacidade de controlar a experiência do usuário definindo CredentialPromptType para obter os tíquetes. Se um usuário estiver conectado a um sistema Windows 8 com uma conta Microsoft, esse usuário será usado para a solicitação de autenticação. Observação Se você estiver desenvolvendo para o Windows 10 ou superior, use as APIs Windows.Security.Authentication.Web.Core . Para obter mais informações, consulte Gerenciador de contas Da Web.
AuthenticateUserAsync(OnlineIdServiceTicketRequest)	Inicia a solicitação de autenticação assíncrona com um OnlineIdServiceTicketRequest mostrando o prompt de credencial, se necessário, para coletar credenciais ou consentimento e obter o tíquete. Se um usuário estiver conectado a um sistema Windows 8 com uma conta Microsoft, esse usuário será usado para a solicitação de autenticação. Observação Se você estiver desenvolvendo para o Windows 10 ou superior, use as APIs Windows.Security.Authentication.Web.Core . Para obter mais informações, consulte Gerenciador de contas Da Web.
SignOutUserAsync()	Permite que os usuários saiam do seu aplicativo. Observação Se você estiver desenvolvendo para o Windows 10 ou superior, use as APIs Windows.Security.Authentication.Web.Core . Para obter mais informações, consulte Gerenciador de contas Da Web.