Class SmartCardEmulationAdapter

Namespace

OpenQA.Selenium.DevTools.V147.SmartCardEmulation

Assembly

Selenium.WebDriver.dll

Represents an adapter for the SmartCardEmulation domain to simplify the command interface.

public class SmartCardEmulationAdapter

Inheritance

object

SmartCardEmulationAdapter

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

SmartCardEmulationAdapter(IDevToolsSession)

Initializes a new instance of the SmartCardEmulationAdapter class.

public SmartCardEmulationAdapter(IDevToolsSession session)

Parameters

session IDevToolsSession

The IDevToolsSession to be used with this adapter.

Exceptions

ArgumentNullException

If session is null.

Properties

Session

Gets the DevToolsSession associated with the adapter.

public IDevToolsSession Session { get; }

Property Value

IDevToolsSession

Methods

Disable(DisableCommandSettings?, CancellationToken, int?, bool)

Disables the |SmartCardEmulation| domain.

public Task<DisableCommandResponse?> Disable(DisableCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command DisableCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<DisableCommandResponse>

Enable(EnableCommandSettings?, CancellationToken, int?, bool)

Enables the |SmartCardEmulation| domain.

public Task<EnableCommandResponse?> Enable(EnableCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command EnableCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<EnableCommandResponse>

ReportBeginTransactionResult(ReportBeginTransactionResultCommandSettings, CancellationToken, int?, bool)

Reports the result of a |SCardBeginTransaction| call. On success, this creates a new transaction object.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaddb835dce01a0da1d6ca02d33ee7d861 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardbegintransaction

public Task<ReportBeginTransactionResultCommandResponse?> ReportBeginTransactionResult(ReportBeginTransactionResultCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command ReportBeginTransactionResultCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<ReportBeginTransactionResultCommandResponse>

ReportConnectResult(ReportConnectResultCommandSettings, CancellationToken, int?, bool)

Reports the successful result of a |SCardConnect| call.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga4e515829752e0a8dbc4d630696a8d6a5 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardconnecta

public Task<ReportConnectResultCommandResponse?> ReportConnectResult(ReportConnectResultCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command ReportConnectResultCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<ReportConnectResultCommandResponse>

ReportDataResult(ReportDataResultCommandSettings, CancellationToken, int?, bool)

Reports the successful result of a call that sends back data on success. Used for |SCardTransmit|, |SCardControl|, and |SCardGetAttrib|.

This maps to:

1. SCardTransmit PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga9a2d77242a271310269065e64633ab99 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardtransmit

2. SCardControl PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gac3454d4657110fd7f753b2d3d8f4e32f Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardcontrol

3. SCardGetAttrib PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaacfec51917255b7a25b94c5104961602 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardgetattrib

public Task<ReportDataResultCommandResponse?> ReportDataResult(ReportDataResultCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command ReportDataResultCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<ReportDataResultCommandResponse>

ReportError(ReportErrorCommandSettings, CancellationToken, int?, bool)

Reports an error result for the given request.

public Task<ReportErrorCommandResponse?> ReportError(ReportErrorCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command ReportErrorCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<ReportErrorCommandResponse>

ReportEstablishContextResult(ReportEstablishContextResultCommandSettings, CancellationToken, int?, bool)

Reports the successful result of a |SCardEstablishContext| call.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaa1b8970169fd4883a6dc4a8f43f19b67 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardestablishcontext

public Task<ReportEstablishContextResultCommandResponse?> ReportEstablishContextResult(ReportEstablishContextResultCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command ReportEstablishContextResultCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<ReportEstablishContextResultCommandResponse>

ReportGetStatusChangeResult(ReportGetStatusChangeResultCommandSettings, CancellationToken, int?, bool)

Reports the successful result of a |SCardGetStatusChange| call.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga33247d5d1257d59e55647c3bb717db24 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardgetstatuschangea

public Task<ReportGetStatusChangeResultCommandResponse?> ReportGetStatusChangeResult(ReportGetStatusChangeResultCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command ReportGetStatusChangeResultCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<ReportGetStatusChangeResultCommandResponse>

ReportListReadersResult(ReportListReadersResultCommandSettings, CancellationToken, int?, bool)

Reports the successful result of a |SCardListReaders| call.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga93b07815789b3cf2629d439ecf20f0d9 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardlistreadersa

public Task<ReportListReadersResultCommandResponse?> ReportListReadersResult(ReportListReadersResultCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command ReportListReadersResultCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<ReportListReadersResultCommandResponse>

ReportPlainResult(ReportPlainResultCommandSettings, CancellationToken, int?, bool)

Reports the successful result of a call that returns only a result code. Used for: |SCardCancel|, |SCardDisconnect|, |SCardSetAttrib|, |SCardEndTransaction|.

This maps to:

1. SCardCancel PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaacbbc0c6d6c0cbbeb4f4debf6fbeeee6 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardcancel

2. SCardDisconnect PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga4be198045c73ec0deb79e66c0ca1738a Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scarddisconnect

3. SCardSetAttrib PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga060f0038a4ddfd5dd2b8fadf3c3a2e4f Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardsetattrib

4. SCardEndTransaction PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gae8742473b404363e5c587f570d7e2f3b Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardendtransaction

public Task<ReportPlainResultCommandResponse?> ReportPlainResult(ReportPlainResultCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command ReportPlainResultCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<ReportPlainResultCommandResponse>

ReportReleaseContextResult(ReportReleaseContextResultCommandSettings, CancellationToken, int?, bool)

Reports the successful result of a |SCardReleaseContext| call.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga6aabcba7744c5c9419fdd6404f73a934 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardreleasecontext

public Task<ReportReleaseContextResultCommandResponse?> ReportReleaseContextResult(ReportReleaseContextResultCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command ReportReleaseContextResultCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<ReportReleaseContextResultCommandResponse>

ReportStatusResult(ReportStatusResultCommandSettings, CancellationToken, int?, bool)

Reports the successful result of a |SCardStatus| call.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gae49c3c894ad7ac12a5b896bde70d0382 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardstatusa

public Task<ReportStatusResultCommandResponse?> ReportStatusResult(ReportStatusResultCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command ReportStatusResultCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<ReportStatusResultCommandResponse>

Events

BeginTransactionRequested

Fired when |SCardBeginTransaction| is called.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaddb835dce01a0da1d6ca02d33ee7d861 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardbegintransaction

public event EventHandler<BeginTransactionRequestedEventArgs>? BeginTransactionRequested

Event Type

EventHandler<BeginTransactionRequestedEventArgs>

CancelRequested

Fired when |SCardCancel| is called.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaacbbc0c6d6c0cbbeb4f4debf6fbeeee6 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardcancel

public event EventHandler<CancelRequestedEventArgs>? CancelRequested

Event Type

EventHandler<CancelRequestedEventArgs>

ConnectRequested

Fired when |SCardConnect| is called.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga4e515829752e0a8dbc4d630696a8d6a5 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardconnecta

public event EventHandler<ConnectRequestedEventArgs>? ConnectRequested

Event Type

EventHandler<ConnectRequestedEventArgs>

ControlRequested

Fired when |SCardControl| is called.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gac3454d4657110fd7f753b2d3d8f4e32f Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardcontrol

public event EventHandler<ControlRequestedEventArgs>? ControlRequested

Event Type

EventHandler<ControlRequestedEventArgs>

DisconnectRequested

Fired when |SCardDisconnect| is called.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga4be198045c73ec0deb79e66c0ca1738a Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scarddisconnect

public event EventHandler<DisconnectRequestedEventArgs>? DisconnectRequested

Event Type

EventHandler<DisconnectRequestedEventArgs>

EndTransactionRequested

Fired when |SCardEndTransaction| is called.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gae8742473b404363e5c587f570d7e2f3b Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardendtransaction

public event EventHandler<EndTransactionRequestedEventArgs>? EndTransactionRequested

Event Type

EventHandler<EndTransactionRequestedEventArgs>

EstablishContextRequested

Fired when |SCardEstablishContext| is called.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaa1b8970169fd4883a6dc4a8f43f19b67 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardestablishcontext

public event EventHandler<EstablishContextRequestedEventArgs>? EstablishContextRequested

Event Type

EventHandler<EstablishContextRequestedEventArgs>

GetAttribRequested

Fired when |SCardGetAttrib| is called.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaacfec51917255b7a25b94c5104961602 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardgetattrib

public event EventHandler<GetAttribRequestedEventArgs>? GetAttribRequested

Event Type

EventHandler<GetAttribRequestedEventArgs>

GetStatusChangeRequested

Fired when |SCardGetStatusChange| is called. Timeout is specified in milliseconds.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga33247d5d1257d59e55647c3bb717db24 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardgetstatuschangea

public event EventHandler<GetStatusChangeRequestedEventArgs>? GetStatusChangeRequested

Event Type

EventHandler<GetStatusChangeRequestedEventArgs>

ListReadersRequested

Fired when |SCardListReaders| is called.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga93b07815789b3cf2629d439ecf20f0d9 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardlistreadersa

public event EventHandler<ListReadersRequestedEventArgs>? ListReadersRequested

Event Type

EventHandler<ListReadersRequestedEventArgs>

ReleaseContextRequested

Fired when |SCardReleaseContext| is called.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga6aabcba7744c5c9419fdd6404f73a934 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardreleasecontext

public event EventHandler<ReleaseContextRequestedEventArgs>? ReleaseContextRequested

Event Type

EventHandler<ReleaseContextRequestedEventArgs>

SetAttribRequested

Fired when |SCardSetAttrib| is called.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga060f0038a4ddfd5dd2b8fadf3c3a2e4f Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardsetattrib

public event EventHandler<SetAttribRequestedEventArgs>? SetAttribRequested

Event Type

EventHandler<SetAttribRequestedEventArgs>

StatusRequested

Fired when |SCardStatus| is called.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gae49c3c894ad7ac12a5b896bde70d0382 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardstatusa

public event EventHandler<StatusRequestedEventArgs>? StatusRequested

Event Type

EventHandler<StatusRequestedEventArgs>

TransmitRequested

Fired when |SCardTransmit| is called.

This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga9a2d77242a271310269065e64633ab99 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardtransmit

public event EventHandler<TransmitRequestedEventArgs>? TransmitRequested

Event Type

EventHandler<TransmitRequestedEventArgs>