OnlineIdAuthenticator Класс

Определение

Пространство имен:

Windows.Security.Authentication.OnlineId

Предоставляет приложению возможность запустить запрос проверки подлинности, чтобы получить маркеры нотации объектов JavaScript (JSON) для использования со службой или запросить билеты, которые можно использовать для получения данных, которые пользователь предоставил для вашего приложения, с помощью Live ConnectAPI.

В классическом приложении перед использованием экземпляра этого класса таким образом, чтобы отображать пользовательский интерфейс, необходимо связать объект с дескриптором окна владельца. Дополнительные сведения и примеры кода см. в статье Отображение объектов пользовательского интерфейса WinRT, зависящих от CoreWindow.

Примечание

При разработке для Windows 10 или более поздней версии используйте API Windows.Security.Authentication.Web.Core . Дополнительные сведения см. в разделе Диспетчер веб-учетных записей.

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. В классическом приложении перед использованием экземпляра этого класса таким образом, чтобы отображать пользовательский интерфейс, необходимо связать объект с дескриптором окна владельца. Дополнительные сведения и примеры кода см. в статье Отображение объектов пользовательского интерфейса WinRT, зависящих от CoreWindow. Примечание При разработке для Windows 10 или более поздней версии используйте API Windows.Security.Authentication.Web.Core . Дополнительные сведения см. в разделе Диспетчер веб-учетных записей.

Свойства

ApplicationId	Возвращает идентификатор приложения в виде GUID. Примечание Если вы разрабатываете для Windows 10 или более поздней версии, используйте ВМЕСТО них API Windows.Security.Authentication.Web.Core . Дополнительные сведения см. в разделе Диспетчер веб-учетных записей.
AuthenticatedSafeCustomerId	Возвращает идентификатор пользователя, который успешно прошел проверку подлинности для вашего приложения. Примечание Если вы разрабатываете для Windows 10 или более поздней версии, используйте ВМЕСТО них API Windows.Security.Authentication.Web.Core . Дополнительные сведения см. в разделе Диспетчер веб-учетных записей.
CanSignOut	Указывает, может ли пользователь выйти из приложения и должна ли отображаться ссылка на выход в приложении. Примечание Если вы разрабатываете для Windows 10 или более поздней версии, используйте ВМЕСТО них API Windows.Security.Authentication.Web.Core . Дополнительные сведения см. в разделе Диспетчер веб-учетных записей.

Методы

AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest>, CredentialPromptType)	Запускает запрос асинхронной проверки подлинности с несколькими запросами OnlineIdServiceTicketRequest и предоставляет возможность управлять взаимодействием с пользователем, задавая CredentialPromptType для получения билетов. Если пользователь вошел в систему Windows 8 с помощью учетной записи Майкрософт, этот пользователь будет использоваться для запроса проверки подлинности. Примечание Если вы разрабатываете для Windows 10 или более поздней версии, используйте ВМЕСТО них API Windows.Security.Authentication.Web.Core . Дополнительные сведения см. в разделе Диспетчер веб-учетных записей.
AuthenticateUserAsync(OnlineIdServiceTicketRequest)	Запускает асинхронный запрос проверки подлинности с помощью одного onlineIdServiceTicketRequest , отображая запрос учетных данных, если это необходимо для сбора учетных данных или согласия и получения билета. Если пользователь вошел в систему Windows 8 с помощью учетной записи Майкрософт, этот пользователь будет использоваться для запроса проверки подлинности. Примечание Если вы разрабатываете для Windows 10 или более поздней версии, используйте ВМЕСТО них API Windows.Security.Authentication.Web.Core . Дополнительные сведения см. в разделе Диспетчер веб-учетных записей.
SignOutUserAsync()	Позволяет пользователям выйти из приложения. Примечание Если вы разрабатываете для Windows 10 или более поздней версии, используйте ВМЕСТО них API Windows.Security.Authentication.Web.Core . Дополнительные сведения см. в разделе Диспетчер веб-учетных записей.