Class UnsubscribeByAttributesCommandParameters

Namespace

WebDriverBiDi.Session

Assembly

WebDriverBiDi.dll

Provides parameters for the session.unsubscribe command that cancel subscriptions by the event names and browsing contexts they were made for.

public class UnsubscribeByAttributesCommandParameters : UnsubscribeCommandParameters

Inheritance

object

CommandParameters

CommandParameters<UnsubscribeCommandResult>

UnsubscribeCommandParameters

UnsubscribeByAttributesCommandParameters

Inherited Members

UnsubscribeCommandParameters.MethodName

CommandParameters<UnsubscribeCommandResult>.ResponseType

CommandParameters.AdditionalData

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

UnsubscribeByAttributesCommandParameters(IList<string>)

Initializes a new instance of the UnsubscribeByAttributesCommandParameters class.

public UnsubscribeByAttributesCommandParameters(IList<string> events)

Parameters

events IList<string>

The list of events from which to unsubscribe.

Remarks

The specification requires an unsubscription to name at least one event. Unlike values whose specification constraints the remote end enforces, an empty events list is rejected here: an unsubscription from no events cannot be meaningful under any revision of the specification, and accepting it would only defer a certain failure to the remote end.

Exceptions

ArgumentException

Thrown when no events are specified in the events list.

UnsubscribeByAttributesCommandParameters(string)

Initializes a new instance of the UnsubscribeByAttributesCommandParameters class for a single event.

public UnsubscribeByAttributesCommandParameters(string eventName)

Parameters

eventName string

The event from which to unsubscribe.

Properties

Events

Gets the list of events to which to unsubscribe.

[JsonPropertyName("events")]
public List<string> Events { get; }

Property Value

List<string>