Appium-Execute Async（执行异步）

布满荆棘的人生 2023-01-14 01:38 132阅读 0赞

### Execute Async Script ###

*   *   *   *   *  Example Usage
                 *  Description
                 *  Support
                 *   *  Appium Server
                     *  Appium Clients
                 *  HTTP API Specifications
                 *   *  Endpoint
                     *  URL Parameters
                     *  JSON Parameters
                     *  Response

Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame (Web context only) //将JavaScript片段插入到页面中，以便在当前选定框架的环境中执行（仅限Web环境）

##### Example Usage #####

<table> 
 <thead> 
  <tr> 
   <th align="left"></th> 
   <th align="left"></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">Java</td> 
   <td align="left">((JavascriptExecutor) driver).executeAsyncScript(<code>"window.setTimeout(arguments[arguments.length - 1], 500);"</code>);</td> 
  </tr> 
  <tr> 
   <td align="left">Python</td> 
   <td align="left">self.driver.execute_async_script(‘document.title’)</td> 
  </tr> 
  <tr> 
   <td align="left">Javascript</td> 
   <td align="left">// webdriver.io example<br>driver.setAsyncTimeout(5000)<br>var result = browser.executeAsync(function(a, b, c, d, done) { <br> // browser context - you may access neither client nor console<br> setTimeout(function() { <br> done(a + b + c + d);<br> }, 3000);<br>}, 1, 2, 3, 4)<br><br>// node.js context - client and console are available<br>console.log(result); // outputs: 10<br><br>// wd example<br>await driver.safeExecuteAsync(<code>'document.title'</code>);</td> 
  </tr> 
  <tr> 
   <td align="left">Ruby</td> 
   <td align="left"># ruby_lib example<br>execute_async_script(<code>"document.title"</code>)<br><br># ruby_lib_core example<br>@driver.execute_async_script(<code>"document.title"</code>)</td> 
  </tr> 
  <tr> 
   <td align="left">C#</td> 
   <td align="left">// TODO C# sample</td> 
  </tr> 
  <tr> 
   <td align="left">PHP</td> 
   <td align="left">// TODO PHP sample</td> 
  </tr> 
 </tbody> 
</table>

##### Description #####

The executed script is assumed to be asynchronous and must signal that is done by invoking the provided callback, which is always provided as the final argument to the function. The value to this callback will be returned to the client.  
//假定执行的脚本是异步的，并且必须通过调用提供的回调来发出信号，该回调始终作为函数的最终参数提供。此回调的值将返回给客户端

Asynchronous script commands may not span page loads. If an unload event is fired while waiting for a script result, an error should be returned to the client.  
//异步脚本命令不能跨越页面加载。如果在等待脚本结果时触发卸载事件，则应向客户端返回错误

The script argument defines the script to execute in teh form of a function body. The function will be invoked with the provided args array and the values may be accessed via the arguments object in the order specified. The final argument will always be a callback function that must be invoked to signal that the script has finished.  
//异步脚本命令不能跨越页面加载。如果在等待脚本结果时触发卸载事件，则应向客户端返回错误。script参数定义以函数体形式执行的脚本

Arguments may be any JSON-primitive, array, or JSON object. JSON objects that define a WebElement reference will be converted to the corresponding DOM element. Likewise, any WebElements in the script result will be returned to the client as WebElement JSON objects.  
//如果在等待脚本结果时触发卸载事件，则应向客户端返回错误。script参数定义以函数体形式执行的脚本。将使用提供的args数组调用该函数，并且可以按指定的顺序通过arguments对象访问这些值

##### Support #####

###### Appium Server ######

<table> 
 <thead> 
  <tr> 
   <th align="left">Platform</th> 
   <th align="left">Driver</th> 
   <th align="left">Platform Versions</th> 
   <th align="left">Appium Version</th> 
   <th align="left">Driver Version</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">iOS</td> 
   <td align="left">XCUITest</td> 
   <td align="left">None</td> 
   <td align="left">None</td> 
   <td align="left">None</td> 
  </tr> 
  <tr> 
   <td align="left"></td> 
   <td align="left">UIAutomation</td> 
   <td align="left">None</td> 
   <td align="left">None</td> 
   <td align="left">None</td> 
  </tr> 
  <tr> 
   <td align="left">Android</td> 
   <td align="left">Espresso</td> 
   <td align="left">None</td> 
   <td align="left">None</td> 
   <td align="left">None</td> 
  </tr> 
  <tr> 
   <td align="left"></td> 
   <td align="left">UiAutomator2</td> 
   <td align="left">None</td> 
   <td align="left">None</td> 
   <td align="left">None</td> 
  </tr> 
  <tr> 
   <td align="left"></td> 
   <td align="left">UiAutomator</td> 
   <td align="left">None</td> 
   <td align="left">None</td> 
   <td align="left">None</td> 
  </tr> 
  <tr> 
   <td align="left">Mac</td> 
   <td align="left">Mac</td> 
   <td align="left">None</td> 
   <td align="left">None</td> 
   <td align="left">None</td> 
  </tr> 
  <tr> 
   <td align="left">Windows</td> 
   <td align="left">Windows</td> 
   <td align="left">None</td> 
   <td align="left">None</td> 
   <td align="left">None</td> 
  </tr> 
 </tbody> 
</table>

###### Appium Clients ######

<table> 
 <thead> 
  <tr> 
   <th align="left">Language</th> 
   <th align="left">Support</th> 
   <th align="left">Documentation</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">Java</td> 
   <td align="left">All</td> 
   <td align="left">seleniumhq.github.io</td> 
  </tr> 
  <tr> 
   <td align="left">Python</td> 
   <td align="left">All</td> 
   <td align="left">selenium-python.readthedocs.io</td> 
  </tr> 
  <tr> 
   <td align="left">Javascript (WebdriverIO)</td> 
   <td align="left">All</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">Javascript (WD)</td> 
   <td align="left">All</td> 
   <td align="left">github.com</td> 
  </tr> 
  <tr> 
   <td align="left">Ruby</td> 
   <td align="left">All</td> 
   <td align="left">www.rubydoc.info</td> 
  </tr> 
  <tr> 
   <td align="left">PHP</td> 
   <td align="left">All</td> 
   <td align="left">github.com</td> 
  </tr> 
  <tr> 
   <td align="left">C#</td> 
   <td align="left">All</td> 
   <td align="left">github.com</td> 
  </tr> 
 </tbody> 
</table>

##### HTTP API Specifications #####

###### Endpoint ######

`POST /session/:session_id/execute_async`

###### URL Parameters ######

<table> 
 <thead> 
  <tr> 
   <th align="left">name</th> 
   <th align="left">description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">session_id</td> 
   <td align="left">ID of the session to route the command to</td> 
  </tr> 
 </tbody> 
</table>

###### JSON Parameters ######

<table> 
 <thead> 
  <tr> 
   <th align="left">name</th> 
   <th align="left">type</th> 
   <th align="left">description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">script</td> 
   <td align="left"><code>string</code></td> 
   <td align="left">The script to execute</td> 
  </tr> 
  <tr> 
   <td align="left">args</td> 
   <td align="left"><code>array</code></td> 
   <td align="left">The script arguments</td> 
  </tr> 
 </tbody> 
</table>

###### Response ######

The script result (`any`)