Table of Contents

Class GetBioMetadataResponse

Namespace
Yubico.YubiKey.Piv.Commands
Assembly
Yubico.YubiKey.dll

The response to GetBioMetadataCommand containing YubiKey Bio Metadata about a particular key.

public sealed class GetBioMetadataResponse : PivResponse, IYubiKeyResponseWithData<PivBioMetadata>, IYubiKeyResponse
Inheritance
object
GetBioMetadataResponse
Implements
Inherited Members

Remarks

The GetBioMetadataCommand is available on YubiKey Bio multi-protocol keys.

This is the partner Response class to GetBioMetadataCommand.

The data returned is a PivBioMetadata object.

Example: 

IYubiKeyConnection connection = key.Connect(YubiKeyApplication.Piv);
GetBioMetadataCommand command = new GetBioMetadataCommand();
GetBioMetadataResponse response = connection.SendCommand(command);
if (response.Status == ResponseStatus.Success)
{
    PivBioMetadata data = response.GetData();
}

Constructors

GetBioMetadataResponse(ResponseApdu)

Constructs a GetBioMetadataResponse based on a ResponseApdu received from the YubiKey.

public GetBioMetadataResponse(ResponseApdu responseApdu)

Parameters

responseApdu ResponseApdu

The object containing the response APDU
returned by the YubiKey.

Methods

GetData()

Gets the bio metadata from the YubiKey response.

public PivBioMetadata GetData()

Returns

PivBioMetadata

The data in the response APDU, presented as a PivBioMetadata object.

Exceptions

NotSupportedException

Thrown when the device does not support Bio Metadata.

InvalidOperationException

Thrown when Status is not Success.