| // <copyright file="PauseInteraction.cs" company="Selenium Committers"> | |
| // Licensed to the Software Freedom Conservancy (SFC) under one | |
| // or more contributor license agreements. See the NOTICE file | |
| // distributed with this work for additional information | |
| // regarding copyright ownership. The SFC licenses this file | |
| // to you under the Apache License, Version 2.0 (the | |
| // "License"); you may not use this file except in compliance | |
| // with the License. You may obtain a copy of the License at | |
| // | |
| // http://www.apache.org/licenses/LICENSE-2.0 | |
| // | |
| // Unless required by applicable law or agreed to in writing, | |
| // software distributed under the License is distributed on an | |
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| // KIND, either express or implied. See the License for the | |
| // specific language governing permissions and limitations | |
| // under the License. | |
| // </copyright> | |
| using System.Globalization; | |
| namespace OpenQA.Selenium.Interactions; | |
| /// <summary> | |
| /// Represents a pause action. | |
| /// </summary> | |
| internal class PauseInteraction : Interaction | |
| { | |
| private readonly TimeSpan duration = TimeSpan.Zero; | |
| /// <summary> | |
| /// Initializes a new instance of the <see cref="PauseInteraction"/> class. | |
| /// </summary> | |
| /// <param name="sourceDevice">The input device on which to execute the pause.</param> | |
| public PauseInteraction(InputDevice sourceDevice) | |
| : this(sourceDevice, TimeSpan.Zero) | |
| { | |
| } | |
| /// <summary> | |
| /// Initializes a new instance of the <see cref="PauseInteraction"/> class. | |
| /// </summary> | |
| /// <param name="sourceDevice">The input device on which to execute the pause.</param> | |
| /// <param name="duration">The length of time to pause for.</param> | |
| /// <exception cref="ArgumentException">If <paramref name="duration"/> is negative.</exception> | |
| public PauseInteraction(InputDevice sourceDevice, TimeSpan duration) | |
| : base(sourceDevice) | |
| { | |
| if (duration < TimeSpan.Zero) | |
| { | |
| throw new ArgumentException("Duration must be greater than or equal to zero", nameof(duration)); | |
| } | |
| this.duration = duration; | |
| } | |
| /// <summary> | |
| /// Returns a value for this action that can be transmitted across the wire to a remote end. | |
| /// </summary> | |
| /// <returns>A <see cref="Dictionary{TKey, TValue}"/> representing this action.</returns> | |
| public override Dictionary<string, object> ToDictionary() | |
| { | |
| Dictionary<string, object> toReturn = new Dictionary<string, object>(); | |
| toReturn["type"] = "pause"; | |
| toReturn["duration"] = Convert.ToInt64(this.duration.TotalMilliseconds); | |
| return toReturn; | |
| } | |
| /// <summary> | |
| /// Gets a value indicating whether this action is valid for the specified type of input device. | |
| /// </summary> | |
| /// <param name="sourceDeviceKind">The type of device to check.</param> | |
| /// <returns><see langword="true"/> if the action is valid for the specified type of input device; | |
| /// otherwise, <see langword="false"/>.</returns> | |
| public override bool IsValidFor(InputDeviceKind sourceDeviceKind) | |
| { | |
| return true; | |
| } | |
| public override string ToString() | |
| { | |
| return string.Format(CultureInfo.InvariantCulture, "Pause [duration: {0} ms]", this.duration.TotalMilliseconds); | |
| } | |
| } |