BioEnrollSampleResult Class
Namespace: Yubico.YubiKey Assembly: Yubico.YubiKey.dllContains the information about a sample provided for Bio enrollment.
public class BioEnrollSampleResult : ObjectRemarks
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
| Name | Description |
|---|---|
| BioEnrollSampleResult(ReadOnlyMemory<Byte>, Int32, Int32) | Build a new instance of BioEnrollSampleResult with the given values. |
Properties
| Name | Description |
|---|---|
| LastEnrollSampleStatus | The result of the most recent attempt to provide a fingerprint sample. |
| RemainingSampleCount | The number of successful fingerprint samples required to complete an enrollment. |
| TemplateId | The template ID of the fingerprint being enrolled. |