Class UserPromptClosedEventArgs

Namespace

WebDriverBiDi.BrowsingContext

Assembly

WebDriverBiDi.dll

Object containing event data for the event raised when a user prompt is closed.

public record UserPromptClosedEventArgs : WebDriverBiDiEventArgs, IEquatable<WebDriverBiDiEventArgs>, IEquatable<UserPromptClosedEventArgs>

Inheritance

object

WebDriverBiDiEventArgs

UserPromptClosedEventArgs

Implements

IEquatable<WebDriverBiDiEventArgs>

IEquatable<UserPromptClosedEventArgs>

Inherited Members

WebDriverBiDiEventArgs.AdditionalData

WebDriverBiDiEventArgs.AdditionalEventProperties

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

UserPromptClosedEventArgs(string, bool)

Initializes a new instance of the UserPromptClosedEventArgs class.

[JsonConstructor]
public UserPromptClosedEventArgs(string browsingContextId, bool isAccepted)

Parameters

browsingContextId string

The browsing context for which the user prompt was closed.

isAccepted bool

A value of true if the user prompt was accepted; false if it was canceled.

UserPromptClosedEventArgs(UserPromptClosedEventArgs)

protected UserPromptClosedEventArgs(UserPromptClosedEventArgs original)

Parameters

original UserPromptClosedEventArgs

Properties

BrowsingContextId

Gets the ID of the browsing context for which the user prompt was closed.

[JsonPropertyName("context")]
[JsonRequired]
[JsonInclude]
public string BrowsingContextId { get; }

Property Value

string

EqualityContract

protected override Type EqualityContract { get; }

Property Value

Type

IsAccepted

Gets a value indicating whether the user prompt was accepted (true), or if it was canceled (false).

[JsonPropertyName("accepted")]
[JsonRequired]
[JsonInclude]
public bool IsAccepted { get; }

Property Value

bool

PromptType

Gets the type of the user prompt that was closed.

[JsonPropertyName("type")]
[JsonRequired]
[JsonInclude]
public UserPromptType PromptType { get; }

Property Value

UserPromptType

UserContextId

Gets the ID of the user context where the user prompt was closed.

[JsonPropertyName("userContext")]
[JsonInclude]
public string? UserContextId { get; }

Property Value

string

UserText

Gets the text the user entered into the prompt, if any, rather than the prompt's own message.

[JsonPropertyName("userText")]
[JsonInclude]
public string? UserText { get; }

Property Value

string

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(UserPromptClosedEventArgs?)

public virtual bool Equals(UserPromptClosedEventArgs? other)

Parameters

other UserPromptClosedEventArgs

Returns

bool

Equals(WebDriverBiDiEventArgs?)

public override sealed bool Equals(WebDriverBiDiEventArgs? other)

Parameters

other WebDriverBiDiEventArgs

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected override bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Operators

operator ==(UserPromptClosedEventArgs?, UserPromptClosedEventArgs?)

public static bool operator ==(UserPromptClosedEventArgs? left, UserPromptClosedEventArgs? right)

Parameters

left UserPromptClosedEventArgs

right UserPromptClosedEventArgs

Returns

bool

operator !=(UserPromptClosedEventArgs?, UserPromptClosedEventArgs?)

public static bool operator !=(UserPromptClosedEventArgs? left, UserPromptClosedEventArgs? right)

Parameters

left UserPromptClosedEventArgs

right UserPromptClosedEventArgs

Returns

bool