GetBioMetadataCommand Class

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

Get information about a YubiKey Bio multi-protocol key.

C#

public sealed class GetBioMetadataCommand : Object, IYubiKeyCommand<GetBioMetadataResponse>

Inheritance System.Object GetBioMetadataCommand

Implements

IYubiKeyCommand<GetBioMetadataResponse>

Remarks

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

The partner Response class is GetBioMetadataResponse.

See the User's Manual entry on getting bio metadata for specific information about what information is returned.

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

Name	Description
GetBioMetadataCommand()	Initializes a new instance of the GetBioMetadataCommand class.

Properties

Name	Description
Application	Gets the YubiKeyApplication to which this command belongs. For this command it's PIV.

Methods

Name	Description
CreateCommandApdu()	Creates a well-formed CommandApdu to send to the YubiKey.
CreateResponseForApdu(ResponseApdu)	Creates the corresponding IYubiKeyResponse implementation for the current command.