Class BioEnrollSampleResult

Namespace

Yubico.YubiKey

Assembly

Yubico.YubiKey.dll

Contains the information about a sample provided for Bio enrollment.

public class BioEnrollSampleResult

Inheritance

object

BioEnrollSampleResult

Remarks

When enrolling a fingerprint, it generally requires multiple readings of the fingerprint before it is enrolled. This class is used to report the result of one reading.

Generally, when a user wants to enroll a fingerprint, the app will initialize the process, and call on the YubiKey to take a reading. The app notifies the user that it is time to press their finger to the reader and when they do so, the YubiKey will take a reading.

This class contains the information the YubiKey returns to describe the results of that reading.

Constructors

BioEnrollSampleResult(ReadOnlyMemory<byte>, int, int)

Build a new instance of BioEnrollSampleResult with the given values.

public BioEnrollSampleResult(ReadOnlyMemory<byte> templateId, int lastEnrollSampleStatus, int remainingSampleCount)

Parameters

templateId ReadOnlyMemory<byte>

The ID of the fingerprint being enrolled.

lastEnrollSampleStatus int

The status code of the most recent sample attempt.

remainingSampleCount int

The number of successful readings necessary to enroll the fingerprint.

Properties

LastEnrollSampleStatus

The result of the most recent attempt to provide a fingerprint sample.

public BioEnrollSampleStatus LastEnrollSampleStatus { get; }

Property Value

BioEnrollSampleStatus

RemainingSampleCount

The number of successful fingerprint samples required to complete an enrollment.

public int RemainingSampleCount { get; }

Property Value

int

TemplateId

The template ID of the fingerprint being enrolled.

public ReadOnlyMemory<byte> TemplateId { get; }

Property Value

ReadOnlyMemory<byte>