appium-mcp 0.0.1 → 1.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/ci.yml +37 -0
- package/.github/workflows/pr-title.yml +15 -0
- package/.github/workflows/publish.yml +31 -0
- package/.gitmodules +9 -0
- package/.prettierignore +29 -0
- package/.prettierrc +10 -0
- package/.releaserc +37 -0
- package/CHANGELOG.md +43 -0
- package/LICENSE +21 -0
- package/README.md +153 -0
- package/dist/devicemanager/adb-manager.d.ts +71 -0
- package/dist/devicemanager/adb-manager.js +140 -0
- package/dist/devicemanager/adb-manager.js.map +1 -0
- package/dist/devicemanager/ios-manager.d.ts +58 -0
- package/dist/devicemanager/ios-manager.js +122 -0
- package/dist/devicemanager/ios-manager.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +40 -0
- package/dist/index.js.map +1 -0
- package/dist/locators/element-filter.d.ts +13 -0
- package/dist/locators/element-filter.js +79 -0
- package/dist/locators/element-filter.js.map +1 -0
- package/dist/locators/generate-all-locators.d.ts +21 -0
- package/dist/locators/generate-all-locators.js +72 -0
- package/dist/locators/generate-all-locators.js.map +1 -0
- package/dist/locators/locator-generation.d.ts +36 -0
- package/dist/locators/locator-generation.js +501 -0
- package/dist/locators/locator-generation.js.map +1 -0
- package/dist/locators/logger.d.ts +5 -0
- package/dist/locators/logger.js +9 -0
- package/dist/locators/logger.js.map +1 -0
- package/dist/locators/source-parsing.d.ts +43 -0
- package/dist/locators/source-parsing.js +100 -0
- package/dist/locators/source-parsing.js.map +1 -0
- package/dist/resources/index.d.ts +1 -0
- package/dist/resources/index.js +7 -0
- package/dist/resources/index.js.map +1 -0
- package/dist/resources/java/template.d.ts +4 -0
- package/dist/resources/java/template.js +82 -0
- package/dist/resources/java/template.js.map +1 -0
- package/dist/schema.d.ts +2 -0
- package/dist/schema.js +5 -0
- package/dist/schema.js.map +1 -0
- package/dist/scripts/simple-index-documentation.d.ts +20 -0
- package/dist/scripts/simple-index-documentation.js +77 -0
- package/dist/scripts/simple-index-documentation.js.map +1 -0
- package/dist/scripts/simple-query-documentation.d.ts +12 -0
- package/dist/scripts/simple-query-documentation.js +52 -0
- package/dist/scripts/simple-query-documentation.js.map +1 -0
- package/dist/server.d.ts +3 -0
- package/dist/server.js +37 -0
- package/dist/server.js.map +1 -0
- package/dist/tests/__mocks__/@appium/support.d.ts +21 -0
- package/dist/tests/__mocks__/@appium/support.js +30 -0
- package/dist/tests/__mocks__/@appium/support.js.map +1 -0
- package/dist/tests/generate-all-locators.test.d.ts +1 -0
- package/dist/tests/generate-all-locators.test.js +140 -0
- package/dist/tests/generate-all-locators.test.js.map +1 -0
- package/dist/tests/test-setup-wda.d.ts +1 -0
- package/dist/tests/test-setup-wda.js +202 -0
- package/dist/tests/test-setup-wda.js.map +1 -0
- package/dist/tools/answer-appium.d.ts +1 -0
- package/dist/tools/answer-appium.js +71 -0
- package/dist/tools/answer-appium.js.map +1 -0
- package/dist/tools/boot-simulator.d.ts +1 -0
- package/dist/tools/boot-simulator.js +71 -0
- package/dist/tools/boot-simulator.js.map +1 -0
- package/dist/tools/create-session.d.ts +1 -0
- package/dist/tools/create-session.js +192 -0
- package/dist/tools/create-session.js.map +1 -0
- package/dist/tools/delete-session.d.ts +1 -0
- package/dist/tools/delete-session.js +47 -0
- package/dist/tools/delete-session.js.map +1 -0
- package/dist/tools/documentation/index.d.ts +28 -0
- package/dist/tools/documentation/index.js +63 -0
- package/dist/tools/documentation/index.js.map +1 -0
- package/dist/tools/documentation/reasoning-rag.d.ts +88 -0
- package/dist/tools/documentation/reasoning-rag.js +281 -0
- package/dist/tools/documentation/reasoning-rag.js.map +1 -0
- package/dist/tools/documentation/sentence-transformers-embeddings.d.ts +34 -0
- package/dist/tools/documentation/sentence-transformers-embeddings.js +111 -0
- package/dist/tools/documentation/sentence-transformers-embeddings.js.map +1 -0
- package/dist/tools/documentation/simple-pdf-indexer.d.ts +45 -0
- package/dist/tools/documentation/simple-pdf-indexer.js +402 -0
- package/dist/tools/documentation/simple-pdf-indexer.js.map +1 -0
- package/dist/tools/documentation/uploads/documents.json +1 -0
- package/dist/tools/generate-tests.d.ts +2 -0
- package/dist/tools/generate-tests.js +46 -0
- package/dist/tools/generate-tests.js.map +1 -0
- package/dist/tools/index.d.ts +16 -0
- package/dist/tools/index.js +114 -0
- package/dist/tools/index.js.map +1 -0
- package/dist/tools/install-wda.d.ts +1 -0
- package/dist/tools/install-wda.js +219 -0
- package/dist/tools/install-wda.js.map +1 -0
- package/dist/tools/interactions/activate-app.d.ts +2 -0
- package/dist/tools/interactions/activate-app.js +44 -0
- package/dist/tools/interactions/activate-app.js.map +1 -0
- package/dist/tools/interactions/click.d.ts +2 -0
- package/dist/tools/interactions/click.js +45 -0
- package/dist/tools/interactions/click.js.map +1 -0
- package/dist/tools/interactions/double-tap.d.ts +2 -0
- package/dist/tools/interactions/double-tap.js +81 -0
- package/dist/tools/interactions/double-tap.js.map +1 -0
- package/dist/tools/interactions/find.d.ts +13 -0
- package/dist/tools/interactions/find.js +55 -0
- package/dist/tools/interactions/find.js.map +1 -0
- package/dist/tools/interactions/get-page-source.d.ts +2 -0
- package/dist/tools/interactions/get-page-source.js +48 -0
- package/dist/tools/interactions/get-page-source.js.map +1 -0
- package/dist/tools/interactions/get-text.d.ts +2 -0
- package/dist/tools/interactions/get-text.js +45 -0
- package/dist/tools/interactions/get-text.js.map +1 -0
- package/dist/tools/interactions/install-app.d.ts +2 -0
- package/dist/tools/interactions/install-app.js +43 -0
- package/dist/tools/interactions/install-app.js.map +1 -0
- package/dist/tools/interactions/list-apps.d.ts +2 -0
- package/dist/tools/interactions/list-apps.js +59 -0
- package/dist/tools/interactions/list-apps.js.map +1 -0
- package/dist/tools/interactions/screenshot.d.ts +2 -0
- package/dist/tools/interactions/screenshot.js +49 -0
- package/dist/tools/interactions/screenshot.js.map +1 -0
- package/dist/tools/interactions/set-value.d.ts +2 -0
- package/dist/tools/interactions/set-value.js +46 -0
- package/dist/tools/interactions/set-value.js.map +1 -0
- package/dist/tools/interactions/terminate-app.d.ts +2 -0
- package/dist/tools/interactions/terminate-app.js +45 -0
- package/dist/tools/interactions/terminate-app.js.map +1 -0
- package/dist/tools/interactions/uninstall-app.d.ts +2 -0
- package/dist/tools/interactions/uninstall-app.js +45 -0
- package/dist/tools/interactions/uninstall-app.js.map +1 -0
- package/dist/tools/locators.d.ts +1 -0
- package/dist/tools/locators.js +71 -0
- package/dist/tools/locators.js.map +1 -0
- package/dist/tools/scroll-to-element.d.ts +1 -0
- package/dist/tools/scroll-to-element.js +155 -0
- package/dist/tools/scroll-to-element.js.map +1 -0
- package/dist/tools/scroll.d.ts +1 -0
- package/dist/tools/scroll.js +91 -0
- package/dist/tools/scroll.js.map +1 -0
- package/dist/tools/select-device.d.ts +5 -0
- package/dist/tools/select-device.js +222 -0
- package/dist/tools/select-device.js.map +1 -0
- package/dist/tools/select-platform.d.ts +1 -0
- package/dist/tools/select-platform.js +195 -0
- package/dist/tools/select-platform.js.map +1 -0
- package/dist/tools/session-store.d.ts +7 -0
- package/dist/tools/session-store.js +64 -0
- package/dist/tools/session-store.js.map +1 -0
- package/dist/tools/setup-wda.d.ts +1 -0
- package/dist/tools/setup-wda.js +177 -0
- package/dist/tools/setup-wda.js.map +1 -0
- package/docs/CONTRIBUTING.md +424 -0
- package/eslint.config.js +49 -0
- package/examples/android-gmail.md +7 -0
- package/examples/android-todo-app.md +9 -0
- package/jest.config.js +23 -0
- package/package.json +71 -6
- package/scripts/setup-submodules-sparse.sh +53 -0
- package/scripts/update-submodules.sh +14 -0
- package/src/devicemanager/adb-manager.ts +164 -0
- package/src/devicemanager/ios-manager.ts +145 -0
- package/src/index.ts +47 -0
- package/src/locators/element-filter.ts +134 -0
- package/src/locators/generate-all-locators.ts +149 -0
- package/src/locators/locator-generation.ts +657 -0
- package/src/locators/logger.ts +11 -0
- package/src/locators/source-parsing.ts +149 -0
- package/src/resources/caps.json +697 -0
- package/src/resources/index.ts +7 -0
- package/src/resources/java/template.ts +83 -0
- package/src/resources/submodules/appium/.github/PULL_REQUEST_TEMPLATE.md +28 -0
- package/src/resources/submodules/appium/CHANGELOG.md +45 -0
- package/src/resources/submodules/appium/CONDUCT.md +48 -0
- package/src/resources/submodules/appium/GOVERNANCE.md +185 -0
- package/src/resources/submodules/appium/IDEAS.md +16 -0
- package/src/resources/submodules/appium/README.md +221 -0
- package/src/resources/submodules/appium/ROADMAP.md +30 -0
- package/src/resources/submodules/appium/SPONSORS.md +3 -0
- package/src/resources/submodules/appium/docs/README.md +6 -0
- package/src/resources/submodules/appium/docs/payout.md +35 -0
- package/src/resources/submodules/appium/packages/appium/CHANGELOG.md +1437 -0
- package/src/resources/submodules/appium/packages/appium/README.md +221 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/index.md +2 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/announcing-appiumconf2024.md +45 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/announcing-browserstack-as-strategic-partner.md +46 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/announcing-headspin-as-development-partner.md +47 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/announcing-lambdatest-as-strategic-partner.md +42 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/announcing-sauce-labs-as-strategic-partner.md +36 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/announcing-sponsorship-program.md +48 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/appium3.md +40 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/blog/posts/hello-world.md +15 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/contributing/index.md +150 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/developing/build-docs.md +86 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/developing/build-doctor-checks.md +141 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/developing/build-drivers.md +860 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/developing/build-plugins.md +514 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/developing/config-system.md +451 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/developing/index.md +18 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/developing/sensitive.md +49 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/ecosystem/clients.md +132 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/ecosystem/drivers.md +207 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/ecosystem/index.md +45 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/ecosystem/plugins.md +138 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/ecosystem/tools.md +83 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/branch-testing.md +57 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/caching.md +76 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/caps.md +275 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/config.md +98 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/context.md +44 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/event-timing.md +73 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/execute-methods.md +122 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/grid.md +166 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/headers.md +17 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/log-filters.md +86 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/managing-exts.md +87 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/migrating-1-to-2.md +368 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/migrating-2-to-3.md +464 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/security.md +89 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/settings.md +68 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/guides/tls.md +42 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/index.md +59 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/intro/appium.md +202 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/intro/clients.md +127 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/intro/drivers.md +188 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/intro/history.md +196 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/intro/index.md +39 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/index.md +29 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/install.md +50 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/next-steps.md +23 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/requirements.md +29 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/test-dotnet.md +105 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/test-java.md +23 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/test-js.md +75 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/test-py.md +60 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/test-rb.md +83 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/quickstart/uiauto2-driver.md +144 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/appium.md +394 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/bidi.md +70 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/index.md +30 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/jsonwp.md +214 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/mjsonwp.md +151 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/others.md +671 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/plugins.md +289 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/api/webdriver.md +1114 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/cli/env-vars.md +31 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/cli/extensions.md +239 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/cli/index.md +35 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/cli/server.md +76 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/cli/setup.md +76 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/reference/index.md +25 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/resources/index.md +28 -0
- package/src/resources/submodules/appium/packages/appium/docs/en/sponsors/index.md +64 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/index.md +2 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/announcing-appiumconf2024.md +45 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/announcing-browserstack-as-strategic-partner.md +46 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/announcing-headspin-as-development-partner.md +47 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/announcing-lambdatest-as-strategic-partner.md +41 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/announcing-sauce-labs-as-strategic-partner.md +36 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/announcing-sponsorship-program.md +48 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/appium3.md +40 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/blog/posts/hello-world.md +15 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/contributing/index.md +158 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/developing/build-docs.md +86 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/developing/build-doctor-checks.md +141 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/developing/build-drivers.md +866 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/developing/build-plugins.md +520 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/developing/config-system.md +468 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/developing/index.md +18 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/developing/sensitive.md +49 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/ecosystem/clients.md +143 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/ecosystem/drivers.md +219 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/ecosystem/index.md +45 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/ecosystem/plugins.md +140 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/ecosystem/tools.md +87 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/branch-testing.md +57 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/caching.md +78 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/caps.md +259 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/config.md +102 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/context.md +44 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/event-timing.md +75 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/execute-methods.md +142 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/grid.md +166 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/headers.md +17 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/log-filters.md +86 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/managing-exts.md +89 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/migrating-1-to-2.md +402 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/migrating-2-to-3.md +458 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/security.md +89 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/settings.md +70 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/guides/tls.md +43 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/index.md +55 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/intro/appium.md +191 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/intro/clients.md +139 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/intro/drivers.md +188 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/intro/history.md +196 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/intro/index.md +39 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/index.md +23 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/install.md +47 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/next-steps.md +19 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/requirements.md +29 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/test-dotnet.md +107 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/test-java.md +23 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/test-js.md +77 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/test-py.md +63 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/test-rb.md +85 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/quickstart/uiauto2-driver.md +148 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/api/appium.md +395 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/api/bidi.md +71 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/api/index.md +30 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/api/jsonwp.md +215 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/api/mjsonwp.md +152 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/api/others.md +672 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/api/plugins.md +291 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/api/webdriver.md +1114 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/cli/env-vars.md +31 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/cli/extensions.md +240 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/cli/index.md +35 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/cli/server.md +76 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/cli/setup.md +78 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/reference/index.md +25 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/resources/index.md +28 -0
- package/src/resources/submodules/appium/packages/appium/docs/ja/sponsors/index.md +61 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/appium-logo-horiz-white.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/appium-logo-horiz.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/appium-logo-white.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/appium-logo.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/sponsor-logo-browserstack-dark.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/sponsor-logo-browserstack-light.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/sponsor-logo-lambdatest-dark.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/sponsor-logo-lambdatest-light.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/overrides/assets/images/sponsor-logo-sauce.png +0 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/index.md +2 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-appiumconf2024.md +45 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-browserstack-as-strategic-partner.md +46 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-headspin-as-development-partner.md +47 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-lambdatest-as-strategic-partner.md +41 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-sauce-labs-as-strategic-partner.md +36 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/announcing-sponsorship-program.md +48 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/appium3.md +40 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/blog/posts/hello-world.md +15 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/contributing/index.md +132 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/developing/build-docs.md +86 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/developing/build-doctor-checks.md +141 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/developing/build-drivers.md +866 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/developing/build-plugins.md +520 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/developing/config-system.md +468 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/developing/index.md +18 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/developing/sensitive.md +49 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/ecosystem/clients.md +143 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/ecosystem/drivers.md +219 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/ecosystem/index.md +45 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/ecosystem/plugins.md +140 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/ecosystem/tools.md +87 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/branch-testing.md +57 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/caching.md +78 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/caps.md +284 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/config.md +102 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/context.md +44 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/event-timing.md +75 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/execute-methods.md +142 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/grid.md +166 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/headers.md +17 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/log-filters.md +86 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/managing-exts.md +89 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/migrating-1-to-2.md +410 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/migrating-2-to-3.md +459 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/security.md +89 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/settings.md +70 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/guides/tls.md +43 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/index.md +54 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/intro/appium.md +200 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/intro/clients.md +139 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/intro/drivers.md +188 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/intro/history.md +196 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/intro/index.md +39 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/index.md +23 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/install.md +47 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/next-steps.md +19 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/requirements.md +21 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/test-dotnet.md +99 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/test-java.md +20 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/test-js.md +62 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/test-py.md +57 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/test-rb.md +80 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/quickstart/uiauto2-driver.md +148 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/api/appium.md +395 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/api/bidi.md +71 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/api/index.md +30 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/api/jsonwp.md +215 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/api/mjsonwp.md +152 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/api/others.md +672 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/api/plugins.md +291 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/api/webdriver.md +1114 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/cli/env-vars.md +31 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/cli/extensions.md +240 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/cli/index.md +35 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/cli/server.md +76 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/cli/setup.md +78 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/reference/index.md +25 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/resources/index.md +28 -0
- package/src/resources/submodules/appium/packages/appium/docs/zh/sponsors/index.md +61 -0
- package/src/resources/submodules/appium/packages/appium/types/manifest/README.md +30 -0
- package/src/resources/submodules/appium/packages/base-driver/CHANGELOG.md +1131 -0
- package/src/resources/submodules/appium/packages/base-driver/README.md +15 -0
- package/src/resources/submodules/appium/packages/base-driver/docs/mjsonwp/errors.md +82 -0
- package/src/resources/submodules/appium/packages/base-driver/docs/mjsonwp/protocol-methods.md +182 -0
- package/src/resources/submodules/appium/packages/base-driver/static/appium.png +0 -0
- package/src/resources/submodules/appium/packages/base-plugin/CHANGELOG.md +672 -0
- package/src/resources/submodules/appium/packages/base-plugin/README.md +15 -0
- package/src/resources/submodules/appium/packages/docutils/CHANGELOG.md +948 -0
- package/src/resources/submodules/appium/packages/docutils/README.md +27 -0
- package/src/resources/submodules/appium/packages/driver-test-support/CHANGELOG.md +717 -0
- package/src/resources/submodules/appium/packages/driver-test-support/README.md +112 -0
- package/src/resources/submodules/appium/packages/eslint-config-appium-ts/CHANGELOG.md +168 -0
- package/src/resources/submodules/appium/packages/eslint-config-appium-ts/README.md +33 -0
- package/src/resources/submodules/appium/packages/execute-driver-plugin/CHANGELOG.md +603 -0
- package/src/resources/submodules/appium/packages/execute-driver-plugin/README.md +42 -0
- package/src/resources/submodules/appium/packages/fake-driver/CHANGELOG.md +545 -0
- package/src/resources/submodules/appium/packages/fake-driver/README.md +7 -0
- package/src/resources/submodules/appium/packages/fake-driver/lib/screen.png +0 -0
- package/src/resources/submodules/appium/packages/fake-plugin/CHANGELOG.md +683 -0
- package/src/resources/submodules/appium/packages/fake-plugin/README.md +7 -0
- package/src/resources/submodules/appium/packages/images-plugin/CHANGELOG.md +602 -0
- package/src/resources/submodules/appium/packages/images-plugin/README.md +27 -0
- package/src/resources/submodules/appium/packages/images-plugin/docs/find-by-image.md +65 -0
- package/src/resources/submodules/appium/packages/images-plugin/docs/image-comparison.md +203 -0
- package/src/resources/submodules/appium/packages/images-plugin/test/fixtures/appstore.png +0 -0
- package/src/resources/submodules/appium/packages/images-plugin/test/fixtures/img1.png +0 -0
- package/src/resources/submodules/appium/packages/images-plugin/test/fixtures/img2.png +0 -0
- package/src/resources/submodules/appium/packages/images-plugin/test/fixtures/img2_part.png +0 -0
- package/src/resources/submodules/appium/packages/logger/CHANGELOG.md +162 -0
- package/src/resources/submodules/appium/packages/logger/README.md +31 -0
- package/src/resources/submodules/appium/packages/opencv/CHANGELOG.md +384 -0
- package/src/resources/submodules/appium/packages/opencv/README.md +68 -0
- package/src/resources/submodules/appium/packages/opencv/test/e2e/images/appium-diagram.jpg +0 -0
- package/src/resources/submodules/appium/packages/opencv/test/e2e/images/cc1.png +0 -0
- package/src/resources/submodules/appium/packages/opencv/test/e2e/images/cc2.png +0 -0
- package/src/resources/submodules/appium/packages/opencv/test/e2e/images/cc_rotated.png +0 -0
- package/src/resources/submodules/appium/packages/opencv/test/e2e/images/findwaldo.jpg +0 -0
- package/src/resources/submodules/appium/packages/opencv/test/e2e/images/number5.png +0 -0
- package/src/resources/submodules/appium/packages/opencv/test/e2e/images/waldo.jpg +0 -0
- package/src/resources/submodules/appium/packages/plugin-test-support/CHANGELOG.md +539 -0
- package/src/resources/submodules/appium/packages/plugin-test-support/README.md +49 -0
- package/src/resources/submodules/appium/packages/relaxed-caps-plugin/CHANGELOG.md +154 -0
- package/src/resources/submodules/appium/packages/relaxed-caps-plugin/README.md +35 -0
- package/src/resources/submodules/appium/packages/schema/CHANGELOG.md +271 -0
- package/src/resources/submodules/appium/packages/schema/README.md +50 -0
- package/src/resources/submodules/appium/packages/storage-plugin/CHANGELOG.md +73 -0
- package/src/resources/submodules/appium/packages/storage-plugin/README.md +83 -0
- package/src/resources/submodules/appium/packages/strongbox/CHANGELOG.md +94 -0
- package/src/resources/submodules/appium/packages/strongbox/README.md +96 -0
- package/src/resources/submodules/appium/packages/support/CHANGELOG.md +1054 -0
- package/src/resources/submodules/appium/packages/support/README.md +161 -0
- package/src/resources/submodules/appium/packages/test-support/CHANGELOG.md +712 -0
- package/src/resources/submodules/appium/packages/test-support/README.md +61 -0
- package/src/resources/submodules/appium/packages/tsconfig/CHANGELOG.md +131 -0
- package/src/resources/submodules/appium/packages/tsconfig/README.md +19 -0
- package/src/resources/submodules/appium/packages/types/CHANGELOG.md +793 -0
- package/src/resources/submodules/appium/packages/types/README.md +21 -0
- package/src/resources/submodules/appium/packages/universal-xml-plugin/CHANGELOG.md +435 -0
- package/src/resources/submodules/appium/packages/universal-xml-plugin/README.md +53 -0
- package/src/resources/submodules/appium/renovate/README.md +63 -0
- package/src/resources/submodules/appium-uiautomator2-driver/CHANGELOG.md +1204 -0
- package/src/resources/submodules/appium-uiautomator2-driver/README.md +2077 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/actions.md +72 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/activity-startup.md +47 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/android-appbundle.md +69 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/android-mobile-gestures.md +352 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/bidi.md +50 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/capability-sets.md +136 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/scheduled-actions.md +155 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/uiautomator-uiselector.md +51 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/unlock/main.md +95 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/unlock/screen1.png +0 -0
- package/src/resources/submodules/appium-uiautomator2-driver/docs/unlock/screen2.png +0 -0
- package/src/resources/submodules/appium-uiautomator2-driver/test/functional/assets/checkered-squares.png +0 -0
- package/src/resources/submodules/appium-uiautomator2-driver/test/functional/assets/start-button.png +0 -0
- package/src/resources/submodules/appium-uiautomator2-driver/test/functional/assets/stop-button.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/.github/ISSUE_TEMPLATE.md +4 -0
- package/src/resources/submodules/appium-xcuitest-driver/CHANGELOG.md +2594 -0
- package/src/resources/submodules/appium-xcuitest-driver/README.md +55 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/assets/images/appium-logo-white.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/assets/images/appium-logo.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/assets/images/appium-plus-xctest.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/contributing.md +45 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/endpoints-wda.md +61 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/endpoints.md +98 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/assets/images/ios-xctest-file-movement/keynote.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/assets/images/ios-xctest-file-movement/on_my_iphone.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/assets/images/ios-xctest-file-movement/top_files.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/attach-to-running-wda.md +43 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/audio-capture.md +78 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/capability-sets.md +169 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/ci-setup.md +47 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/clipboard.md +47 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/elements-lookup-troubleshooting.md +158 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/file-transfer.md +147 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/gestures.md +52 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/hybrid.md +137 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/input-events.md +67 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/install-certificate.md +19 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/multiple-xcode-versions.md +37 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/parallel-tests.md +39 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/run-prebuilt-wda.md +135 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/run-preinstalled-wda.md +178 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/touch-id.md +33 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/troubleshooting.md +191 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/tvos.md +114 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/wda-custom-server.md +283 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/guides/wda-slowness.md +231 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/index.md +36 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/installation/index.md +137 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/overview.md +19 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/assets/images/check-prov-prof.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/assets/images/create-new-project.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/assets/images/create-single-page.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/assets/images/no-prov-prof.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/assets/images/project-prov-prof.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/assets/images/set-up-bundle.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/assets/images/untrusted-dev.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/assets/images/xcode-bundle-id.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/assets/images/xcode-config.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/assets/images/xcode-facebook-fail.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/assets/images/xcode-facebook-succeed.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/index.md +51 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/prov-profile-basic-auto.md +49 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/prov-profile-basic-manual.md +40 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/prov-profile-full-manual.md +50 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/prov-profile-generic-manual.md +49 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/preparation/real-device-config.md +100 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/assets/images/useXctestrunFile.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/bidi.md +75 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/capabilities.md +165 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/commands.md +490 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/element-attributes.md +27 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/execute-methods.md +2206 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/ios-predicate.md +196 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/locator-strategies.md +19 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/scripts.md +29 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/security-flags.md +22 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/server-args.md +16 -0
- package/src/resources/submodules/appium-xcuitest-driver/docs/reference/settings.md +49 -0
- package/src/resources/submodules/appium-xcuitest-driver/test/assets/TestApp-iphonesimulator.app/Default-568h@2x.png +0 -0
- package/src/resources/submodules/appium-xcuitest-driver/test/assets/test.png +0 -0
- package/src/schema.ts +5 -0
- package/src/scripts/simple-index-documentation.ts +93 -0
- package/src/scripts/simple-query-documentation.ts +61 -0
- package/src/server.ts +40 -0
- package/src/tests/README.md +83 -0
- package/src/tests/__mocks__/@appium/support.ts +31 -0
- package/src/tests/generate-all-locators.test.ts +179 -0
- package/src/tests/test-setup-wda.ts +247 -0
- package/src/tools/README.md +171 -0
- package/src/tools/answer-appium.ts +75 -0
- package/src/tools/boot-simulator.ts +87 -0
- package/src/tools/create-session.ts +270 -0
- package/src/tools/delete-session.ts +46 -0
- package/src/tools/documentation/index.ts +97 -0
- package/src/tools/documentation/reasoning-rag.ts +434 -0
- package/src/tools/documentation/sentence-transformers-embeddings.ts +142 -0
- package/src/tools/documentation/simple-pdf-indexer.ts +509 -0
- package/src/tools/documentation/uploads/documents.json +1 -0
- package/src/tools/generate-tests.ts +50 -0
- package/src/tools/index.ts +135 -0
- package/src/tools/install-wda.ts +277 -0
- package/src/tools/interactions/activate-app.ts +46 -0
- package/src/tools/interactions/click.ts +47 -0
- package/src/tools/interactions/double-tap.ts +87 -0
- package/src/tools/interactions/find.ts +58 -0
- package/src/tools/interactions/get-page-source.ts +52 -0
- package/src/tools/interactions/get-text.ts +47 -0
- package/src/tools/interactions/install-app.ts +45 -0
- package/src/tools/interactions/list-apps.ts +65 -0
- package/src/tools/interactions/screenshot.ts +56 -0
- package/src/tools/interactions/set-value.ts +48 -0
- package/src/tools/interactions/terminate-app.ts +47 -0
- package/src/tools/interactions/uninstall-app.ts +47 -0
- package/src/tools/locators.ts +83 -0
- package/src/tools/scroll-to-element.ts +188 -0
- package/src/tools/scroll.ts +97 -0
- package/src/tools/select-device.ts +298 -0
- package/src/tools/select-platform.ts +243 -0
- package/src/tools/session-store.ts +72 -0
- package/src/tools/setup-wda.ts +218 -0
- package/src/types/appium-ios-device.d.ts +8 -0
- package/src/types/appium-xcuitest-driver.d.ts +5 -0
- package/tsconfig.json +23 -0
- package/index.js +0 -0
|
@@ -0,0 +1,1114 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: WebDriver Protocol
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
<style>
|
|
6
|
+
ul[data-md-component="toc"] .md-nav {
|
|
7
|
+
display: none;
|
|
8
|
+
}
|
|
9
|
+
</style>
|
|
10
|
+
|
|
11
|
+
The following is a list of [W3C WebDriver protocol](https://w3c.github.io/webdriver/) endpoints
|
|
12
|
+
supported in Appium.
|
|
13
|
+
|
|
14
|
+
!!! info
|
|
15
|
+
|
|
16
|
+
Most WebDriver endpoints are not implemented within Appium itself, and are instead proxied
|
|
17
|
+
directly to the driver, which is responsible for the actual endpoint implementation.
|
|
18
|
+
|
|
19
|
+
### createSession
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
POST /session
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
> WebDriver documentation: [New Session](https://w3c.github.io/webdriver/#new-session)
|
|
26
|
+
|
|
27
|
+
Creates a new WebDriver session.
|
|
28
|
+
|
|
29
|
+
Appium implements a modified version of this endpoint for historical reasons. While the W3C
|
|
30
|
+
endpoint only accepts 1 parameter, Appium's implementation allows up to 3 parameters, as this was
|
|
31
|
+
required by the legacy JSON Wire Protocol (JSONWP). Since Appium 2, the JSONWP format is no longer
|
|
32
|
+
supported, and any of the 3 parameters can be used to specify the W3C capabilities.
|
|
33
|
+
|
|
34
|
+
#### Parameters
|
|
35
|
+
|
|
36
|
+
| Name | Description | Type |
|
|
37
|
+
| ------------------- | ----------------------------------------------------------------------------- | --------------- |
|
|
38
|
+
| `w3cCapabilities1?` | Capabilities of the new session | `W3CDriverCaps` |
|
|
39
|
+
| `w3cCapabilities2?` | Another location for the new session capabilities (legacy) | `W3CDriverCaps` |
|
|
40
|
+
| `w3cCapabilities?` | Another location for the new session capabilities (legacy) | `W3CDriverCaps` |
|
|
41
|
+
|
|
42
|
+
#### Response
|
|
43
|
+
|
|
44
|
+
`CreateResult` - an object with the following properties:
|
|
45
|
+
|
|
46
|
+
| Name | Description | Type |
|
|
47
|
+
| -------------- | ------------------------------------ | ------ |
|
|
48
|
+
| `sessionId` | ID of the new session | string |
|
|
49
|
+
| `capabilities` | Capabilities processed by the driver | object |
|
|
50
|
+
|
|
51
|
+
### deleteSession
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
DELETE /session/:sessionId
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
> WebDriver documentation: [Delete Session](https://w3c.github.io/webdriver/#delete-session)
|
|
58
|
+
|
|
59
|
+
Closes the current session.
|
|
60
|
+
|
|
61
|
+
#### Response
|
|
62
|
+
|
|
63
|
+
`null`
|
|
64
|
+
|
|
65
|
+
### getStatus
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
GET /status
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
> WebDriver documentation: [Status](https://w3c.github.io/webdriver/#status)
|
|
72
|
+
|
|
73
|
+
Retrieves the current status of the Appium server.
|
|
74
|
+
|
|
75
|
+
#### Response
|
|
76
|
+
|
|
77
|
+
`GetStatusResult` - an object with the following properties:
|
|
78
|
+
|
|
79
|
+
| Name | Description | Type |
|
|
80
|
+
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
|
|
81
|
+
| `build` | Implementation-specific information. For Appium, this is an object containing the `version` key, whose value matches the Appium server version. | `{version}` |
|
|
82
|
+
| `message` | Explanation of the `ready` value | string |
|
|
83
|
+
| `ready` | Whether the server is able to create new sessions | boolean |
|
|
84
|
+
|
|
85
|
+
### getTimeouts
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
GET /session/:sessionId/timeouts
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
> WebDriver documentation: [Get Timeouts](https://w3c.github.io/webdriver/#get-timeouts)
|
|
92
|
+
|
|
93
|
+
Retrieves the timeout values of the current session.
|
|
94
|
+
|
|
95
|
+
#### Response
|
|
96
|
+
|
|
97
|
+
`GetTimeoutsResult` - an object with the following properties:
|
|
98
|
+
|
|
99
|
+
| Name | Description | Type |
|
|
100
|
+
| ---------- | --------------------- | ------ |
|
|
101
|
+
| `command` | Command timeout | number |
|
|
102
|
+
| `implicit` | Implicit wait timeout | number |
|
|
103
|
+
|
|
104
|
+
### timeouts
|
|
105
|
+
|
|
106
|
+
```
|
|
107
|
+
POST /session/:sessionId/timeouts
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
> WebDriver documentation: [Set Timeouts](https://w3c.github.io/webdriver/#set-timeouts)
|
|
111
|
+
|
|
112
|
+
Sets the timeout values of the current session.
|
|
113
|
+
|
|
114
|
+
#### Parameters
|
|
115
|
+
|
|
116
|
+
| Name | Description | Type |
|
|
117
|
+
| ----------- | ---------------------------------------------------------- | ------ |
|
|
118
|
+
| `implicit?` | Implicit wait timeout (in milliseconds) | number |
|
|
119
|
+
| `pageLoad?` | Page load timeout (in milliseconds) | number |
|
|
120
|
+
| `script?` | Script timeout (in milliseconds) | number |
|
|
121
|
+
|
|
122
|
+
#### Response
|
|
123
|
+
|
|
124
|
+
`null`
|
|
125
|
+
|
|
126
|
+
### setUrl
|
|
127
|
+
|
|
128
|
+
```
|
|
129
|
+
POST /session/:sessionId/url
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
> WebDriver documentation: [Navigate To](https://w3c.github.io/webdriver/#navigate-to)
|
|
133
|
+
|
|
134
|
+
Navigates the current top-level browsing context to the specified URL.
|
|
135
|
+
|
|
136
|
+
#### Parameters
|
|
137
|
+
|
|
138
|
+
| Name | Description | Type |
|
|
139
|
+
| ----- | ------------------ | ------ |
|
|
140
|
+
| `url` | URL to navigate to | string |
|
|
141
|
+
|
|
142
|
+
#### Response
|
|
143
|
+
|
|
144
|
+
`null`
|
|
145
|
+
|
|
146
|
+
### getUrl
|
|
147
|
+
|
|
148
|
+
```
|
|
149
|
+
GET /session/:sessionId/url
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
> WebDriver documentation: [Get Current URL](https://w3c.github.io/webdriver/#get-current-url)
|
|
153
|
+
|
|
154
|
+
Retrieves the URL of the current top-level browsing context.
|
|
155
|
+
|
|
156
|
+
#### Response
|
|
157
|
+
|
|
158
|
+
`string` - the current URL
|
|
159
|
+
|
|
160
|
+
### back
|
|
161
|
+
|
|
162
|
+
```
|
|
163
|
+
POST /session/:sessionId/back
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
> WebDriver documentation: [Back](https://w3c.github.io/webdriver/#back)
|
|
167
|
+
|
|
168
|
+
Navigates backwards in the browser history, if possible.
|
|
169
|
+
|
|
170
|
+
#### Response
|
|
171
|
+
|
|
172
|
+
`null`
|
|
173
|
+
|
|
174
|
+
### forward
|
|
175
|
+
|
|
176
|
+
```
|
|
177
|
+
POST /session/:sessionId/forward
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
> WebDriver documentation: [Forward](https://w3c.github.io/webdriver/#forward)
|
|
181
|
+
|
|
182
|
+
Navigates forwards in the browser history, if possible.
|
|
183
|
+
|
|
184
|
+
#### Response
|
|
185
|
+
|
|
186
|
+
`null`
|
|
187
|
+
|
|
188
|
+
### refresh
|
|
189
|
+
|
|
190
|
+
```
|
|
191
|
+
POST /session/:sessionId/refresh
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
> WebDriver documentation: [Refresh](https://w3c.github.io/webdriver/#refresh)
|
|
195
|
+
|
|
196
|
+
Reloads the window of the current top-level browsing context.
|
|
197
|
+
|
|
198
|
+
#### Response
|
|
199
|
+
|
|
200
|
+
`null`
|
|
201
|
+
|
|
202
|
+
### title
|
|
203
|
+
|
|
204
|
+
```
|
|
205
|
+
GET /session/:sessionId/title
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
> WebDriver documentation: [Get Title](https://w3c.github.io/webdriver/#get-title)
|
|
209
|
+
|
|
210
|
+
Retrieves the window title of the top-level browsing context.
|
|
211
|
+
|
|
212
|
+
#### Response
|
|
213
|
+
|
|
214
|
+
`string` - the page title
|
|
215
|
+
|
|
216
|
+
### getWindowHandle
|
|
217
|
+
|
|
218
|
+
```
|
|
219
|
+
GET /session/:sessionId/window
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
> WebDriver documentation: [Get Window Handle](https://w3c.github.io/webdriver/#get-window-handle)
|
|
223
|
+
|
|
224
|
+
Retrieves the window handle of the top-level browsing context.
|
|
225
|
+
|
|
226
|
+
#### Response
|
|
227
|
+
|
|
228
|
+
`string` - the window handle identifier
|
|
229
|
+
|
|
230
|
+
### closeWindow
|
|
231
|
+
|
|
232
|
+
```
|
|
233
|
+
DELETE /session/:sessionId/window
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
> WebDriver documentation: [Close Window](https://w3c.github.io/webdriver/#close-window)
|
|
237
|
+
|
|
238
|
+
Closes the current top-level browsing context.
|
|
239
|
+
|
|
240
|
+
#### Response
|
|
241
|
+
|
|
242
|
+
`string[]` - an array of zero or more remaining window handle identifiers
|
|
243
|
+
|
|
244
|
+
### setWindow
|
|
245
|
+
|
|
246
|
+
```
|
|
247
|
+
POST /session/:sessionId/window
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
> WebDriver documentation: [Switch To Window](https://w3c.github.io/webdriver/#switch-to-window)
|
|
251
|
+
|
|
252
|
+
Selects the top-level browsing context.
|
|
253
|
+
|
|
254
|
+
#### Parameters
|
|
255
|
+
|
|
256
|
+
| Name | Description | Type |
|
|
257
|
+
| -------- | -------------------------------------- | ------ |
|
|
258
|
+
| `handle` | Identifier for the window to switch to | string |
|
|
259
|
+
|
|
260
|
+
#### Response
|
|
261
|
+
|
|
262
|
+
`null`
|
|
263
|
+
|
|
264
|
+
### getWindowHandles
|
|
265
|
+
|
|
266
|
+
```
|
|
267
|
+
GET /session/:sessionId/window/handles
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
> WebDriver documentation: [Get Window Handles](https://w3c.github.io/webdriver/#get-window-handles)
|
|
271
|
+
|
|
272
|
+
Retrieves a list of window handles for every top-level browsing context.
|
|
273
|
+
|
|
274
|
+
#### Response
|
|
275
|
+
|
|
276
|
+
`string[]` - an array of zero or more window handle identifiers
|
|
277
|
+
|
|
278
|
+
### createNewWindow
|
|
279
|
+
|
|
280
|
+
```
|
|
281
|
+
POST /session/:sessionId/window/new
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
> WebDriver documentation: [New Window](https://w3c.github.io/webdriver/#new-window)
|
|
285
|
+
|
|
286
|
+
Creates a new window or tab.
|
|
287
|
+
|
|
288
|
+
#### Parameters
|
|
289
|
+
|
|
290
|
+
| Name | Description | Type |
|
|
291
|
+
| ------ | --------------------------------------------------------------- | ------ |
|
|
292
|
+
| `type` | Type of window to create (`window` or `tab`) | string |
|
|
293
|
+
|
|
294
|
+
#### Response
|
|
295
|
+
|
|
296
|
+
`NewWindow` - an object with the following properties:
|
|
297
|
+
|
|
298
|
+
| Name | Description | Type |
|
|
299
|
+
| -------- | ----------------------------------------------------------------- | ------ |
|
|
300
|
+
| `handle` | ID of the created window handle | string |
|
|
301
|
+
| `type` | Type of the created window (`window` or `tab`) | string |
|
|
302
|
+
|
|
303
|
+
### setFrame
|
|
304
|
+
|
|
305
|
+
```
|
|
306
|
+
POST /session/:sessionId/frame
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
> WebDriver documentation: [Switch To Frame](https://w3c.github.io/webdriver/#switch-to-frame)
|
|
310
|
+
|
|
311
|
+
Selects the top-level or child browsing context as the current browsing context.
|
|
312
|
+
|
|
313
|
+
#### Parameters
|
|
314
|
+
|
|
315
|
+
| Name | Description | Type |
|
|
316
|
+
| ---- | ------------------------ | ------------------------------------------ |
|
|
317
|
+
| `id` | Identifier for the frame | null, number, or [`Element`](#response_23) |
|
|
318
|
+
|
|
319
|
+
#### Response
|
|
320
|
+
|
|
321
|
+
`null`
|
|
322
|
+
|
|
323
|
+
### switchToParentFrame
|
|
324
|
+
|
|
325
|
+
```
|
|
326
|
+
POST /session/:sessionId/frame/parent
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
> WebDriver documentation: [Switch To Parent Frame](https://w3c.github.io/webdriver/#switch-to-parent-frame)
|
|
330
|
+
|
|
331
|
+
Sets the current browsing context to the parent of the current browsing context.
|
|
332
|
+
|
|
333
|
+
#### Response
|
|
334
|
+
|
|
335
|
+
`null`
|
|
336
|
+
|
|
337
|
+
### getWindowRect
|
|
338
|
+
|
|
339
|
+
```
|
|
340
|
+
GET /session/:sessionId/window/rect
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
> WebDriver documentation: [Get Window Rect](https://w3c.github.io/webdriver/#get-window-rect)
|
|
344
|
+
|
|
345
|
+
Retrieves the size and position of the current window.
|
|
346
|
+
|
|
347
|
+
#### Response
|
|
348
|
+
|
|
349
|
+
`Rect` - an object with the following properties:
|
|
350
|
+
|
|
351
|
+
| Name | Description | Type |
|
|
352
|
+
| -------- | ---------------------------------------------------- | ------ |
|
|
353
|
+
| `height` | Window height | number |
|
|
354
|
+
| `width` | Window width | number |
|
|
355
|
+
| `x` | X-axis position of the top-left corner of the window | number |
|
|
356
|
+
| `y` | Y-axis position of the top-left corner of the window | number |
|
|
357
|
+
|
|
358
|
+
### setWindowRect
|
|
359
|
+
|
|
360
|
+
```
|
|
361
|
+
POST /session/:sessionId/window/rect
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
> WebDriver documentation: [Set Window Rect](https://w3c.github.io/webdriver/#set-window-rect)
|
|
365
|
+
|
|
366
|
+
Sets the size and/or position of the current window.
|
|
367
|
+
|
|
368
|
+
#### Parameters
|
|
369
|
+
|
|
370
|
+
| Name | Description | Type |
|
|
371
|
+
| --------- | ---------------------------------------------------- | ------ |
|
|
372
|
+
| `height?` | Window height | number |
|
|
373
|
+
| `width?` | Window width | number |
|
|
374
|
+
| `x?` | X-axis position of the top-left corner of the window | number |
|
|
375
|
+
| `y?` | Y-axis position of the top-left corner of the window | number |
|
|
376
|
+
|
|
377
|
+
#### Response
|
|
378
|
+
|
|
379
|
+
[`Rect`](#response_18) - the new window size
|
|
380
|
+
|
|
381
|
+
### maximizeWindow
|
|
382
|
+
|
|
383
|
+
```
|
|
384
|
+
POST /session/:sessionId/window/maximize
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
> WebDriver documentation: [Maximize Window](https://w3c.github.io/webdriver/#maximize-window)
|
|
388
|
+
|
|
389
|
+
Maximizes the current window.
|
|
390
|
+
|
|
391
|
+
#### Response
|
|
392
|
+
|
|
393
|
+
[`Rect`](#response_18) - the new window size
|
|
394
|
+
|
|
395
|
+
### minimizeWindow
|
|
396
|
+
|
|
397
|
+
```
|
|
398
|
+
POST /session/:sessionId/window/minimize
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
> WebDriver documentation: [Minimize Window](https://w3c.github.io/webdriver/#minimize-window)
|
|
402
|
+
|
|
403
|
+
Minimizes the current window.
|
|
404
|
+
|
|
405
|
+
#### Response
|
|
406
|
+
|
|
407
|
+
[`Rect`](#response_18) - the new window size
|
|
408
|
+
|
|
409
|
+
### fullScreenWindow
|
|
410
|
+
|
|
411
|
+
```
|
|
412
|
+
POST /session/:sessionId/window/fullscreen
|
|
413
|
+
```
|
|
414
|
+
|
|
415
|
+
> WebDriver documentation: [Fullscreen Window](https://w3c.github.io/webdriver/#fullscreen-window)
|
|
416
|
+
|
|
417
|
+
Makes the current window fullscreen.
|
|
418
|
+
|
|
419
|
+
#### Response
|
|
420
|
+
|
|
421
|
+
[`Rect`](#response_18) - the new window size
|
|
422
|
+
|
|
423
|
+
### active
|
|
424
|
+
|
|
425
|
+
```
|
|
426
|
+
GET /session/:sessionId/element/active
|
|
427
|
+
```
|
|
428
|
+
|
|
429
|
+
> WebDriver documentation: [Get Active Element](https://w3c.github.io/webdriver/#get-active-element)
|
|
430
|
+
|
|
431
|
+
Retrieves the currently focused element.
|
|
432
|
+
|
|
433
|
+
#### Response
|
|
434
|
+
|
|
435
|
+
`Element` - an object with the following properties:
|
|
436
|
+
|
|
437
|
+
| Name | Description | Type |
|
|
438
|
+
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ |
|
|
439
|
+
| `element-6066-11e4-a52e-4f735466cecf` | Element ID | string |
|
|
440
|
+
| `ELEMENT` | Element ID (same value as `element-6066-11e4-a52e-4f735466cecf`). This key was used in the legacy Mobile JSON Wire Protocol (MJSONWP). | string |
|
|
441
|
+
|
|
442
|
+
### elementShadowRoot
|
|
443
|
+
|
|
444
|
+
```
|
|
445
|
+
GET /session/:sessionId/element/:elementId/shadow
|
|
446
|
+
```
|
|
447
|
+
|
|
448
|
+
> WebDriver documentation: [Get Shadow Root](https://w3c.github.io/webdriver/#get-shadow-root)
|
|
449
|
+
|
|
450
|
+
Retrieves the shadow root of the element identified by `:elementId`.
|
|
451
|
+
|
|
452
|
+
#### Response
|
|
453
|
+
|
|
454
|
+
`ShadowElement` - an object with the following properties:
|
|
455
|
+
|
|
456
|
+
| Name | Description | Type |
|
|
457
|
+
| ------------------------------------ | -------------- | ------ |
|
|
458
|
+
| `shadow-6066-11e4-a52e-4f735466cecf` | Shadow root ID | string |
|
|
459
|
+
|
|
460
|
+
### findElement
|
|
461
|
+
|
|
462
|
+
```
|
|
463
|
+
POST /session/:sessionId/element
|
|
464
|
+
```
|
|
465
|
+
|
|
466
|
+
> WebDriver documentation: [Find Element](https://w3c.github.io/webdriver/#find-element)
|
|
467
|
+
|
|
468
|
+
Finds the first element in the current browsing context that matches the provided selector and
|
|
469
|
+
location strategy, starting from the root node.
|
|
470
|
+
|
|
471
|
+
#### Parameters
|
|
472
|
+
|
|
473
|
+
| Name | Description | Type |
|
|
474
|
+
| ------- | --------------------------------------- | ------ |
|
|
475
|
+
| `using` | Location strategy to use when searching | string |
|
|
476
|
+
| `value` | Selector used to find the element | string |
|
|
477
|
+
|
|
478
|
+
#### Response
|
|
479
|
+
|
|
480
|
+
[`Element`](#response_23)
|
|
481
|
+
|
|
482
|
+
### findElements
|
|
483
|
+
|
|
484
|
+
```
|
|
485
|
+
POST /session/:sessionId/elements
|
|
486
|
+
```
|
|
487
|
+
|
|
488
|
+
> WebDriver documentation: [Find Elements](https://w3c.github.io/webdriver/#find-elements)
|
|
489
|
+
|
|
490
|
+
Finds all elements in the current browsing context that match the provided selector and location
|
|
491
|
+
strategy, starting from the root node.
|
|
492
|
+
|
|
493
|
+
#### Parameters
|
|
494
|
+
|
|
495
|
+
| Name | Description | Type |
|
|
496
|
+
| ------- | --------------------------------------- | ------ |
|
|
497
|
+
| `using` | Location strategy to use when searching | string |
|
|
498
|
+
| `value` | Selector used to find the element | string |
|
|
499
|
+
|
|
500
|
+
#### Response
|
|
501
|
+
|
|
502
|
+
`Element[]` - an array containing zero or more [`Element` objects](#response_23)
|
|
503
|
+
|
|
504
|
+
### findElementFromElement
|
|
505
|
+
|
|
506
|
+
```
|
|
507
|
+
POST /session/:sessionId/element/:elementId/element
|
|
508
|
+
```
|
|
509
|
+
|
|
510
|
+
> WebDriver documentation: [Find Element From Element](https://w3c.github.io/webdriver/#find-element-from-element)
|
|
511
|
+
|
|
512
|
+
Finds the first element in the current browsing context that matches the provided selector and
|
|
513
|
+
location strategy, starting from the element node identified by `:elementId`.
|
|
514
|
+
|
|
515
|
+
#### Parameters
|
|
516
|
+
|
|
517
|
+
| Name | Description | Type |
|
|
518
|
+
| ------- | --------------------------------------- | ------ |
|
|
519
|
+
| `using` | Location strategy to use when searching | string |
|
|
520
|
+
| `value` | Selector used to find the element | string |
|
|
521
|
+
|
|
522
|
+
#### Response
|
|
523
|
+
|
|
524
|
+
[`Element`](#response_23)
|
|
525
|
+
|
|
526
|
+
### findElementsFromElement
|
|
527
|
+
|
|
528
|
+
```
|
|
529
|
+
POST /session/:sessionId/element/:elementId/elements
|
|
530
|
+
```
|
|
531
|
+
|
|
532
|
+
> WebDriver documentation: [Find Elements From Element](https://w3c.github.io/webdriver/#find-elements-from-element)
|
|
533
|
+
|
|
534
|
+
Finds all elements in the current browsing context that match the provided selector and location
|
|
535
|
+
strategy, starting from the element node identified by `:elementId`.
|
|
536
|
+
|
|
537
|
+
#### Parameters
|
|
538
|
+
|
|
539
|
+
| Name | Description | Type |
|
|
540
|
+
| ------- | --------------------------------------- | ------ |
|
|
541
|
+
| `using` | Location strategy to use when searching | string |
|
|
542
|
+
| `value` | Selector used to find the element | string |
|
|
543
|
+
|
|
544
|
+
#### Response
|
|
545
|
+
|
|
546
|
+
[`Element[]`](#response_26)
|
|
547
|
+
|
|
548
|
+
### findElementFromShadowRoot
|
|
549
|
+
|
|
550
|
+
```
|
|
551
|
+
POST /session/:sessionId/shadow/:shadowId/element
|
|
552
|
+
```
|
|
553
|
+
|
|
554
|
+
> WebDriver documentation: [Find Element From Shadow Root](https://w3c.github.io/webdriver/#find-element-from-shadow-root)
|
|
555
|
+
|
|
556
|
+
Finds the first element in the current browsing context that matches the provided selector and
|
|
557
|
+
location strategy, starting from the shadow root node identified by `:shadowId`.
|
|
558
|
+
|
|
559
|
+
#### Parameters
|
|
560
|
+
|
|
561
|
+
| Name | Description | Type |
|
|
562
|
+
| ------- | --------------------------------------- | ------ |
|
|
563
|
+
| `using` | Location strategy to use when searching | string |
|
|
564
|
+
| `value` | Selector used to find the element | string |
|
|
565
|
+
|
|
566
|
+
#### Response
|
|
567
|
+
|
|
568
|
+
[`Element`](#response_23)
|
|
569
|
+
|
|
570
|
+
### findElementsFromShadowRoot
|
|
571
|
+
|
|
572
|
+
```
|
|
573
|
+
POST /session/:sessionId/shadow/:shadowId/elements
|
|
574
|
+
```
|
|
575
|
+
|
|
576
|
+
> WebDriver documentation: [Find Elements From Shadow Root](https://w3c.github.io/webdriver/#find-elements-from-shadow-root)
|
|
577
|
+
|
|
578
|
+
Finds all elements in the current browsing context that match the provided selector and location
|
|
579
|
+
strategy, starting from the shadow root node identified by `:shadowId`.
|
|
580
|
+
|
|
581
|
+
#### Parameters
|
|
582
|
+
|
|
583
|
+
| Name | Description | Type |
|
|
584
|
+
| ------- | --------------------------------------- | ------ |
|
|
585
|
+
| `using` | Location strategy to use when searching | string |
|
|
586
|
+
| `value` | Selector used to find the element | string |
|
|
587
|
+
|
|
588
|
+
#### Response
|
|
589
|
+
|
|
590
|
+
[`Element[]`](#response_26)
|
|
591
|
+
|
|
592
|
+
### elementSelected
|
|
593
|
+
|
|
594
|
+
```
|
|
595
|
+
GET /session/:sessionId/element/:elementId/selected
|
|
596
|
+
```
|
|
597
|
+
|
|
598
|
+
> WebDriver documentation: [Is Element Selected](https://w3c.github.io/webdriver/#is-element-selected)
|
|
599
|
+
|
|
600
|
+
Determines if the element identified by `:elementId` is currently selected. This property is only
|
|
601
|
+
relevant to certain element types, such as checkboxes, radio buttons, or options.
|
|
602
|
+
|
|
603
|
+
#### Response
|
|
604
|
+
|
|
605
|
+
`boolean` - `true` if the element is selected, otherwise `false`
|
|
606
|
+
|
|
607
|
+
### elementDisplayed
|
|
608
|
+
|
|
609
|
+
```
|
|
610
|
+
GET /session/:sessionId/element/:elementId/displayed
|
|
611
|
+
```
|
|
612
|
+
|
|
613
|
+
> WebDriver documentation: [Element Displayedness](https://w3c.github.io/webdriver/#element-displayedness)
|
|
614
|
+
|
|
615
|
+
Determines if the element identified by `:elementId` is currently displayed.
|
|
616
|
+
|
|
617
|
+
#### Response
|
|
618
|
+
|
|
619
|
+
`boolean` - `true` if the element is displayed, otherwise `false`
|
|
620
|
+
|
|
621
|
+
### getAttribute
|
|
622
|
+
|
|
623
|
+
```
|
|
624
|
+
GET /session/:sessionId/element/:elementId/attribute/:name
|
|
625
|
+
```
|
|
626
|
+
|
|
627
|
+
> WebDriver documentation: [Get Element Attribute](https://w3c.github.io/webdriver/#get-element-attribute)
|
|
628
|
+
|
|
629
|
+
Retrieves the value of the `:name` attribute for the element identified by `:elementId`.
|
|
630
|
+
|
|
631
|
+
#### Response
|
|
632
|
+
|
|
633
|
+
`string` - the attribute value, or `null` if the attribute does not exist
|
|
634
|
+
|
|
635
|
+
### getProperty
|
|
636
|
+
|
|
637
|
+
```
|
|
638
|
+
GET /session/:sessionId/element/:elementId/property/:name
|
|
639
|
+
```
|
|
640
|
+
|
|
641
|
+
> WebDriver documentation: [Get Element Property](https://w3c.github.io/webdriver/#get-element-property)
|
|
642
|
+
|
|
643
|
+
Retrieves the value of the `:name` property for the element identified by `:elementId`.
|
|
644
|
+
|
|
645
|
+
#### Response
|
|
646
|
+
|
|
647
|
+
`string` - the property value, or `null` if the property does not exist
|
|
648
|
+
|
|
649
|
+
### getCssProperty
|
|
650
|
+
|
|
651
|
+
```
|
|
652
|
+
GET /session/:sessionId/element/:elementId/css/:propertyName
|
|
653
|
+
```
|
|
654
|
+
|
|
655
|
+
> WebDriver documentation: [Get Element CSS Value](https://w3c.github.io/webdriver/#get-element-css-value)
|
|
656
|
+
|
|
657
|
+
Retrieves the value of the `:propertyName` computed CSS property for the element identified by
|
|
658
|
+
`:elementId`.
|
|
659
|
+
|
|
660
|
+
#### Response
|
|
661
|
+
|
|
662
|
+
`string` - the CSS property value, or `null` if the property does not exist
|
|
663
|
+
|
|
664
|
+
### getText
|
|
665
|
+
|
|
666
|
+
```
|
|
667
|
+
GET /session/:sessionId/element/:elementId/text
|
|
668
|
+
```
|
|
669
|
+
|
|
670
|
+
> WebDriver documentation: [Get Element Text](https://w3c.github.io/webdriver/#get-element-text)
|
|
671
|
+
|
|
672
|
+
Retrieves the text of the element identified by `:elementId`, as well as the text of its child
|
|
673
|
+
elements (if any).
|
|
674
|
+
|
|
675
|
+
#### Response
|
|
676
|
+
|
|
677
|
+
`string` - the element text (including its child elements)
|
|
678
|
+
|
|
679
|
+
### getName
|
|
680
|
+
|
|
681
|
+
```
|
|
682
|
+
GET /session/:sessionId/element/:elementId/name
|
|
683
|
+
```
|
|
684
|
+
|
|
685
|
+
> WebDriver documentation: [Get Element Tag Name](https://w3c.github.io/webdriver/#get-element-tag-name)
|
|
686
|
+
|
|
687
|
+
Retrieves the tag name of the element identified by `:elementId`.
|
|
688
|
+
|
|
689
|
+
#### Response
|
|
690
|
+
|
|
691
|
+
`string` - the element tag name
|
|
692
|
+
|
|
693
|
+
### getElementRect
|
|
694
|
+
|
|
695
|
+
```
|
|
696
|
+
GET /session/:sessionId/element/:elementId/rect
|
|
697
|
+
```
|
|
698
|
+
|
|
699
|
+
> WebDriver documentation: [Get Element Rect](https://w3c.github.io/webdriver/#get-element-rect)
|
|
700
|
+
|
|
701
|
+
Retrieves the dimensions and coordinates of the element identified by `:elementId`.
|
|
702
|
+
|
|
703
|
+
#### Response
|
|
704
|
+
|
|
705
|
+
[`Rect`](#response_18)
|
|
706
|
+
|
|
707
|
+
### elementEnabled
|
|
708
|
+
|
|
709
|
+
```
|
|
710
|
+
GET /session/:sessionId/element/:elementId/enabled
|
|
711
|
+
```
|
|
712
|
+
|
|
713
|
+
> WebDriver documentation: [Is Element Enabled](https://w3c.github.io/webdriver/#is-element-enabled)
|
|
714
|
+
|
|
715
|
+
Determines if the element identified by `:elementId` is currently enabled. This property is only
|
|
716
|
+
relevant to certain element types, such as buttons, input fields, checkboxes, etc.
|
|
717
|
+
|
|
718
|
+
#### Response
|
|
719
|
+
|
|
720
|
+
`boolean` - `true` if the element is enabled, otherwise `false`
|
|
721
|
+
|
|
722
|
+
### getComputedRole
|
|
723
|
+
|
|
724
|
+
```
|
|
725
|
+
GET /session/:sessionId/element/:elementId/computedrole
|
|
726
|
+
```
|
|
727
|
+
|
|
728
|
+
> WebDriver documentation: [Get Computed Role](https://w3c.github.io/webdriver/#get-computed-role)
|
|
729
|
+
|
|
730
|
+
Retrieves the computed [WAI-ARIA](https://w3c.github.io/aria/#introroles) role of the element
|
|
731
|
+
identified by `:elementId`.
|
|
732
|
+
|
|
733
|
+
#### Response
|
|
734
|
+
|
|
735
|
+
`string` - the element computed role
|
|
736
|
+
|
|
737
|
+
### getComputedLabel
|
|
738
|
+
|
|
739
|
+
```
|
|
740
|
+
GET /session/:sessionId/element/:elementId/computedlabel
|
|
741
|
+
```
|
|
742
|
+
|
|
743
|
+
> WebDriver documentation: [Get Computed Label](https://w3c.github.io/webdriver/#get-computed-label)
|
|
744
|
+
|
|
745
|
+
Retrieves the [accessible name](https://w3c.github.io/accname/#dfn-accessible-name) of the
|
|
746
|
+
element identified by `:elementId`.
|
|
747
|
+
|
|
748
|
+
#### Response
|
|
749
|
+
|
|
750
|
+
`string` - the element accessible name
|
|
751
|
+
|
|
752
|
+
### click
|
|
753
|
+
|
|
754
|
+
```
|
|
755
|
+
POST /session/:sessionId/element/:elementId/click
|
|
756
|
+
```
|
|
757
|
+
|
|
758
|
+
> WebDriver documentation: [Element Click](https://w3c.github.io/webdriver/#element-click)
|
|
759
|
+
|
|
760
|
+
Clicks on the identified by `:elementId`.
|
|
761
|
+
|
|
762
|
+
#### Response
|
|
763
|
+
|
|
764
|
+
`null`
|
|
765
|
+
|
|
766
|
+
### clear
|
|
767
|
+
|
|
768
|
+
```
|
|
769
|
+
POST /session/:sessionId/element/:elementId/clear
|
|
770
|
+
```
|
|
771
|
+
|
|
772
|
+
> WebDriver documentation: [Element Clear](https://w3c.github.io/webdriver/#element-clear)
|
|
773
|
+
|
|
774
|
+
Clears the identified by `:elementId`. This functionality is only relevant to certain element types,
|
|
775
|
+
such as input fields.
|
|
776
|
+
|
|
777
|
+
#### Response
|
|
778
|
+
|
|
779
|
+
`null`
|
|
780
|
+
|
|
781
|
+
### setValue
|
|
782
|
+
|
|
783
|
+
```
|
|
784
|
+
POST /session/:sessionId/element/:elementId/value
|
|
785
|
+
```
|
|
786
|
+
|
|
787
|
+
> WebDriver documentation: [Element Send Keys](https://w3c.github.io/webdriver/#element-send-keys)
|
|
788
|
+
|
|
789
|
+
Sends keys to the element the identified by `:elementId`. This functionality is only relevant to
|
|
790
|
+
keyboard-interactable element types, such as input fields.
|
|
791
|
+
|
|
792
|
+
#### Parameters
|
|
793
|
+
|
|
794
|
+
| Name | Description | Type |
|
|
795
|
+
| ------ | ------------ | ------ |
|
|
796
|
+
| `text` | Text to send | string |
|
|
797
|
+
|
|
798
|
+
#### Response
|
|
799
|
+
|
|
800
|
+
`null`
|
|
801
|
+
|
|
802
|
+
### getPageSource
|
|
803
|
+
|
|
804
|
+
```
|
|
805
|
+
GET /session/:sessionId/source
|
|
806
|
+
```
|
|
807
|
+
|
|
808
|
+
> WebDriver documentation: [Get Page Source](https://w3c.github.io/webdriver/#get-page-source)
|
|
809
|
+
|
|
810
|
+
Retrieves the page/application source of the current browsing context in HTML/XML format.
|
|
811
|
+
|
|
812
|
+
#### Response
|
|
813
|
+
|
|
814
|
+
`string` - the DOM of the current browsing context
|
|
815
|
+
|
|
816
|
+
### execute
|
|
817
|
+
|
|
818
|
+
```
|
|
819
|
+
POST /session/:sessionId/execute/sync
|
|
820
|
+
```
|
|
821
|
+
|
|
822
|
+
> WebDriver documentation: [Execute Script](https://w3c.github.io/webdriver/#execute-script)
|
|
823
|
+
|
|
824
|
+
Executes synchronous JavaScript code in the current browsing context.
|
|
825
|
+
|
|
826
|
+
#### Parameters
|
|
827
|
+
|
|
828
|
+
| Name | Description | Type |
|
|
829
|
+
| -------- | ------------------------------ | ------ |
|
|
830
|
+
| `script` | Script function to execute | string |
|
|
831
|
+
| `args` | Arguments passed to the script | array |
|
|
832
|
+
|
|
833
|
+
#### Response
|
|
834
|
+
|
|
835
|
+
`any` - the result of the script execution
|
|
836
|
+
|
|
837
|
+
### executeAsync
|
|
838
|
+
|
|
839
|
+
```
|
|
840
|
+
POST /session/:sessionId/execute/async
|
|
841
|
+
```
|
|
842
|
+
|
|
843
|
+
> WebDriver documentation: [Execute Async Script](https://w3c.github.io/webdriver/#execute-async-script)
|
|
844
|
+
|
|
845
|
+
Executes asynchronous JavaScript code in the current browsing context.
|
|
846
|
+
|
|
847
|
+
The `script` function is provided an additional argument (applied after `args`), which is a
|
|
848
|
+
function that can be invoked (within `script`) to trigger script completion. The first argument
|
|
849
|
+
passed to this completion function is returned as the endpoint response.
|
|
850
|
+
|
|
851
|
+
#### Parameters
|
|
852
|
+
|
|
853
|
+
| Name | Description | Type |
|
|
854
|
+
| -------- | -------------------------- | ------ |
|
|
855
|
+
| `script` | Script function to execute | string |
|
|
856
|
+
| `args` | Arguments for the script | array |
|
|
857
|
+
|
|
858
|
+
#### Response
|
|
859
|
+
|
|
860
|
+
`any` - the result returned by the completion function of the script
|
|
861
|
+
|
|
862
|
+
### getCookies
|
|
863
|
+
|
|
864
|
+
```
|
|
865
|
+
GET /session/:sessionId/cookie
|
|
866
|
+
```
|
|
867
|
+
|
|
868
|
+
> WebDriver documentation: [Get Cookies](https://w3c.github.io/webdriver/#get-cookies)
|
|
869
|
+
|
|
870
|
+
Retrieves all cookies of the current browsing context.
|
|
871
|
+
|
|
872
|
+
#### Response
|
|
873
|
+
|
|
874
|
+
`Cookie[]` - an array containing zero or more [`Cookie` objects](#response_49)
|
|
875
|
+
|
|
876
|
+
### getCookie
|
|
877
|
+
|
|
878
|
+
```
|
|
879
|
+
GET /session/:sessionId/cookie/:name
|
|
880
|
+
```
|
|
881
|
+
|
|
882
|
+
> WebDriver documentation: [Get Named Cookie](https://w3c.github.io/webdriver/#get-named-cookie)
|
|
883
|
+
|
|
884
|
+
Retrieves a cookie with the name identified by `:name` from the current browsing context.
|
|
885
|
+
|
|
886
|
+
#### Response
|
|
887
|
+
|
|
888
|
+
`Cookie` - an object with the following properties:
|
|
889
|
+
|
|
890
|
+
| Name | Description | Type |
|
|
891
|
+
| ----------- | -------------------------------------------------------------------------------- | ------- |
|
|
892
|
+
| `domain?` | Cookie domain | string |
|
|
893
|
+
| `expiry?` | Cookie expiration time (in seconds) as a Unix timestamp | number |
|
|
894
|
+
| `httpOnly?` | Whether the cookie is an HTTP only cookie | boolean |
|
|
895
|
+
| `name` | Cookie name | string |
|
|
896
|
+
| `path?` | Cookie path | string |
|
|
897
|
+
| `sameSite?` | SameSite policy type of the cookie (either `Lax` or `Strict`) | string |
|
|
898
|
+
| `secure?` | Whether the cookie is a secure cookie | boolean |
|
|
899
|
+
| `value` | Cookie value | string |
|
|
900
|
+
|
|
901
|
+
### setCookie
|
|
902
|
+
|
|
903
|
+
```
|
|
904
|
+
POST /session/:sessionId/cookie
|
|
905
|
+
```
|
|
906
|
+
|
|
907
|
+
> WebDriver documentation: [Add Cookie](https://w3c.github.io/webdriver/#add-cookie)
|
|
908
|
+
|
|
909
|
+
Adds a cookie to the cookie store of the current browsing context.
|
|
910
|
+
|
|
911
|
+
#### Parameters
|
|
912
|
+
|
|
913
|
+
| Name | Description | Type |
|
|
914
|
+
| -------- | -------------------- | ------------------------ |
|
|
915
|
+
| `cookie` | Cookie object to add | [`Cookie`](#response_49) |
|
|
916
|
+
|
|
917
|
+
#### Response
|
|
918
|
+
|
|
919
|
+
`null`
|
|
920
|
+
|
|
921
|
+
### deleteCookie
|
|
922
|
+
|
|
923
|
+
```
|
|
924
|
+
DELETE /session/:sessionId/cookie/:name
|
|
925
|
+
```
|
|
926
|
+
|
|
927
|
+
> WebDriver documentation: [Delete Cookie](https://w3c.github.io/webdriver/#delete-cookie)
|
|
928
|
+
|
|
929
|
+
Deletes a cookie with the name identified by `:name` from the current browsing context.
|
|
930
|
+
|
|
931
|
+
#### Response
|
|
932
|
+
|
|
933
|
+
`null`
|
|
934
|
+
|
|
935
|
+
### deleteCookies
|
|
936
|
+
|
|
937
|
+
```
|
|
938
|
+
DELETE /session/:sessionId/cookie
|
|
939
|
+
```
|
|
940
|
+
|
|
941
|
+
> WebDriver documentation: [Delete All Cookies](https://w3c.github.io/webdriver/#delete-all-cookies)
|
|
942
|
+
|
|
943
|
+
Deletes all cookies from the current browsing context.
|
|
944
|
+
|
|
945
|
+
#### Response
|
|
946
|
+
|
|
947
|
+
`null`
|
|
948
|
+
|
|
949
|
+
### performActions
|
|
950
|
+
|
|
951
|
+
```
|
|
952
|
+
POST /session/:sessionId/actions
|
|
953
|
+
```
|
|
954
|
+
|
|
955
|
+
> WebDriver documentation: [Perform Actions](https://w3c.github.io/webdriver/#perform-actions)
|
|
956
|
+
|
|
957
|
+
Performs a sequence of [actions](https://w3c.github.io/webdriver/#actions).
|
|
958
|
+
|
|
959
|
+
#### Parameters
|
|
960
|
+
|
|
961
|
+
| Name | Description | Type |
|
|
962
|
+
| --------- | ----------------------- | ------------------ |
|
|
963
|
+
| `actions` | Array of action objects | `ActionSequence[]` |
|
|
964
|
+
|
|
965
|
+
#### Response
|
|
966
|
+
|
|
967
|
+
`null`
|
|
968
|
+
|
|
969
|
+
### releaseActions
|
|
970
|
+
|
|
971
|
+
```
|
|
972
|
+
DELETE /session/:sessionId/actions
|
|
973
|
+
```
|
|
974
|
+
|
|
975
|
+
> WebDriver documentation: [Release Actions](https://w3c.github.io/webdriver/#release-actions)
|
|
976
|
+
|
|
977
|
+
Releases all currently depressed keys and pointer buttons.
|
|
978
|
+
|
|
979
|
+
#### Response
|
|
980
|
+
|
|
981
|
+
`null`
|
|
982
|
+
|
|
983
|
+
### postDismissAlert
|
|
984
|
+
|
|
985
|
+
```
|
|
986
|
+
POST /session/:sessionId/alert/dismiss
|
|
987
|
+
```
|
|
988
|
+
|
|
989
|
+
> WebDriver documentation: [Dismiss Alert](https://w3c.github.io/webdriver/#dismiss-alert)
|
|
990
|
+
|
|
991
|
+
Dismisses the currently displayed user prompt.
|
|
992
|
+
|
|
993
|
+
#### Response
|
|
994
|
+
|
|
995
|
+
`null`
|
|
996
|
+
|
|
997
|
+
### postAcceptAlert
|
|
998
|
+
|
|
999
|
+
```
|
|
1000
|
+
POST /session/:sessionId/alert/accept
|
|
1001
|
+
```
|
|
1002
|
+
|
|
1003
|
+
> WebDriver documentation: [Accept Alert](https://w3c.github.io/webdriver/#accept-alert)
|
|
1004
|
+
|
|
1005
|
+
Accepts the currently displayed user prompt.
|
|
1006
|
+
|
|
1007
|
+
#### Response
|
|
1008
|
+
|
|
1009
|
+
`null`
|
|
1010
|
+
|
|
1011
|
+
### getAlertText
|
|
1012
|
+
|
|
1013
|
+
```
|
|
1014
|
+
GET /session/:sessionId/alert/text
|
|
1015
|
+
```
|
|
1016
|
+
|
|
1017
|
+
> WebDriver documentation: [Get Alert Text](https://w3c.github.io/webdriver/#get-alert-text)
|
|
1018
|
+
|
|
1019
|
+
Retrieves the text of the currently displayed user prompt.
|
|
1020
|
+
|
|
1021
|
+
#### Response
|
|
1022
|
+
|
|
1023
|
+
`string` - prompt text
|
|
1024
|
+
|
|
1025
|
+
### setAlertText
|
|
1026
|
+
|
|
1027
|
+
```
|
|
1028
|
+
POST /session/:sessionId/alert/text
|
|
1029
|
+
```
|
|
1030
|
+
|
|
1031
|
+
> WebDriver documentation: [Send Alert Text](https://w3c.github.io/webdriver/#send-alert-text)
|
|
1032
|
+
|
|
1033
|
+
Sets the text of the currently displayed user prompt.
|
|
1034
|
+
|
|
1035
|
+
#### Parameters
|
|
1036
|
+
|
|
1037
|
+
| Name | Description | Type |
|
|
1038
|
+
| ------ | ----------- | ------ |
|
|
1039
|
+
| `text` | Text to set | string |
|
|
1040
|
+
|
|
1041
|
+
#### Response
|
|
1042
|
+
|
|
1043
|
+
`null`
|
|
1044
|
+
|
|
1045
|
+
### getScreenshot
|
|
1046
|
+
|
|
1047
|
+
```
|
|
1048
|
+
GET /session/:sessionId/screenshot
|
|
1049
|
+
```
|
|
1050
|
+
|
|
1051
|
+
> WebDriver documentation: [Take Screenshot](https://w3c.github.io/webdriver/#take-screenshot)
|
|
1052
|
+
|
|
1053
|
+
Takes a screenshot of the current browsing context.
|
|
1054
|
+
|
|
1055
|
+
#### Response
|
|
1056
|
+
|
|
1057
|
+
`string` - a base64-encoded PNG image
|
|
1058
|
+
|
|
1059
|
+
### getElementScreenshot
|
|
1060
|
+
|
|
1061
|
+
```
|
|
1062
|
+
GET /session/:sessionId/element/:elementId/screenshot
|
|
1063
|
+
```
|
|
1064
|
+
|
|
1065
|
+
> WebDriver documentation: [Take Element Screenshot](https://w3c.github.io/webdriver/#take-element-screenshot)
|
|
1066
|
+
|
|
1067
|
+
Takes a screenshot of the visible region encompassed by the bounding rectangle of the element
|
|
1068
|
+
identified by `:elementId`.
|
|
1069
|
+
|
|
1070
|
+
#### Response
|
|
1071
|
+
|
|
1072
|
+
`string` - a base64-encoded PNG image
|
|
1073
|
+
|
|
1074
|
+
### printPage
|
|
1075
|
+
|
|
1076
|
+
```
|
|
1077
|
+
POST /session/:sessionId/print
|
|
1078
|
+
```
|
|
1079
|
+
|
|
1080
|
+
> WebDriver documentation: [Print Page](https://w3c.github.io/webdriver/#print-page)
|
|
1081
|
+
|
|
1082
|
+
Prints the page by rendering it as a paginated PDF document.
|
|
1083
|
+
|
|
1084
|
+
#### Parameters
|
|
1085
|
+
|
|
1086
|
+
| <div style="width:7em">Name</div> | Description | <div style="width:9em">Type</div> | Default |
|
|
1087
|
+
| --------------------------------- | ------------------------------------------------------------------------------------------------- | --------------------------------------- | ---------- |
|
|
1088
|
+
| `orientation?` | Page orientation. Supported values are `portrait` or `landscape`. | string | `portrait` |
|
|
1089
|
+
| `scale?` | Page scale. Supported values are in the range `[0.1, 2]`. | number | `1` |
|
|
1090
|
+
| `background?` | Whether to include background images | boolean | `false` |
|
|
1091
|
+
| `page?` | Object specifying the page width and height | [`PrintPageSize`](#printpagesize) | `{}` |
|
|
1092
|
+
| `margin?` | Object specifying the page margins | [`PrintPageMargins`](#printpagemargins) | `{}` |
|
|
1093
|
+
| `shrinkToFit?` | Whether to resize page contents to match `PrintPageSize.width` | boolean | `true` |
|
|
1094
|
+
| `pageRanges?` | Array of pages to be printed, for example, `[1, 4, '8-9']` | array | `[]` |
|
|
1095
|
+
|
|
1096
|
+
##### `PrintPageSize`
|
|
1097
|
+
|
|
1098
|
+
| Name | Description | Type | Default |
|
|
1099
|
+
| --------- | -------------------------------------------------------------------------------------------- | ------ | ------- |
|
|
1100
|
+
| `width?` | Page width. Must be greater than or equal to `(2.54 / 72)`. | number | `21.59` |
|
|
1101
|
+
| `height?` | Page height. Must be greater than or equal to `(2.54 / 72)`. | number | `27.94` |
|
|
1102
|
+
|
|
1103
|
+
##### `PrintPageMargins`
|
|
1104
|
+
|
|
1105
|
+
| Name | Description | Type | Default |
|
|
1106
|
+
| --------- | ----------------------------------------------------------------------------------------- | ------ | ------- |
|
|
1107
|
+
| `top?` | Page top margin. Must be greater than or equal to `0`. | number | `1` |
|
|
1108
|
+
| `bottom?` | Page bottom margin. Must be greater than or equal to `0`. | number | `1` |
|
|
1109
|
+
| `left?` | Page left margin. Must be greater than or equal to `0`. | number | `1` |
|
|
1110
|
+
| `right?` | Page right margin. Must be greater than or equal to `0`. | number | `1` |
|
|
1111
|
+
|
|
1112
|
+
#### Response
|
|
1113
|
+
|
|
1114
|
+
`string` - a base64-encoded PDF document
|