Class UnsubscribeByIdsCommandParameters

Namespace

WebDriverBiDi.Session

Assembly

WebDriverBiDi.dll

Provides parameters for the session.unsubscribe command that cancel subscriptions by the IDs the matching session.subscribe commands returned.

public class UnsubscribeByIdsCommandParameters : UnsubscribeCommandParameters

Inheritance

object

CommandParameters

CommandParameters<UnsubscribeCommandResult>

UnsubscribeCommandParameters

UnsubscribeByIdsCommandParameters

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

UnsubscribeByIdsCommandParameters(IList<string>)

Initializes a new instance of the UnsubscribeByIdsCommandParameters class.

public UnsubscribeByIdsCommandParameters(IList<string> subscriptionIds)

Parameters

subscriptionIds IList<string>

The list of IDs of subscriptions from which to unsubscribe.

Remarks

The specification requires an unsubscription to name at least one subscription ID. Unlike values whose specification constraints the remote end enforces, an empty subscription ID list is rejected here: an unsubscription from no subscriptions 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 subscription IDs are specified in the subscription ID list.

UnsubscribeByIdsCommandParameters(string)

Initializes a new instance of the UnsubscribeByIdsCommandParameters class for a single subscription.

public UnsubscribeByIdsCommandParameters(string subscriptionId)

Parameters

subscriptionId string

The ID of the subscription from which to unsubscribe.

Properties

SubscriptionIds

Gets the list of subscription IDs from which to unsubscribe.

[JsonPropertyName("subscriptions")]
public List<string> SubscriptionIds { get; }

Property Value

List<string>