Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/reference/bidi.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
title: BiDi Protocol Support
title: BiDi Events
---

XCUITest driver has partial support of the [BiDi Protocol](https://w3c.github.io/webdriver-bidi/) since version 7.26.0.
Only events and commands mentioned below are supported.
All other entities described in the spec throw not implemented errors.
The XCUITest driver has partial support of the [WebDriver BiDi Protocol](https://w3c.github.io/webdriver-bidi/).
Only the events and commands mentioned below are supported. All other entities described in the
specification throw not implemented errors.

# Supported Events
For other BiDi events recognized by the Appium server, see
[their Appium docs reference page](https://appium.io/docs/en/latest/reference/api/bidi/).

## log.entryAdded

Expand Down
3 changes: 3 additions & 0 deletions docs/reference/capabilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ title: Capabilities
This page lists various capabilities used and implemented by the XCUITest driver. To learn more
about capabilities, refer to the [Appium documentation](https://appium.io/docs/en/latest/guides/caps/).

For other capabilities recognized by the Appium server, see
[their Appium docs reference page](https://appium.io/docs/en/latest/reference/session/caps/).

### General

| <div style="width:10em">Capability</div> | Description |
Expand Down
6 changes: 2 additions & 4 deletions docs/reference/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@ these commands.
Please note that most of the driver-specific functionality is available using
[Execute Methods](./execute-methods.md) instead.

!!! info

Check the [Appium base driver documentation](https://appium.io/docs/en/latest/reference/commands/base-driver/)
for commands inherited by the XCUITest driver
For other API endpoints recognized by the Appium server and base driver, see
[their Appium docs reference pages](https://appium.io/docs/en/latest/reference/api/).

### `getClipboard`

Expand Down
7 changes: 5 additions & 2 deletions docs/reference/env-vars.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,14 @@ hide:
title: Environment Variables
---

This article describes environment variables that influence various XCUITest driver behaviors.
The driver recognizes several environment variables, which can be set when launching the Appium server.

For other environment variables recognized by the Appium server, see
[their Appium docs reference page](https://appium.io/docs/en/latest/reference/cli/env-vars/).

|<div style="width:17em">Variable Name</div>|Description|
|------------|-----------|
|`APPIUM_PREFER_SYSTEM_UNZIP`|Being set to either `0` or `false` makes the driver to use built-in Node.js unzipper rather than the system unzip utility. Mostly used for debugging purposes or troubleshooting as the system unzip utility is more performant in comparison to the built-in one.|
|`APPIUM_XCUITEST_PREFER_DEVICECTL`|Being set to `true`, `1` or `true` makes the driver to use the devicectl Xcode utility to fetch the list of available devices UDIDs instead of the built-in usbmuxd client. Might be useful for some scenarios where the latter is unable to detect connected devices. See [PR #2194](https://github.com/appium/appium-xcuitest-driver/pull/2194) for more details.|
|`APPIUM_XCUITEST_PREFER_DEVICECTL`|Being set to `true`, `1` or `yes` makes the driver to use the devicectl Xcode utility to fetch the list of available devices UDIDs instead of the built-in usbmuxd client. Might be useful for some scenarios where the latter is unable to detect connected devices. See [PR #2194](https://github.com/appium/appium-xcuitest-driver/pull/2194) for more details.|
|`MJPEG_SCALING_FACTOR`|Overrides the default value for the `mjpegScalingFactor` setting when WebDriverAgent initializes the MJPEG screenshots broadcaster. Must be in range 1..100. This only affects the MJPEG stream and can still be changed later via the Settings API. See [MJPEG guide](../guides/mjpeg.md).|
|`MJPEG_SERVER_SCREENSHOT_QUALITY`|Overrides the default value for the `mjpegServerScreenshotQuality` setting when WebDriverAgent initializes the MJPEG screenshots broadcaster. Must be in range 1..100. This only affects the MJPEG stream and can still be changed later via the Settings API. See [MJPEG guide](../guides/mjpeg.md).|
5 changes: 3 additions & 2 deletions docs/reference/execute-methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
title: Execute Methods
---

In addition to standard W3C APIs, the driver provides many custom command extensions for executing
platform-specific scenarios. Use the following examples in order to invoke them from your client code:
In addition to standard W3C APIs, the driver provides many [custom command extensions](https://appium.io/docs/en/latest/guides/execute-methods/)
for executing platform-specific scenarios. Use the following examples in order to invoke them from
your client code:

=== "Java"

Expand Down
10 changes: 7 additions & 3 deletions docs/reference/security-flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,22 @@
hide:
- toc

title: Security Feature Flags
title: Insecure Features
---

Some insecure driver features are disabled by default. They can be enabled upon launching Appium as follows:
Some [insecure driver features](https://appium.io/docs/en/latest/guides/security/) are disabled by
default. They can be enabled upon launching Appium as follows:
```
appium --allow-insecure <feature-name>
appium --allow-insecure xcuitest:<feature-name>
```
or
```
appium --relaxed-security
```

For other insecure feature names recognized by the Appium server, see
[their Appium docs reference page](https://appium.io/docs/en/latest/reference/cli/insecure-features/).

|Feature Name|Description|
|------------|-----------|
|`shutdown_other_sims`|Allow any session to use a capability to shutdown any running simulators on the host|
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/server-args.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Some driver arguments can be set when launching the Appium server. This can be d
appium --driver-xcuitest-[argName]=[argValue]
```

For other command line flags recognized by the Appium server, see
[their Appium docs reference page](https://appium.io/docs/en/latest/reference/cli/server/).

|Argument|Description|Default|Example|
|----|-------|-----------|-------|
| `webdriveragent-port` | Local port used for communicating with WebDriverAgent | `8100` | `--driver-xcuitest-webdriveragent-port=8200` |
2 changes: 1 addition & 1 deletion docs/reference/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Settings
---

The XCUITest driver supports Appium's [Settings API](https://appium.io/docs/en/latest/guides/settings/).
Along with the common settings, the following driver-specific settings are available:
The following driver-specific settings are available:

| <div style="width:14em">Name</div> | Type | Description |
| --- | --- | --- |
Expand Down
9 changes: 4 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,16 @@ nav:
- preparation/prov-profile-full-manual.md
- preparation/prov-profile-generic-manual.md
- Reference:
- reference/scripts.md
- reference/bidi.md
- Server Configuration:
- Command Line:
- reference/scripts.md
- reference/server-args.md
- reference/security-flags.md
- Driver Configuration:
- reference/env-vars.md
- reference/security-flags.md
- Session Configuration:
- reference/capabilities.md
- reference/settings.md
- reference/commands.md
- reference/bidi.md
- reference/execute-methods.md
- Element Management:
- reference/locator-strategies.md
Expand Down
Loading