Class GetBioModalityResponse

Namespace

Yubico.YubiKey.Fido2.Commands

Assembly

Yubico.YubiKey.dll

The response partner to the GetBioModalityCommand, containing information about the biometric technique of the YubiKey.

public class GetBioModalityResponse : Fido2Response, IYubiKeyResponseWithData<int>, IYubiKeyResponse

Inheritance

object

YubiKeyResponse

Fido2Response

GetBioModalityResponse

Implements

IYubiKeyResponseWithData<int>

IYubiKeyResponse

Inherited Members

Fido2Response.CtapStatus

Fido2Response.StatusCodeMap

YubiKeyResponse.ResponseApdu

YubiKeyResponse.Status

YubiKeyResponse.StatusWord

YubiKeyResponse.StatusMessage

YubiKeyResponse.ToString()

Constructors

GetBioModalityResponse(ResponseApdu)

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

public GetBioModalityResponse(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 int GetData()

Returns

int

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();
}