Appium-Is Keyboard Shown(是否显示键盘)

秒速五厘米 2022-11-18 04:43 12阅读 0赞

### Is Keyboard Shown ###

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

Whether or not the soft keyboard is shown  
//是否显示软键盘

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

<table> 
 <thead> 
  <tr> 
   <th></th> 
   <th align="left"></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Java</td> 
   <td align="left">boolean isKeyboardShown = driver.isKeyboardShown();</td> 
  </tr> 
  <tr> 
   <td>Python</td> 
   <td align="left">driver.is_keyboard_shown()</td> 
  </tr> 
  <tr> 
   <td>Javascript</td> 
   <td align="left">// webdriver.io example<br>driver.isKeyboardShown();<br>// wd example<br>await driver.isKeyboardShown();</td> 
  </tr> 
  <tr> 
   <td>Ruby</td> 
   <td align="left"># ruby_lib example<br>is_keyboard_shown<br># ruby_lib_core example<br>@driver.is_keyboard_shown</td> 
  </tr> 
  <tr> 
   <td>C#</td> 
   <td align="left">// Not supported</td> 
  </tr> 
  <tr> 
   <td>PHP</td> 
   <td align="left">// Not supported</td> 
  </tr> 
 </tbody> 
</table>

##### Description #####

See https://developer.android.com/reference/android/view/KeyEvent.html for reference of available Android key code values

##### Support #####

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

<table> 
 <thead> 
  <tr> 
   <th>Platform</th> 
   <th>Driver</th> 
   <th>Platform Versions</th> 
   <th>Appium Version</th> 
   <th>Driver Version</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>iOS</td> 
   <td>XCUITest</td> 
   <td>9.3+</td> 
   <td>1.6.0+</td> 
   <td>All</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>UIAutomation</td> 
   <td>8.0 to 9.3</td> 
   <td>All</td> 
   <td>All</td> 
  </tr> 
  <tr> 
   <td>Android</td> 
   <td>Espresso</td> 
   <td>?+</td> 
   <td>1.9.0+</td> 
   <td>All</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>UiAutomator2</td> 
   <td>?+</td> 
   <td>1.6.0+</td> 
   <td>All</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>UiAutomator</td> 
   <td>4.3+</td> 
   <td>All</td> 
   <td>All</td> 
  </tr> 
  <tr> 
   <td>Mac</td> 
   <td>Mac</td> 
   <td>None</td> 
   <td>None</td> 
   <td>None</td> 
  </tr> 
  <tr> 
   <td>Windows</td> 
   <td>Windows</td> 
   <td>10+</td> 
   <td>1.6.0+</td> 
   <td>All</td> 
  </tr> 
 </tbody> 
</table>

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

<table> 
 <thead> 
  <tr> 
   <th>Language</th> 
   <th>Support</th> 
   <th>Documentation</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Java</td> 
   <td>All</td> 
   <td>appium.github.io</td> 
  </tr> 
  <tr> 
   <td>Python</td> 
   <td>All</td> 
   <td>appium.github.io</td> 
  </tr> 
  <tr> 
   <td>Javascript (WebdriverIO)</td> 
   <td>None</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>Javascript (WD)</td> 
   <td>All</td> 
   <td>github.com</td> 
  </tr> 
  <tr> 
   <td>Ruby</td> 
   <td>All</td> 
   <td>www.rubydoc.info</td> 
  </tr> 
  <tr> 
   <td>PHP</td> 
   <td>None</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>C#</td> 
   <td>None</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

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

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

`GET /session/:session_id/appium/device/is_keyboard_shown`

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

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

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

None

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

True if the keyboard is shown. (`boolean`) //显示键盘为真