TemplateInfo Class

Namespace: Yubico.YubiKey.Fido2.Commands Assembly: Yubico.YubiKey.dll

Holds the template information for one enrolled fingerprint.

C#

public class TemplateInfo

Inheritance object TemplateInfo

Remarks

A Bio series YubiKey will store a numerical representation of each enrolled fingerprint. This numerical representation is known as a "template". Each template in a YubiKey is identified by a templateId. It is possible to set a friendly name as well.

When operating on or specifying a fingerprint, it is generally necessary to supply the templateId. However, because templateIds are binary byte arrays, it is not practical to offer a user a choice based on templateId. Hence, the user has the option of assigning a friendly name to each fingerprint template. In that way, a user can make a choice based on the name, and the code can use its associated templateId.

When enumerating fingerprint templates, the YubiKey will return the templateId and friendly name for each enrolled fingerprint. The SDK presents this enumeration as a List of TemplateInfo.

Constructors

Name	Description
TemplateInfo(ReadOnlyMemory<byte>, string)	Build a new instance of TemplateInfo from the given templateId and friendlyName. This will copy a reference to the templateId.

Properties

Name	Description
FriendlyName	The friendlyName of the enrolled fingerprint. If there is no name set for this print, this property will be the empty string ("").
TemplateId	The templateId of the enrolled fingerprint.