Interface IWebBackend

Namespace

ProtoTest.Web

Assembly

ProtoTest.Web.dll

Executes ProtoTest web concepts using a concrete browser technology.

public interface IWebBackend : IAsyncDisposable

Inherited Members

IAsyncDisposable.DisposeAsync()

Extension Methods

SheetModelAssertions.ShouldMatchShape<TRow>(TRow, object, JsonSerializerOptions?)

Properties

CurrentAddress

The address the browser is on now, or null when the backend cannot report one. Page coverage reads it after a navigation (so a redirect is attributed to its final page) and after a passing assertion.

string? CurrentAddress { get; }

Property Value

string

Name

string Name { get; }

Property Value

string

Methods

BeginOperationAsync(WebBackendOperationContext, CancellationToken)

Lets a backend correlate one semantic ProtoTrace operation with native diagnostics.

ValueTask BeginOperationAsync(WebBackendOperationContext operation, CancellationToken cancellationToken = default)

Parameters

operation WebBackendOperationContext

cancellationToken CancellationToken

Returns

ValueTask

CheckAsync(WebElementReference, bool, CancellationToken)

ValueTask CheckAsync(WebElementReference element, bool isChecked, CancellationToken cancellationToken = default)

Parameters

element WebElementReference

isChecked bool

cancellationToken CancellationToken

Returns

ValueTask

ClickAsync(WebElementReference, CancellationToken)

ValueTask ClickAsync(WebElementReference element, CancellationToken cancellationToken = default)

Parameters

element WebElementReference

cancellationToken CancellationToken

Returns

ValueTask

CompleteAsync(CancellationToken)

Finalizes artifacts while Core's normal test teardown can still publish them.

ValueTask CompleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

ValueTask

CountAsync(WebElementReference, CancellationToken)

ValueTask<int> CountAsync(WebElementReference elements, CancellationToken cancellationToken = default)

Parameters

elements WebElementReference

cancellationToken CancellationToken

Returns

ValueTask<int>

EndOperationAsync(WebBackendOperationContext, ProtoTraceOutcome, Exception?, CancellationToken)

Closes native diagnostic correlation started for a semantic operation.

ValueTask EndOperationAsync(WebBackendOperationContext operation, ProtoTraceOutcome outcome, Exception? exception = null, CancellationToken cancellationToken = default)

Parameters

operation WebBackendOperationContext

outcome ProtoTraceOutcome

exception Exception

cancellationToken CancellationToken

Returns

ValueTask

FillAsync(WebElementReference, string, CancellationToken)

ValueTask FillAsync(WebElementReference element, string value, CancellationToken cancellationToken = default)

Parameters

element WebElementReference

value string

cancellationToken CancellationToken

Returns

ValueTask

IsCheckedAsync(WebElementReference, CancellationToken)

ValueTask<bool> IsCheckedAsync(WebElementReference element, CancellationToken cancellationToken = default)

Parameters

element WebElementReference

cancellationToken CancellationToken

Returns

ValueTask<bool>

IsEnabledAsync(WebElementReference, CancellationToken)

ValueTask<bool> IsEnabledAsync(WebElementReference element, CancellationToken cancellationToken = default)

Parameters

element WebElementReference

cancellationToken CancellationToken

Returns

ValueTask<bool>

IsVisibleAsync(WebElementReference, CancellationToken)

ValueTask<bool> IsVisibleAsync(WebElementReference element, CancellationToken cancellationToken = default)

Parameters

element WebElementReference

cancellationToken CancellationToken

Returns

ValueTask<bool>

NavigateAsync(Uri, CancellationToken)

ValueTask NavigateAsync(Uri address, CancellationToken cancellationToken = default)

Parameters

address Uri

cancellationToken CancellationToken

Returns

ValueTask

PressAsync(WebElementReference, WebKey, CancellationToken)

ValueTask PressAsync(WebElementReference element, WebKey key, CancellationToken cancellationToken = default)

Parameters

element WebElementReference

key WebKey

cancellationToken CancellationToken

Returns

ValueTask

ReadTextAsync(WebElementReference, CancellationToken)

ValueTask<string> ReadTextAsync(WebElementReference element, CancellationToken cancellationToken = default)

Parameters

element WebElementReference

cancellationToken CancellationToken

Returns

ValueTask<string>

ReadValueAsync(WebElementReference, CancellationToken)

ValueTask<string?> ReadValueAsync(WebElementReference element, CancellationToken cancellationToken = default)

Parameters

element WebElementReference

cancellationToken CancellationToken

Returns

ValueTask<string>

SelectOptionAsync(WebElementReference, string, CancellationToken)

ValueTask SelectOptionAsync(WebElementReference element, string value, CancellationToken cancellationToken = default)

Parameters

element WebElementReference

value string

cancellationToken CancellationToken

Returns

ValueTask