Appium-Execute(执行)

迷南。 2023-01-14 01:39 137阅读 0赞

### Execute 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). Run a native mobile command (Native Context). //将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).executeScript(<code>"window.setTimeout(arguments[arguments.length - 1], 500);"</code>);</td> 
  </tr> 
  <tr> 
   <td align="left">Python</td> 
   <td align="left">self.driver.execute_script(‘document.title’)</td> 
  </tr> 
  <tr> 
   <td align="left">Javascript</td> 
   <td align="left">// webdriver.io example<br>var result = browser.execute(function(a, b, c, d) { <br> // browser context - you may not access client or console<br> return a + b + c + d;<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.execute(<code>'document.title'</code>);</td> 
  </tr> 
  <tr> 
   <td align="left">Ruby</td> 
   <td align="left"># ruby_lib example<br>execute_script(<code>"document.title"</code>)<br><br># ruby_lib_core example<br>@driver.execute_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 synchronous and the result of evaluating the script is returned to the client.  
//假定执行的脚本是同步的，并将脚本的计算结果返回给客户机

The script argument defines the script to execute in the form of a function body. The value returned by that function will be returned to the client. The function will be invoked with the provided args array and the values may be accessed via the arguments object in the order specified.  
//script参数以函数体的形式定义要执行的脚本。该函数返回的值将返回给客户端。将使用提供的args数组调用该函数，并且可以按指定的顺序通过arguments对象访问这些值

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.  
//参数可以是任何JSON原语、数组或JSON对象。定义WebElement引用的JSON对象将转换为相应的DOM元素。同样，脚本结果中的任何WebElement都将作为WebElement JSON对象返回给客户机

For execute in the native context, see Mobile Commands.  
//有关在本机环境中执行的信息，请参见移动命令

##### 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`

###### 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`)