Class GetFingerprintSensorInfoResponse

Namespace

Yubico.YubiKey.Fido2.Commands

Assembly

Yubico.YubiKey.dll

The response partner to the GetFingerprintSensorInfoCommand, containing information about the fingerprint technique of the YubiKey.

public class GetFingerprintSensorInfoResponse : Fido2Response, IYubiKeyResponseWithData<FingerprintSensorInfo>, IYubiKeyResponse

Inheritance

object

YubiKeyResponse

Fido2Response

GetFingerprintSensorInfoResponse

Implements

IYubiKeyResponseWithData<FingerprintSensorInfo>

IYubiKeyResponse

Inherited Members

Fido2Response.CtapStatus

Fido2Response.StatusCodeMap

YubiKeyResponse.ResponseApdu

YubiKeyResponse.Status

YubiKeyResponse.StatusWord

YubiKeyResponse.StatusMessage

YubiKeyResponse.ToString()

Constructors

GetFingerprintSensorInfoResponse(ResponseApdu)

Constructs a new instance of GetFingerprintSensorInfoResponse based on a response APDU provided by the YubiKey.

public GetFingerprintSensorInfoResponse(ResponseApdu responseApdu)

Parameters

responseApdu ResponseApdu

A response APDU containing the CBOR response data for the authenticatorBioEnrollment command.

Methods

GetData()

Gets the data from the YubiKey response.

public FingerprintSensorInfo GetData()

Returns

FingerprintSensorInfo

The data returned by the YubiKey, presented in a manner specific to each implementation.

Remarks

If the method cannot return the data, it will throw an exception. This happens when the Status property indicates an error, or the data returned from the YubiKey was malformed or incomplete.

For example,

IYubiKeyConnection connection = key.Connect(YubiKeyApplication.Piv);
GetDataCommand getDataCommand = new GetDataCommand(PivDataTag.Chuid);
GetDataResponse getDataResponse = connection.SendCommand(getDataCommand);
if (getDataResponse.Status == ResponseStatus.Success)
{
    byte[] getChuid = getDataResponse.GetData();
}