feat: 'IOSDriver' to use modern mobile: commands for Lock, IsLocked…

… and Unlock (#875) * feat: `AppiumDriver` to use modern `mobile:` commands for Lock, IsLocked. feat: `IOSDriver` to use modern `mobile:` command for Unlock * Revert changes for AppiumDriver Make Lock methods specfic for iOS and Android
appium · Dec 13, 2024 · 9b035fe · 9b035fe
1 parent 71b07b2
commit 9b035fe
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 42 deletions.
diff --git a/src/Appium.Net/Appium/AppiumCommand.cs b/src/Appium.Net/Appium/AppiumCommand.cs
@@ -78,12 +78,6 @@ public class AppiumCommand
 
             new AppiumCommand(HttpCommandInfo.PostCommand, AppiumDriverCommand.ShakeDevice,
                 "/session/{sessionId}/appium/device/shake"),
-            new AppiumCommand(HttpCommandInfo.PostCommand, AppiumDriverCommand.LockDevice,
-                "/session/{sessionId}/appium/device/lock"),
-            new AppiumCommand(HttpCommandInfo.PostCommand, AppiumDriverCommand.IsLocked,
-                "/session/{sessionId}/appium/device/is_locked"),
-            new AppiumCommand(HttpCommandInfo.PostCommand, AppiumDriverCommand.UnlockDevice,
-                "/session/{sessionId}/appium/device/unlock"),
             new AppiumCommand(HttpCommandInfo.PostCommand, AppiumDriverCommand.PressKeyCode,
                 "/session/{sessionId}/appium/device/press_keycode"),
             new AppiumCommand(HttpCommandInfo.PostCommand, AppiumDriverCommand.LongPressKeyCode,

diff --git a/src/Appium.Net/Appium/AppiumCommandExecutionHelper.cs b/src/Appium.Net/Appium/AppiumCommandExecutionHelper.cs
@@ -82,11 +82,6 @@ public static bool IsKeyboardShown(IExecuteMethod executeMethod)
 
         #endregion
 
-        public static void Lock(IExecuteMethod executeMethod, int seconds) =>
-            executeMethod.Execute(AppiumDriverCommand.LockDevice,
-                new Dictionary<string, object>()
-                    {["seconds"] = seconds});
-
         public static void SetClipboard(IExecuteMethod executeMethod, ClipboardContentType clipboardContentType,
             string base64Content)
         {

diff --git a/src/Appium.Net/Appium/AppiumDriverCommand.cs b/src/Appium.Net/Appium/AppiumDriverCommand.cs
@@ -23,21 +23,6 @@ public class AppiumDriverCommand
         /// </summary>
         public const string ShakeDevice = "shakeDevice";
 
-        /// <summary>
-        /// Represents the Lock Device Mapping command
-        /// </summary>
-        public const string LockDevice = "lockDevice";
-
-        /// <summary>
-        /// Represents the Unlock Device Mapping command
-        /// </summary>
-        public const string UnlockDevice = "unlockDevice";
-
-        /// <summary>
-        /// Represents the Is Device Locked Mapping command
-        /// </summary>
-        public const string IsLocked = "isLocked";
-
         /// <summary>
         /// Toggle's the Airplane Mode ("Flight Safe Mode") Command
         /// </summary>

diff --git a/src/Appium.Net/Appium/iOS/IOSCommandExecutionHelper.cs b/src/Appium.Net/Appium/iOS/IOSCommandExecutionHelper.cs
@@ -33,15 +33,6 @@ public static void PerformTouchID(IExecuteMethod executeMethod, bool match) =>
             executeMethod.Execute(AppiumDriverCommand.TouchID,
                 new Dictionary<string, object> {["match"] = match});
 
-        public static bool IsLocked(IExecuteMethod executeMethod) =>
-            (bool)executeMethod.Execute(AppiumDriverCommand.IsLocked).Value;
-
-        public static void Unlock(IExecuteMethod executeMethod) =>
-            executeMethod.Execute(AppiumDriverCommand.UnlockDevice);
-
-        public static void Lock(IExecuteMethod executeMethod) =>
-            executeMethod.Execute(AppiumDriverCommand.LockDevice);
-
         public static void SetClipboardUrl(IExecuteMethod executeMethod, string url)
         {
             var urlEncoded = WebUtility.UrlEncode(url);

diff --git a/src/Appium.Net/Appium/iOS/IOSDriver.cs b/src/Appium.Net/Appium/iOS/IOSDriver.cs
@@ -187,19 +187,35 @@ public Dictionary<string, object> Settings
         public void HideKeyboard(string key, string strategy = null) =>
             AppiumCommandExecutionHelper.HideKeyboard(this, strategy, key);
 
+        public void PerformTouchID(bool match) => IOSCommandExecutionHelper.PerformTouchID(this, match);
+
         /// <summary>
-        /// Locks the device.
+        /// Check if the device is locked
         /// </summary>
-        /// <param name="seconds">The number of seconds during which the device need to be locked for.</param>
-        public void Lock(int seconds) => AppiumCommandExecutionHelper.Lock(this, seconds);
+        /// <returns>true if device is locked, false otherwise</returns>
+        public bool IsLocked() => (bool)ExecuteScript("mobile: isLocked");
 
-        public void PerformTouchID(bool match) => IOSCommandExecutionHelper.PerformTouchID(this, match);
+        /// <summary>
+        /// Locks the device. Optionally, unlocks it after a specified number of seconds.
+        /// </summary>
+        /// <param name="seconds">
+        /// The number of seconds after which the device will be automatically unlocked. 
+        /// Set to 0 or leave it empty to require manual unlock.
+        /// </param>
+        /// <exception cref="WebDriverException">Thrown if the command execution fails.</exception>
+        public void Lock(int? seconds = null)
+        {
+            var parameters = new Dictionary<string, object>();
 
-        public bool IsLocked() => IOSCommandExecutionHelper.IsLocked(this);
+            if (seconds.HasValue && seconds.Value > 0)
+            {
+                parameters["seconds"] = seconds.Value;
+            }
 
-        public void Unlock() => IOSCommandExecutionHelper.Unlock(this);
+            ExecuteScript("mobile: lock", parameters);
+        }
 
-        public void Lock() => IOSCommandExecutionHelper.Lock(this);
+        public void Unlock() => ExecuteScript("mobile: unlock");
 
         /// <summary>
         /// Sets the content to the clipboard