Interface IHasVirtualAuthenticator

Namespace

OpenQA.Selenium.VirtualAuth

Assembly

WebDriver.dll

Interface indicating that an object supports using a virtual authenticator.

public interface IHasVirtualAuthenticator

Methods

AddCredential(Credential)

Adds a credential to the virtual authenticator.

void AddCredential(Credential credential)

Parameters

credential Credential

The credential to add to the authenticator.

Exceptions

ArgumentNullException

If credential is null.

InvalidOperationException

If a Virtual Authenticator has not been added yet.

AddVirtualAuthenticator(VirtualAuthenticatorOptions)

Adds a virtual authenticator.

string AddVirtualAuthenticator(VirtualAuthenticatorOptions options)

Parameters

options VirtualAuthenticatorOptions

The VirtualAuthenticatorOptions to use in creating the authenticator.

Returns

string

The ID of the added virtual authenticator.

Exceptions

ArgumentNullException

If options is null.

GetCredentials()

Gets a list of the credentials registered to the virtual authenticator.

List<Credential> GetCredentials()

Returns

List<Credential>

The list of credentials registered to the virtual authenticator.

RemoveAllCredentials()

Removes all credentials registered to this virtual authenticator.

void RemoveAllCredentials()

Exceptions

InvalidOperationException

If a Virtual Authenticator has not been added yet.

RemoveCredential(byte[])

Removes a credential from the virtual authenticator.

void RemoveCredential(byte[] credentialId)

Parameters

credentialId byte[]

A byte array representing the ID of the credential to remove.

Exceptions

ArgumentNullException

If credentialId is null.

InvalidOperationException

If a Virtual Authenticator has not been added yet.

RemoveCredential(string)

Removes a credential from the virtual authenticator.

void RemoveCredential(string credentialId)

Parameters

credentialId string

A string representing the ID of the credential to remove.

Exceptions

ArgumentNullException

If credentialId is null.

InvalidOperationException

If a Virtual Authenticator has not been added yet.

RemoveVirtualAuthenticator(string)

Removes a virtual authenticator.

void RemoveVirtualAuthenticator(string id)

Parameters

id string

The ID of the virtual authenticator to remove.

Exceptions

ArgumentNullException

If id is null.

WebDriverArgumentException

If the specified virtual authenticator does not exist.

SetUserVerified(bool)

Sets whether or not a user is verified in this virtual authenticator.

void SetUserVerified(bool verified)

Parameters

verified bool

true if the user is verified; otherwise false.

Exceptions

InvalidOperationException

If a Virtual Authenticator has not been added yet.