UserConsentVerifierAvailability enumeration

Applies to Windows only

Describes the result of a check for a biometric (fingerprint) verifier device.

Syntax


var value = Windows.Security.Credentials.UI.UserConsentVerifierAvailability.available;

Attributes

[Version(0x06030000)]

Members

The UserConsentVerifierAvailability enumeration has these members.

MemberValueDescription
Available | available0

A biometric verifier device is available.

DeviceNotPresent | deviceNotPresent1

There is no biometric verifier device available.

NotConfiguredForUser | notConfiguredForUser2

A biometric verifier device is not configured for this user.

DisabledByPolicy | disabledByPolicy3

Group policy has disabled the biometric verifier device.

DeviceBusy | deviceBusy4

The biometric verifier device is performing an operation and is unavailable.

Remarks

You can use the CheckAvailabilityAsync method to determine if fingerprint authentication is supported for the current computer.

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 based on the UserConsentVerifierAvailability value.


function checkFingerprintAvailability() {
    try {
        // Check the availability of fingerprint authentication.

        Windows.Security.Credentials.UI.UserConsentVerifier.checkAvailabilityAsync().then(
        function (ucvAvailability) {

            switch (ucvAvailability)
            {
                case Windows.Security.Credentials.UI.UserConsentVerifierAvailability.available:
                    outputDiv.innerHTML = "<br/>Fingerprint verification is available.";
                    break;
                case Windows.Security.Credentials.UI.UserConsentVerifierAvailability.deviceBusy:
                    outputDiv.innerHTML = "<br/>Biometric device is busy.";
                    break;
                case Windows.Security.Credentials.UI.UserConsentVerifierAvailability.deviceNotPresent:
                    outputDiv.innerHTML = "<br/>No biometric device found.";
                    break;
                case Windows.Security.Credentials.UI.UserConsentVerifierAvailability.disabledByPolicy:
                    outputDiv.innerHTML = "<br/>Biometric verification is disabled by policy.";
                    break;
                case Windows.Security.Credentials.UI.UserConsentVerifierAvailability.notConfiguredForUser:
                    outputDiv.innerHTML = "<br/>The user has no fingerprints registered. Please add a fingerprint to the " +
                                    "fingerprint database and try again.";
                    break;
                default:
                    outputDiv.innerHTML = "<br/>Fingerprints verification is currently unavailable.";
                    break;
            }
        });
    }
    catch (ex) {
        outputDiv.innerHTML = "<br/>Fingerprint authentication availability check failed: " + ex.toString();
    }
}


Requirements

Minimum supported client

Windows 8.1

Minimum supported server

Windows Server 2012 R2

Minimum supported phone

None supported

Namespace

Windows.Security.Credentials.UI
Windows::Security::Credentials::UI [C++]

Metadata

Windows.winmd

See also

Fingerprint (biometric) authentication
UserConsentVerifier sample
CheckAvailabilityAsync
UserConsentVerifier
Windows.Security.Credentials.UI
Authentication and User Identity

 

 

Show:
© 2014 Microsoft