UserConsentVerifier.CheckAvailabilityAsync Method

  • Reference

Definition

Namespace:
Windows.Security.Credentials.UI
Edit

Checks to see whether a verifier device, such as a Microsoft Passport PIN, Windows Hello, or fingerprint reader, is available.

public:
 static IAsyncOperation<UserConsentVerifierAvailability> ^ CheckAvailabilityAsync();
/// [Windows.Foundation.Metadata.RemoteAsync]
 static IAsyncOperation<UserConsentVerifierAvailability> CheckAvailabilityAsync();
[Windows.Foundation.Metadata.RemoteAsync]
public static IAsyncOperation<UserConsentVerifierAvailability> CheckAvailabilityAsync();
function checkAvailabilityAsync()
Public Shared Function CheckAvailabilityAsync () As IAsyncOperation(Of UserConsentVerifierAvailability)

Returns

IAsyncOperation<UserConsentVerifierAvailability>

A UserConsentVerifierAvailability value that describes the result of the availability check operation.

Attributes
RemoteAsyncAttribute

Remarks

The following example shows a method that checks to see if fingerprint authentication is supported for the current computer and returns a message that describes the result.

public async Task<string> CheckConsentAvailability()
{
    string returnMessage = "";

    try
    {
        // Check the availability of Hello authentication.
        var ucvAvailability = await Windows.Security.Credentials.UI.UserConsentVerifier.CheckAvailabilityAsync();

        switch (ucvAvailability)
        {
            case Windows.Security.Credentials.UI.UserConsentVerifierAvailability.Available:
                returnMessage = "User consent verification available!";
                break;
            case Windows.Security.Credentials.UI.UserConsentVerifierAvailability.DeviceNotPresent:
                returnMessage = "No PIN found, please set one up.";
                break;
            default:
                returnMessage = "User consent verification is currently unavailable.";
                break;
        }
    }
    catch (Exception ex)
    {
        returnMessage = "User consent verification failed: " + ex.ToString();
    }

    return returnMessage;
}

Applies to

See also