OnlineIdAuthenticator Kelas

Definisi

Ruang nama:

Windows.Security.Authentication.OnlineId

Menyediakan aplikasi dengan kemampuan untuk memulai permintaan autentikasi untuk mendapatkan token JavaScript Object Notation (JSON) untuk digunakan dengan layanan Anda atau tiket permintaan yang dapat digunakan untuk mendapatkan data yang telah disetujui pengguna untuk aplikasi Anda menggunakan Live ConnectAPI.

Di aplikasi desktop, sebelum menggunakan instans kelas ini dengan cara yang menampilkan UI, Anda harus mengaitkan objek dengan handel jendela pemiliknya. Untuk informasi selengkapnya, dan contoh kode, lihat Menampilkan objek UI WinRT yang bergantung pada CoreWindow.

Catatan

Jika Anda mengembangkan untuk Windows 10 atau yang lebih baru, gunakan API Windows.Security.Authentication.Web.Core sebagai gantinya. Untuk informasi selengkapnya, lihat Manajer akun 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

Warisan

Object Platform::Object IInspectable OnlineIdAuthenticator

Atribut

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Persyaratan Windows

Rangkaian perangkat	Windows 10 (diperkenalkan dalam 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (diperkenalkan dalam v1.0)

Contoh

Contoh berikut menunjukkan cara menangani permintaan autentikasi pengguna.

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

Konstruktor

OnlineIdAuthenticator()

Membuat instans OnlineIdAuthenticator. Di aplikasi desktop, sebelum menggunakan instans kelas ini dengan cara yang menampilkan UI, Anda harus mengaitkan objek dengan handel jendela pemiliknya. Untuk informasi selengkapnya, dan contoh kode, lihat Menampilkan objek UI WinRT yang bergantung pada CoreWindow. Catatan Jika Anda mengembangkan untuk Windows 10 atau yang lebih baru, gunakan API Windows.Security.Authentication.Web.Core sebagai gantinya. Untuk informasi selengkapnya, lihat Manajer akun web.

Properti

ApplicationId	Mengembalikan ID aplikasi sebagai GUID. Catatan Jika Anda mengembangkan untuk Windows 10 atau lebih tinggi, gunakan API Windows.Security.Authentication.Web.Core sebagai gantinya. Untuk informasi selengkapnya, lihat Manajer akun web.
AuthenticatedSafeCustomerId	Mengembalikan ID pengguna yang telah berhasil diautentikasi untuk aplikasi Anda. Catatan Jika Anda mengembangkan untuk Windows 10 atau lebih tinggi, gunakan API Windows.Security.Authentication.Web.Core sebagai gantinya. Untuk informasi selengkapnya, lihat Manajer akun web.
CanSignOut	Menunjukkan apakah pengguna dapat keluar dari aplikasi, dan apakah akan menampilkan tautan keluar di aplikasi. Catatan Jika Anda mengembangkan untuk Windows 10 atau lebih tinggi, gunakan API Windows.Security.Authentication.Web.Core sebagai gantinya. Untuk informasi selengkapnya, lihat Manajer akun web.

Metode

AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest>, CredentialPromptType)	Memulai permintaan autentikasi asinkron dengan beberapa OnlineIdServiceTicketRequests dan memberikan kemampuan untuk mengontrol pengalaman pengguna dengan mengatur CredentialPromptType untuk mendapatkan tiket. Jika pengguna masuk ke sistem Windows 8 dengan akun Microsoft, pengguna ini akan digunakan untuk permintaan autentikasi. Catatan Jika Anda mengembangkan untuk Windows 10 atau lebih tinggi, gunakan API Windows.Security.Authentication.Web.Core sebagai gantinya. Untuk informasi selengkapnya, lihat Manajer akun web.
AuthenticateUserAsync(OnlineIdServiceTicketRequest)	Memulai permintaan autentikasi asinkron dengan satu OnlineIdServiceTicketRequest dengan menampilkan permintaan kredensial jika diperlukan untuk mengumpulkan kredensial atau persetujuan dan mendapatkan tiket. Jika pengguna masuk ke sistem Windows 8 dengan akun Microsoft, pengguna ini akan digunakan untuk permintaan autentikasi. Catatan Jika Anda mengembangkan untuk Windows 10 atau lebih tinggi, gunakan API Windows.Security.Authentication.Web.Core sebagai gantinya. Untuk informasi selengkapnya, lihat Manajer akun web.
SignOutUserAsync()	Memungkinkan pengguna untuk keluar dari aplikasi Anda. Catatan Jika Anda mengembangkan untuk Windows 10 atau lebih tinggi, gunakan API Windows.Security.Authentication.Web.Core sebagai gantinya. Untuk informasi selengkapnya, lihat Manajer akun web.