Class OverlayAdapter

Namespace

OpenQA.Selenium.DevTools.V85.Overlay

Assembly

WebDriver.dll

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

public class OverlayAdapter

Inheritance

object

OverlayAdapter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OverlayAdapter(IDevToolsSession)

Initializes a new instance of the OverlayAdapter class.

public OverlayAdapter(IDevToolsSession session)

Parameters

session IDevToolsSession

The IDevToolsSession to be used with this adapter.

Properties

Session

Gets the DevToolsSession associated with the adapter.

public IDevToolsSession Session { get; }

Property Value

IDevToolsSession

Methods

Disable(DisableCommandSettings, CancellationToken, int?, bool)

disable

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)

enable

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>

GetHighlightObjectForTest(GetHighlightObjectForTestCommandSettings, CancellationToken, int?, bool)

getHighlightObjectForTest

public Task<GetHighlightObjectForTestCommandResponse> GetHighlightObjectForTest(GetHighlightObjectForTestCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command GetHighlightObjectForTestCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<GetHighlightObjectForTestCommandResponse>

HideHighlight(HideHighlightCommandSettings, CancellationToken, int?, bool)

hideHighlight

public Task<HideHighlightCommandResponse> HideHighlight(HideHighlightCommandSettings command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command HideHighlightCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<HideHighlightCommandResponse>

HighlightFrame(HighlightFrameCommandSettings, CancellationToken, int?, bool)

highlightFrame

public Task<HighlightFrameCommandResponse> HighlightFrame(HighlightFrameCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command HighlightFrameCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<HighlightFrameCommandResponse>

HighlightNode(HighlightNodeCommandSettings, CancellationToken, int?, bool)

highlightNode

public Task<HighlightNodeCommandResponse> HighlightNode(HighlightNodeCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command HighlightNodeCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<HighlightNodeCommandResponse>

HighlightQuad(HighlightQuadCommandSettings, CancellationToken, int?, bool)

highlightQuad

public Task<HighlightQuadCommandResponse> HighlightQuad(HighlightQuadCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command HighlightQuadCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<HighlightQuadCommandResponse>

HighlightRect(HighlightRectCommandSettings, CancellationToken, int?, bool)

highlightRect

public Task<HighlightRectCommandResponse> HighlightRect(HighlightRectCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command HighlightRectCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<HighlightRectCommandResponse>

SetInspectMode(SetInspectModeCommandSettings, CancellationToken, int?, bool)

setInspectMode

public Task<SetInspectModeCommandResponse> SetInspectMode(SetInspectModeCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetInspectModeCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetInspectModeCommandResponse>

SetPausedInDebuggerMessage(SetPausedInDebuggerMessageCommandSettings, CancellationToken, int?, bool)

setPausedInDebuggerMessage

public Task<SetPausedInDebuggerMessageCommandResponse> SetPausedInDebuggerMessage(SetPausedInDebuggerMessageCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetPausedInDebuggerMessageCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetPausedInDebuggerMessageCommandResponse>

SetShowAdHighlights(SetShowAdHighlightsCommandSettings, CancellationToken, int?, bool)

setShowAdHighlights

public Task<SetShowAdHighlightsCommandResponse> SetShowAdHighlights(SetShowAdHighlightsCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetShowAdHighlightsCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetShowAdHighlightsCommandResponse>

SetShowDebugBorders(SetShowDebugBordersCommandSettings, CancellationToken, int?, bool)

setShowDebugBorders

public Task<SetShowDebugBordersCommandResponse> SetShowDebugBorders(SetShowDebugBordersCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetShowDebugBordersCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetShowDebugBordersCommandResponse>

SetShowFPSCounter(SetShowFPSCounterCommandSettings, CancellationToken, int?, bool)

setShowFPSCounter

public Task<SetShowFPSCounterCommandResponse> SetShowFPSCounter(SetShowFPSCounterCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetShowFPSCounterCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetShowFPSCounterCommandResponse>

SetShowHinge(SetShowHingeCommandSettings, CancellationToken, int?, bool)

setShowHinge

public Task<SetShowHingeCommandResponse> SetShowHinge(SetShowHingeCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetShowHingeCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetShowHingeCommandResponse>

SetShowHitTestBorders(SetShowHitTestBordersCommandSettings, CancellationToken, int?, bool)

setShowHitTestBorders

public Task<SetShowHitTestBordersCommandResponse> SetShowHitTestBorders(SetShowHitTestBordersCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetShowHitTestBordersCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetShowHitTestBordersCommandResponse>

SetShowLayoutShiftRegions(SetShowLayoutShiftRegionsCommandSettings, CancellationToken, int?, bool)

setShowLayoutShiftRegions

public Task<SetShowLayoutShiftRegionsCommandResponse> SetShowLayoutShiftRegions(SetShowLayoutShiftRegionsCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetShowLayoutShiftRegionsCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetShowLayoutShiftRegionsCommandResponse>

SetShowPaintRects(SetShowPaintRectsCommandSettings, CancellationToken, int?, bool)

setShowPaintRects

public Task<SetShowPaintRectsCommandResponse> SetShowPaintRects(SetShowPaintRectsCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetShowPaintRectsCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetShowPaintRectsCommandResponse>

SetShowScrollBottleneckRects(SetShowScrollBottleneckRectsCommandSettings, CancellationToken, int?, bool)

setShowScrollBottleneckRects

public Task<SetShowScrollBottleneckRectsCommandResponse> SetShowScrollBottleneckRects(SetShowScrollBottleneckRectsCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetShowScrollBottleneckRectsCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetShowScrollBottleneckRectsCommandResponse>

SetShowViewportSizeOnResize(SetShowViewportSizeOnResizeCommandSettings, CancellationToken, int?, bool)

setShowViewportSizeOnResize

public Task<SetShowViewportSizeOnResizeCommandResponse> SetShowViewportSizeOnResize(SetShowViewportSizeOnResizeCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetShowViewportSizeOnResizeCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetShowViewportSizeOnResizeCommandResponse>

Events

InspectModeCanceled

inspectModeCanceled

public event EventHandler<InspectModeCanceledEventArgs> InspectModeCanceled

Event Type

EventHandler<InspectModeCanceledEventArgs>

InspectNodeRequested

inspectNodeRequested

public event EventHandler<InspectNodeRequestedEventArgs> InspectNodeRequested

Event Type

EventHandler<InspectNodeRequestedEventArgs>

NodeHighlightRequested

nodeHighlightRequested

public event EventHandler<NodeHighlightRequestedEventArgs> NodeHighlightRequested

Event Type

EventHandler<NodeHighlightRequestedEventArgs>

ScreenshotRequested

screenshotRequested

public event EventHandler<ScreenshotRequestedEventArgs> ScreenshotRequested

Event Type

EventHandler<ScreenshotRequestedEventArgs>