Add touch doc

macacajs · Dec 12, 2016 · c77ba9b · c77ba9b
1 parent dbed67e
commit c77ba9b
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/lib/macaca-wd.js b/lib/macaca-wd.js
@@ -817,6 +817,17 @@ function maximize() {}
  */
 function frame(frameRef) {}
 
+/**
+ * Apply touch actions on devices. Such as, tap/doubleTap/press/pinch/rotate/drag.
+ * @summary Support: iOS
+ * @see {@link https://w3c.github.io/webdriver/webdriver-spec.html#actions|POST /session/:sessionId/actions}
+ * @param {string} action Name of the action
+ * @param [object] args Parameters of the action
+ * @example driver.touch('doubleTap', { x: 100, y: 100 }); driver.elementById('info').touch('drag', { toX: 300, toY: 300 });
+ * @returns {Promise.<string>}
+ */
+function touch(action, args) {}
+
 Object.defineProperty(module, "exports", {
   get: function() {
     var main = '../wd/lib/main';