1"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[5995],{22002:(e,i,s)=>{s.d(i,{R:()=>d,x:()=>l});var r=s(7378);const n={},t=r.createContext(n);function d(e){const i=r.useContext(t);return r.useMemo(function(){return"function"==typeof e?e(i):{...i,...e}},[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:d(e.components),r.createElement(t.Provider,{value:i},e.children)}},27155:(e,i,s)=>{s.r(i),s.d(i,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>d,metadata:()=>r,toc:()=>o});const r=JSON.parse('{"id":"api/appium","title":"Appium","description":"getLogTypes","source":"@site/docs/api/_appium.md","sourceDirName":"api","slug":"/api/appium","permalink":"/docs/api/appium","draft":false,"unlisted":false,"editUrl":"https://github.com/webdriverio/webdriverio/edit/main/packages/wdio-protocols/src/protocols/appium.ts","tags":[],"version":"current","frontMatter":{"id":"appium","title":"Appium","custom_edit_url":"https://github.com/webdriverio/webdriverio/edit/main/packages/wdio-protocols/src/protocols/appium.ts"},"sidebar":"api","previous":{"title":"Protocol Commands","permalink":"/docs/api/protocols"},"next":{"title":"Chromium","permalink":"/docs/api/chromium"}}');var n=s(86106),t=s(22002);
1const d={id:"appium",title:"Appium",custom_edit_url:"https://github.com/webdriverio/webdriverio/edit/main/packages/wdio-protocols/src/protocols/appium.ts"},l=void 0,c={},o=[{value:"getLogTypes",id:"getlogtypes",level:2},{value:"Usage",id:"usage",level:3},{value:"Returns",id:"returns",level:3},{value:"getLogs",id:"getlogs",level:2},{value:"Usage",id:"usage-1",level:3},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns-1",level:3},{value:"getSession",id:"getsession",level:2},{value:"Usage",id:"usage-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"getAppiumContext",id:"getappiumcontext",level:2},{value:"Usage",id:"usage-3",level:3},{value:"Returns",id:"returns-3",level:3},{value:"switchAppiumContext",id:"switchappiumcontext",level:2},{value:"Usage",id:"usage-4",level:3},{value:"Parameters",id:"parameters-1",level:3},{value:"getAppiumContexts",id:"getappiumcontexts",level:2},{value:"Usage",id:"usage-5",level:3},{value:"Returns",id:"returns-4",level:3},{value:"getAppiumCommands",id:"getappiumcommands",level:2},{value:"Usage",id:"usage-6",level:3},{value:"Returns",id:"returns-5",level:3},{value:"getAppiumExtensions",id:"getappiumextensions",level:2},{value:"Usage",id:"usage-7",level:3},{value:"Returns",id:"returns-6",level:3},{value:"getAppiumSessionCapabilities",id:"getappiumsessioncapabilities",level:2},{value:"Usage",id:"usage-8",level:3},{value:"Returns",id:"returns-7",level:3},{value:"appiumShake",id:"appiumshake",level:2},{value:"Usage",id:"usage-9",level:3},{value:"Support",id:"support",level:3},{value:"appiumLock",id:"appiumlock",level:2},{value:"Usage",id:"usage-10",level:3},{value:"Parameters",id:"parameters-2",level:3},{value:"Support",id:"support-1",level:3},{value:"appiumUnlock",id:"appiumunlock",level:2},{value:"Usage",id:"usage-11",level:3},{value:"Support",id:"support-2",level:3},{value:"appiumIsLocked",id:"appiumislocked",level:2},{value:"Usage",id:"usage-12",level:3},{value:"Returns",id:"returns-8",level:3},{value:"Support",id:"support-3",level:3},{value:"startRecordingScreen",id:"startrecordingscreen",level:2},{value:"Usage",id:"usage-13",level:3},{value:"Parameters",id:"parameters-3",level:3},{value:"Support",id:"support-4",level:3},{value:"stopRecordingScreen",id:"stoprecordingscreen",level:2},{value:"Usage",id:"usage-14",level:3},{value:"Parameters",id:"parameters-4",level:3},{value:"Returns",id:"returns-9",level:3},{value:"Support",id:"support-5",level:3},{value:"appiumGetPerformanceDataTypes",id:"appiumgetperformancedatatypes",level:2},{value:"Usage",id:"usage-15",level:3},{value:"Returns",id:"returns-10",level:3},{value:"Support",id:"support-6",level:3},{value:"appiumGetPerformanceData",id:"appiumgetperformancedata",level:2},{value:"Usage",id:"usage-16",level:3},{value:"Parameters",id:"parameters-5",level:3},{value:"Returns",id:"returns-11",level:3},{value:"Support",id:"support-7",level:3},{value:"appiumPressKeyCode",id:"appiumpresskeycode",level:2},{value:"Usage",id:"usage-17",level:3},{value:"Parameters",id:"parameters-6",level:3},{value:"Support",id:"support-8",level:3},{value:"appiumLongPressKeyCode",id:"appiumlongpresskeycode",level:2},{value:"Usage",id:"usage-18",level:3},{value:"Parameters",id:"parameters-7",level:3},{value:"Support",id:"support-9",level:3},{value:"appiumSendKeyEvent",id:"appiumsendkeyevent",level:2},{value:"Usage",id:"usage-19",level:3},{value:"Parameters",id:"parameters-8",level:3},{value:"Support",id:"support-10",level:3},{value:"rotateDevice",id:"rotatedevice",level:2},{value:"Usage",id:"usage-20",level:3},{value:"Parameters",id:"parameters-9",level:3},{value:"Support",id:"support-11",level:3},{value:"appiumGetCurrentActivity",id:"appiumgetcurrentactivity",level:2},{value:"Usage",id:"usage-21",level:3},{value:"Returns",id:"returns-12",level:3},{value:"Support",id:"support-12",level:3},{value:"appiumGetCurrentPackage",id:"appiumgetcurrentpackage",level:2},{value:"Usage",id:"usage-22",level:3},{value:"Returns",id:"returns-13",level:3},{value:"Support",id:"support-13",level:3},{value:"installApp",id:"installapp",level:2},{value:"Usage",id:"usage-23",level:3},{value:"Parameters",id:"parameters-10",level:3},{value:"Support",id:"support-14",level:3},{value:"activateApp",id:"activateapp",level:2},{value:"Usage",id:"usage-24",level:3},{value:"Parameters",id:"parameters-11",level:3},{value:"Support",id:"support-15",level:3},{value:"removeApp",id:"removeapp",level:2},{value:"Usage",id:"usage-25",level:3},{value:"Parameters",id:"parameters-12",level:3},{value:"Returns",id:"returns-14",level:3},{value:"Support",id:"support-16",level:3},{value:"terminateApp",id:"terminateapp",level:2},{value:"Usage",id:"usage-26",level:3},{value:"Parameters",id:"parameters-13",level:3},{value:"Support",id:"support-17",level:3}
1,{value:"isAppInstalled",id:"isappinstalled",level:2},{value:"Usage",id:"usage-27",level:3},{value:"Parameters",id:"parameters-14",level:3},{value:"Returns",id:"returns-15",level:3},{value:"Support",id:"support-18",level:3},{value:"queryAppState",id:"queryappstate",level:2},{value:"Usage",id:"usage-28",level:3},{value:"Parameters",id:"parameters-15",level:3},{value:"Returns",id:"returns-16",level:3},{value:"Support",id:"support-19",level:3},{value:"hideKeyboard",id:"hidekeyboard",level:2},{value:"Usage",id:"usage-29",level:3},{value:"Parameters",id:"parameters-16",level:3},{value:"Support",id:"support-20",level:3},{value:"isKeyboardShown",id:"iskeyboardshown",level:2},{value:"Usage",id:"usage-30",level:3},{value:"Returns",id:"returns-17",level:3},{value:"Support",id:"support-21",level:3},{value:"pushFile",id:"pushfile",level:2},{value:"Usage",id:"usage-31",level:3},{value:"Parameters",id:"parameters-17",level:3},{value:"Support",id:"support-22",level:3},{value:"pullFile",id:"pullfile",level:2},{value:"Usage",id:"usage-32",level:3},{value:"Parameters",id:"parameters-18",level:3},{value:"Returns",id:"returns-18",level:3},{value:"Support",id:"support-23",level:3},{value:"pullFolder",id:"pullfolder",level:2},{value:"Usage",id:"usage-33",level:3},{value:"Parameters",id:"parameters-19",level:3},{value:"Returns",id:"returns-19",level:3},{value:"Support",id:"support-24",level:3},{value:"appiumToggleAirplaneMode",id:"appiumtoggleairplanemode",level:2},{value:"Usage",id:"usage-34",level:3},{value:"Support",id:"support-25",level:3},{value:"appiumToggleData",id:"appiumtoggledata",level:2},{value:"Usage",id:"usage-35",level:3},{value:"Support",id:"support-26",level:3},{value:"appiumToggleWiFi",id:"appiumtogglewifi",level:2},{value:"Usage",id:"usage-36",level:3},{value:"Support",id:"support-27",level:3},{value:"appiumToggleLocationServices",id:"appiumtogglelocationservices",level:2},{value:"Usage",id:"usage-37",level:3},{value:"Support",id:"support-28",level:3},{value:"appiumToggleNetworkSpeed",id:"appiumtogglenetworkspeed",level:2},{value:"Usage",id:"usage-38",level:3},{value:"Parameters",id:"parameters-20",level:3},{value:"Support",id:"support-29",level:3},{value:"appiumOpenNotifications",id:"appiumopennotifications",level:2},{value:"Usage",id:"usage-39",level:3},{value:"Support",id:"support-30",level:3},{value:"appiumStartActivity",id:"appiumstartactivity",level:2},{value:"Usage",id:"usage-40",level:3},{value:"Parameters",id:"parameters-21",level:3},{value:"Support",id:"support-31",level:3},{value:"appiumGetSystemBars",id:"appiumgetsystembars",level:2},{value:"Usage",id:"usage-41",level:3},{value:"Returns",id:"returns-20",level:3},{value:"Support",id:"support-32",level:3},{value:"getDeviceTime",id:"getdevicetime",level:2},{value:"Usage",id:"usage-42",level:3},{value:"Returns",id:"returns-21",level:3},{value:"Support",id:"support-33",level:3},{value:"appiumGetDisplayDensity",id:"appiumgetdisplaydensity",level:2},{value:"Usage",id:"usage-43",level:3},{value:"Returns",id:"returns-22",level:3},{value:"Support",id:"support-34",level:3},{value:"appiumTouchId",id:"appiumtouchid",level:2},{value:"Usage",id:"usage-44",level:3},{value:"Parameters",id:"parameters-22",level:3},{value:"Support",id:"support-35",level:3},{value:"appiumToggleEnrollTouchId",id:"appiumtoggleenrolltouchid",level:2},{value:"Usage",id:"usage-45",level:3},{value:"Parameters",id:"parameters-23",level:3},{value:"Support",id:"support-36",level:3},{value:"appiumLaunchApp",id:"appiumlaunchapp",level:2},{value:"Usage",id:"usage-46",level:3},{value:"Support",id:"support-37",level:3},{value:"appiumCloseApp",id:"appiumcloseapp",level:2},{value:"Usage",id:"usage-47",level:3},{value:"Support",id:"support-38",level:3},{value:"appiumBackground",id:"appiumbackground",level:2},{value:"Usage",id:"usage-48",level:3},{value:"Parameters",id:"parameters-24",level:3},{value:"Support",id:"support-39",level:3},{value:"endCoverage",id:"endcoverage",level:2},{value:"Usage",id:"usage-49",level:3},{value:"Parameters",id:"parameters-25",level:3},{value:"Support",id:"support-40",level:3},{value:"appiumGetStrings",id:"appiumgetstrings",level:2},{value:"Usage",id:"usage-50",level:3},{value:"Parameters",id:"parameters-26",level:3},{value:"Returns",id:"returns-23",level:3},{value:"Support",id:"support-41",level:3},{value:"setValueImmediate",id:"setvalueimmediate",level:2},{value:"Usage",id:"usage-51",level:3},{value:"Parameters",id:"parameters-27",level:3},{value:"Support",id:"support-42",level:3},{value:"replaceValue",id:"replacevalue",level:2},{value:"Usage",id:"usage-52",level:3},{value:"Parameters",id:"parameters-28",level:3},{value:"Support",id:"support-43",level:3},{value:"getSettings",id:"getsettings",level:2},{value:"Usage",id:"usage-53",level:3},{value:"Returns",id:"returns-24",level:3},{value:"Support",id:"support-44",level:3},{value:"updateSettings",id:"updatesettings",level:2},{value:"Usage",id:"usage-54",level:3},{value:"Parameters",id:"parameters-29",level:3},{value:"Support",id:"support-45",level:3},{value:"receiveAsyncResponse",id:"receiveasyncresponse",level:2},{value:"Usage",id:"usage-55",level:3},{value:"Parameters",id:"parameters-30",level:3},{value:"Support",id:"support-46",level:3},{value:"appiumGsmCall",id:"appiumgsmcall",level:2},{value:"Usage",id:"usage-56",level:3},{value:"Parameters",id:"parameters-31",level:3},{value:"Support",id:"support-47",level:3},{value:"appiumGsmSignal",id:"appiumgsmsignal",level:2},{value:"Usage",id:"usage-57",level:3},{value:"Parameters",id:"parameters-32",level:3},{value:"Support",id:"support-48",level:3},{value:"appiumPowerCapacity",id:"appiumpowercapacity",level:2},{value:"Usage",id:"usage-58",level:3},{value:"Parameters",id:"parameters-33",level:3},{value:"Support",id:"support-49",level:3},{value:"appiumPowerAC",id:"appiumpowerac",level:2},{value:"Usage",id:"usage-59",level:3},{value:"Parameters",id:"parameters-34",level:3},{value:"Support",id:"support-50",level:3},{value:"appiumGsmVoice",id:"appiumgsmvoice",level:2},{value:"Usage",id:"usage-60",level:3},{value:"Parameters",id:"parameters-35",level:3},{value:"Support",id:"support-51",level:3},{value:"appiumSendSms",id:"appiumsendsms",level:2},{value:"Usage",id:"usage-61",level:3},{value:"Parameters",id:"parameters-36",level:3},{value:"Support",id:"support-52",level:3},{value:"appiumFingerPrint",id:"appiumfingerprint",level:2},{value:"Usage",id:"usage-62",level:3},{value:"Parameters",id:"parameters-37",level:3},{value:"Support",id:"support-53",level:3},{value:"appiumSetClipboard",id:"appiumsetclipboard",level:2},{value:"Usage",id:"usage-63",level:3},{value:"Parameters",id:"parameters-38",level:3},{value:"Returns",id:"returns-25",level:3},{value:"Support",id:"support-54",level:3},{value:"appiumGetClipboard",id:"appiumgetclipboard",level:2},{value:"Usage",id:"usage-64",level:3},{value:"Parameters",id:"parameters-39",level:3},{value:"Returns",id:"returns-26",level:3},{value:"Support",id:"support-55",level:3},{value:"touchPerform",id:"touchperform",level:2},{value:"Usage",id:"usage-65",level:3},{value:"Parameters",id:"parameters-40",level:3},{value:"Example",id:"example",level:3},{value:"Support",id:"support-56",level:3},{value:"multiTouchPerform",id:"multitouchperform",level:2},{value:"Usage",id:"usage-66",level:3},{value:"Parameters",id:"parameters-41",level:3},{value:"Support",id:"support-57",level:3},{value:"executeDriverScript",id:"executedriverscript",level:2},{value:"Usage",id:"usage-67",level:3},{value:"Parameters",id:"parameters-42",level:3},{value:"Returns",id:"returns-27",level:3},{value:"getEvents",id:"getevents",level:2},{value:"Usage",id:"usage-68",level:3},{value:"Parameters",id:"parameters-43",level:3},{value:"Returns",id:"returns-28",level:3},{value:"Support",id:"support-58",level:3},{value:"logEvent",id:"logevent",level:2},{value:"Usage",id:"usage-69",level:3},{value:"Parameters",id:"parameters-44",level:3},{value:"Support",id:"support-59",level:3},{value:"compareImages",id:"compareimages",level:2},{value:"Usage",id:"usage-70",level:3},{value:"Parameters",id:"parameters-45",level:3},{value:"Returns",id:"returns-29",level:3}
1,{value:"implicitWait",id:"implicitwait",level:2},{value:"Usage",id:"usage-71",level:3},{value:"Parameters",id:"parameters-46",level:3},{value:"Support",id:"support-60",level:3},{value:"getLocationInView",id:"getlocationinview",level:2},{value:"Usage",id:"usage-72",level:3},{value:"Parameters",id:"parameters-47",level:3},{value:"Returns",id:"returns-30",level:3},{value:"Support",id:"support-61",level:3},{value:"sendKeys",id:"sendkeys",level:2},{value:"Usage",id:"usage-73",level:3},{value:"Parameters",id:"parameters-48",level:3},{value:"Support",id:"support-62",level:3},{value:"availableIMEEngines",id:"availableimeengines",level:2},{value:"Usage",id:"usage-74",level:3},{value:"Returns",id:"returns-31",level:3},{value:"Support",id:"support-63",level:3},{value:"getActiveIMEEngine",id:"getactiveimeengine",level:2},{value:"Usage",id:"usage-75",level:3},{value:"Returns",id:"returns-32",level:3},{value:"Support",id:"support-64",level:3},{value:"isIMEActivated",id:"isimeactivated",level:2},{value:"Usage",id:"usage-76",level:3},{value:"Returns",id:"returns-33",level:3},{value:"Support",id:"support-65",level:3},{value:"deactivateIMEEngine",id:"deactivateimeengine",level:2},{value:"Usage",id:"usage-77",level:3},{value:"Support",id:"support-66",level:3},{value:"activateIMEEngine",id:"activateimeengine",level:2},{value:"Usage",id:"usage-78",level:3},{value:"Parameters",id:"parameters-49",level:3},{value:"Support",id:"support-67",level:3},{value:"asyncScriptTimeout",id:"asyncscripttimeout",level:2},{value:"Usage",id:"usage-79",level:3},{value:"Parameters",id:"parameters-50",level:3},{value:"Support",id:"support-68",level:3},{value:"submit",id:"submit",level:2},{value:"Usage",id:"usage-80",level:3},{value:"Parameters",id:"parameters-51",level:3},{value:"Support",id:"support-69",level:3},{value:"getElementSize",id:"getelementsize",level:2},{value:"Usage",id:"usage-81",level:3},{value:"Parameters",id:"parameters-52",level:3},{value:"Returns",id:"returns-34",level:3},{value:"Support",id:"support-70",level:3},{value:"getElementLocation",id:"getelementlocation",level:2},{value:"Usage",id:"usage-82",level:3},{value:"Parameters",id:"parameters-53",level:3},{value:"Returns",id:"returns-35",level:3},{value:"Support",id:"support-71",level:3},{value:"touchClick",id:"touchclick",level:2},{value:"Usage",id:"usage-83",level:3},{value:"Parameters",id:"parameters-54",level:3},{value:"Support",id:"support-72",level:3},{value:"touchDown",id:"touchdown",level:2},{value:"Usage",id:"usage-84",level:3},{value:"Parameters",id:"parameters-55",level:3},{value:"Support",id:"support-73",level:3},{value:"touchUp",id:"touchup",level:2},{value:"Usage",id:"usage-85",level:3},{value:"Parameters",id:"parameters-56",level:3},{value:"Support",id:"support-74",level:3},{value:"touchMove",id:"touchmove",level:2},{value:"Usage",id:"usage-86",level:3},{value:"Parameters",id:"parameters-57",level:3},{value:"Support",id:"support-75",level:3},{value:"touchLongClick",id:"touchlongclick",level:2},{value:"Usage",id:"usage-87",level:3},{value:"Parameters",id:"parameters-58",level:3},{value:"Support",id:"support-76",level:3},{value:"touchFlick",id:"touchflick",level:2},{value:"Usage",id:"usage-88",level:3},{value:"Parameters",id:"parameters-59",level:3},{value:"Support",id:"support-77",level:3},{value:"getOrientation",id:"getorientation",level:2},{value:"Usage",id:"usage-89",level:3},{value:"Returns",id:"returns-36",level:3},{value:"Support",id:"support-78",level:3},{value:"setOrientation",id:"setorientation",level:2},{value:"Usage",id:"usage-90",level:3},{value:"Parameters",id:"parameters-60",level:3},{value:"Support",id:"support-79",level:3},{value:"getGeoLocation",id:"getgeolocation",level:2},{value:"Usage",id:"usage-91",level:3},{value:"Returns",id:"returns-37",level:3},{value:"setGeoLocation",id:"setgeolocation",level:2},{value:"Usage",id:"usage-92",level:3},{value:"Parameters",id:"parameters-61",level:3}];function a(e){const i={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",h3:"h3",hr:"hr",img:"img",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.h2,{id:"getlogtypes",children:"getLogTypes"}),"\n",(0,n.jsxs)(i.p,{children:["Get available log types.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlogtypes",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getLogTypes()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<String[]>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"logTypes"})}),":"]})," The list of available log types, example: browser, driver."]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getlogs",children:"getLogs"}),"\n",(0,n.jsxs)(i.p,{children:["Get the log for a given log type. Log buffer is reset after each request.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidlog",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-1",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getLogs(type)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"type"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"the log type"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<Object[]>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"logs"})}),":"]})," The list of log entries."]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getsession",children:"getSession"}),"\n",(0,n.jsxs)(i.p,{children:["Retrieve the capabilities of the current session.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/jsonwp/#getsession",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use ",(0,n.jsx)(i.code,{children:"getAppiumSessionCapabilities"})," instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-2",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getSession()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<Object>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"capabilities"})}),":"]})," An object describing the session's capabilities."]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getappiumcontext",children:"getAppiumContext"}),"\n",(0,n.jsxs)(i.p,{children:["Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/mjsonwp/#getcurrentcontext",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-3",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getAppiumContext()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-3",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<Context>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"context"})}),":"]})," a string representing the current context or null representing 'no context'"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"switchappiumcontext",children:"switchAppiumContext"}),"\n",(0,n.jsxs)(i.p,{children:["Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/mjsonwp/#setcontext",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-4",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.switchAppiumContext(name)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"name"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"a string representing an available context"})]})})]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getappiumcontexts",children:"getAppiumContexts"}),"\n",(0,n.jsxs)(i.p,{children:["Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/mjsonwp/#getcontexts",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-5",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getAppiumContexts()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-4",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<Context[]>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"contexts"})}),":"]})," an array of strings representing available contexts, e.g. 'WEBVIEW', or 'NATIVE'"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getappiumcommands",children:"getAppiumCommands"}),"\n",(0,n.jsxs)(i.p,{children:["Retrieve the endpoints and BiDi commands supported in the current session.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#listcommands",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-6",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getAppiumCommands()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-5",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<Object>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"commands"})}),":"]})," Supported endpoints and BiDi commands, each grouped into common, driver-specific, and plugin-specific endpoints/commands."]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getappiumextensions",children:"getAppiumExtensions"}),"\n",(0,n.jsxs)(i.p,{children:["Retrieve the extension commands supported in the current session.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#listextensions",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-7",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getAppiumExtensions()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-6",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<Object>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"commands"})}),":"]})," Supported extension commands, grouped into driver-specific and plugin-specific commands."]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getappiumsessioncapabilities",children:"getAppiumSessionCapabilities"}),"\n",(0,n.jsxs)(i.p,{children:["Retrieve the capabilities of the current session.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#getappiumsessioncapabilities",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-8",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getAppiumSessionCapabilities()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-7",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<Object>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"capabilities"})}),":"]})," An object describing the session's capabilities."]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumshake",children:"appiumShake"}),"\n",(0,n.jsxs)(i.p,{children:["Perform a shake action on the device. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.co
1de,{children:"shake"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/interactions/shake/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"shake"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.shake()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-9",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumShake()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"support",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumlock",children:"appiumLock"}),"\n",(0,n.jsxs)(i.p,{children:["Lock the device. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"lock"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/interactions/lock/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"lock"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.lock()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-10",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumLock(seconds)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"seconds"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"how long to lock the screen (iOS only)"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-1",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for Windows (10+)",src:s(29403).A+"",width:"88",height:"88"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Windows:"})," Windows (10+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumunlock",children:"appiumUnlock"}),"\n",(0,n.jsxs)(i.p,{children:["Unlock the device. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"unlock"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/interactions/unlock/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}
1),"Use the ",(0,n.jsx)(i.code,{children:"unlock"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.unlock()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-11",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumUnlock()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"support-2",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for Windows (10+)",src:s(29403).A+"",width:"88",height:"88"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Windows:"})," Windows (10+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumislocked",children:"appiumIsLocked"}),"\n",(0,n.jsxs)(i.p,{children:["Check whether the device is locked or not. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"isLocked"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/interactions/is-locked/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"isLocked"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.isLocked()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-12",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumIsLocked()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-8",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<boolean>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"isLocked"})}),":"]})," True if the device is locked, false if not"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-3",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for Windows (10+)",src:s(29403).A+"",width:"88",height:"88"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Windows:"})," Windows (10+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"startrecordingscreen",children:"startRecordingScreen"}),"\n",(0,n.jsxs)(i.p,{children:["Start recording the screen.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/recording-screen/start-recording-screen/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-13",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.startRecordingScreen(options)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"options"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"object"})}),(0,n.jsx)(i.td,{children:"command parameters that can contain keys like: remotePath, username, password, method, forceRestart, timeLimit, videoType, videoQuality, videoFps, bitRate, videoSize, bugReport (see more description in Appium docs)"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-4",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for Windows (10+)",src:s(29403).A+"",width:"88",height:"88"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Windows:"})," Windows (10+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"stoprecordingscreen",children:"stopRecordingScreen"}),"\n",(0,n.jsxs)(i.p,{children:["Stop recording screen.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/recording-screen/stop-recording-screen/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-14",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.stopRecordingScreen(remotePath, username, password, method)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-4",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"remotePath"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"The path to the remote location, where the resulting video should be uploaded. The following protocols are supported http/https, ftp. This option only has an effect if there is screen recording process in progreess and forceRestart parameter is not set to true. Null or empty string value (the default setting) means the content of resulting file should be encoded as Base64."})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"username"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"The name of the user for the remote authentication."})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"password"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"The password for the remote authentication."})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"method"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"The http multipart upload method name. The 'PUT' one is used by default."})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-9",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<string>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"response"})}),":"]})," Base64 encoded string. If remote_path is set, the response is empty string"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-5",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for Windows (10+)",src:s(29403).A+"",width:"88",height:"88"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Windows:"})," Windows (10+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumgetperformancedatatypes",children:"appiumGetPerformanceDataTypes"}),"\n",(0,n.jsxs)(i.p,{children:["Returns the information types of the system state which is supported to read as like cpu, memory, network traffic, and battery. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"getPerformanceDataTypes"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/performance-data/performance-data-types/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"getPerformanceDataTypes"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.getPerformanceDataTypes()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-15",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumGetPerformanceDataTypes()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-10",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<string[]>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"performanceTypes"})}),":"]})," The available performance data types (cpuinfo|batteryinfo|networkinfo|memoryinfo)"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-6",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumgetperformancedata",children:"appiumGetPerformanceData"}),"\n",(0,n.jsxs)(i.p,{children:["Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"getPerformanceData"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/performance-data/get-performance-data/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"getPerformanceData"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.getPerformanceData()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-16",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumGetPerformanceData(packageName, dataType, dataReadTimeout)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-5",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"packageName"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"the package name of the application"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"dataType"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"the type of system state which wants to read. It should be one of the supported performance data types"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"dataReadTimeout"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"the number of attempts to read"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-11",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<string[]>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"performanceData"})}),":"]})," The information type of the system state which is supported to read as like cpu, memory, network traffic, and battery"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-7",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumpresskeycode",children:"appiumPressKeyCode"}),"\n",(0,n.jsxs)(i.p,{children:["Press a particular key on the device. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.co
1de,{children:"pressKeyCode"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/keys/press-keycode/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"pressKeyCode"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.pressKeyCode()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-17",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumPressKeyCode(keycode, metastate, flags)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-6",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"keycode"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"keycode to press"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"metastate"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"meta state to press the keycode with"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"flags"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"flags for the keypress"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-8",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumlongpresskeycode",children:"appiumLongPressKeyCode"}),"\n",(0,n.jsxs)(i.p,{children:["Press and hold a particular key code on the device. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"longPressKeyCode"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/keys/long-press-keycode/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"longPressKeyCode"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.longPressKeyCode()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-18",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumLongPressKeyCode(keycode, metastate, flags)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-7",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"keycode"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"keycode to press on the device"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"metastate"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"metastate for the keypress"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.co
1de,{children:"flags"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"flags for the keypress"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-9",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumsendkeyevent",children:"appiumSendKeyEvent"}),"\n",(0,n.jsxs)(i.p,{children:["Send a key code to the device. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"pressKeyCode"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"pressKeyCode"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.pressKeyCode()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-19",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumSendKeyEvent(keycode, metastate)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-8",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"keycode"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"keycode to press"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"metastate"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"meta state to press the keycode with"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-10",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"rotatedevice",children:"rotateDevice"}),"\n",(0,n.jsxs)(i.p,{children:["Rotate the device in three dimensions.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/mjsonwp/#setrotation",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-20",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.rotateDevice(x, y, z)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-9",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"x"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"x offset to use for the center of the rotate gesture"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"y"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"y offset to use for the center of the rotate gesture"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.co
1de,{children:"z"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"z offset to use for the center of the rotate gesture"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-11",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumgetcurrentactivity",children:"appiumGetCurrentActivity"}),"\n",(0,n.jsxs)(i.p,{children:["Get the name of the current Android activity. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"getCurrentActivity"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/activity/current-activity/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"getCurrentActivity"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.getCurrentActivity()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-21",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumGetCurrentActivity()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-12",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<string>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"activity"})}),":"]})," Name of the current activity"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-12",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumgetcurrentpackage",children:"appiumGetCurrentPackage"}),"\n",(0,n.jsxs)(i.p,{children:["Get the name of the current Android package. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"getCurrentPackage"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/activity/current-package/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"getCurrentPackage"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.getCurrentPackage()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-22",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumGetCurrentPackage()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-13",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<string>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"package"})}),":"]})," Name of the current package"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-13",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"installapp",children:"installApp"}),"\n",(0,n.jsxs)(i.p,{children:["Install the given app onto the device.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#installapp",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-23",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.installApp(appPath, options)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-10",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"appPath"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"Path to application .apk file"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"options"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"object"})}),(0,n.jsx)(i.td,{children:"Driver-specific installation options"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-14",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"activateapp",children:"activateApp"}),"\n",(0,n.jsxs)(i.p,{children:["Activate the given app on the device",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#activateapp",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-24",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.activateApp(appId, bundleId, options)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-11",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"appId"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"App package ID (required for Android)"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"bundleId"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"Bundle ID (required for iOS)"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"options"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"object"})}),(0,n.jsx)(i.td,{children:"Driver-specific launch options"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-15",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"removeapp",children:"removeApp"}),"\n",(0,n.jsxs)(i.p,{children:["Remove an app from the device.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#removeapp",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-25",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.removeApp(appId, bundleId, options)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-12",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"appId"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"App package ID (required for Android)"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"bundleId"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"Bundle ID (required for iOS)"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"options"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"object"})}),(0,n.jsx)(i.td,{children:"Driver-specific uninstall options"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-14",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<boolean>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"didRemovalSucceed"})}),":"]})," Return true if uninstall was successful, false if not"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-16",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"terminateapp",children:"terminateApp"}),"\n",(0,n.jsxs)(i.p,{children:["Terminate the given app on the device",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#terminateapp",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-26",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.terminateApp(appId, bundleId, options)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-13",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"appId"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"App package ID (required for Android)"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"bundleId"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"Bundle ID (required for iOS)"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"options"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"object"})}),(0,n.jsx)(i.td,{children:"Driver-specific termination options"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-17",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"isappinstalled",children:"isAppInstalled"}),"\n",(0,n.jsxs)(i.p,{children:["Check whether the specified app is installed on the device.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#isappinstalled",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-27",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.isAppInstalled(appId, bundleId)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-14",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"appId"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"App package ID (required for Android)"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"bundleId"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"Bundle ID (required for iOS)"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-15",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<boolean>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"isAppInstalled"})}),":"]})," Return true if installed, false if not"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-18",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"queryappstate",children:"queryAppState"}),"\n",(0,n.jsxs)(i.p,{children:["Get the given app status on the device",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#queryappstate",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-28",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.queryAppState(appId, bundleId)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-15",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"appId"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"App package ID (required for Android)"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"bundleId"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"Bundle ID (required for iOS)"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-16",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<number>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"appStatus"})}),":"]})," 0 is not installed. 1 is not running. 2 is running in background suspended. 3 is running in background. 4 is running in foreground"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-19",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"hidekeyboard",children:"hideKeyboard"}),"\n",(0,n.jsxs)(i.p,{children:["Hide soft keyboard.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#hidekeyboard",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-29",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.hideKeyboard(strategy, key, keyCode, keyName)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-16",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"strategy"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"hide keyboard strategy (UIAutomation only), available strategies - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"key"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"key value if strategy is 'pressKey'"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"keyCode"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"key code if strategy is 'pressKey'"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"keyName"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"key name if strategy is 'pressKey'"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-20",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for Windows (10+)",src:s(29403).A+"",width:"88",height:"88"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Windows:"})," Windows (10+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"iskeyboardshown",children:"isKeyboardShown"}),"\n",(0,n.jsxs)(i.p,{children:["Whether or not the soft keyboard is shown.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#iskeyboardshown",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-30",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.isKeyboardShown()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-17",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<boolean>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"isKeyboardShown"})}),":"]})," True if the keyboard is shown"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-21",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for Windows (10+)",src:s(29403).A+"",width:"88",height:"88"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Windows:"})," Windows (10+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"pushfile",children:"pushFile"}),"\n",(0,n.jsxs)(i.p,{children:["Place a file onto the device in a particular place.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#pushfile",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-31",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.pushFile(path, data)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-17",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"path"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"path to install the data to"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"data"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"contents of file in base64"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-22",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for Windows (10+)",src:s(29403).A+"",width:"88",height:"88"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Windows:"})," Windows (10+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"pullfile",children:"pullFile"}),"\n",(0,n.jsxs)(i.p,{children:["Retrieve a file from the device's file system.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#pullfile",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-32",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.pullFile(path)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-18",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"path"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"path on the device to pull file from"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-18",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<string>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"response"})}),":"]})," Contents of file in base64"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-23",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for Windows (10+)",src:s(29403).A+"",width:"88",height:"88"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Windows:"})," Windows (10+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"pullfolder",children:"pullFolder"}),"\n",(0,n.jsxs)(i.p,{children:["Retrieve a folder from the device's file system.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#pullfolder",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-33",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.pullFolder(path)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-19",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"path"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"path to an entire folder on the device"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-19",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<string>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"response"})}),":"]})," Zip file of the folder contents in base64"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-24",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for Windows (10+)",src:s(29403).A+"",width:"88",height:"88"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Windows:"})," Windows (10+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumtoggleairplanemode",children:"appiumToggleAirplaneMode"}),"\n",(0,n.jsxs)(i.p,{children:["Toggle airplane mode on device. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"toggleAirplaneMode"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-airplane-mode/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"toggleAirplaneMode"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.toggleAirplaneMode()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-34",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumToggleAirplaneMode()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"support-25",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumtoggledata",children:"appiumToggleData"}),"\n",(0,n.jsxs)(i.p,{children:["Switch the state of data service. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"toggleData"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-data/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"toggleData"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.toggleData()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-35",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumToggleData()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"support-26",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumtogglewifi",children:"appiumToggleWiFi"}),"\n",(0,n.jsxs)(i.p,{children:["Switch the state of the wifi service. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"toggleWiFi"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-wifi/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"toggleWiFi"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.toggleWiFi()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-36",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumToggleWiFi()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"support-27",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumtogglelocationservices",children:"appiumToggleLocationServices"}),"\n",(0,n.jsxs)(i.p,{children:["Switch the state of the location service. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"toggleLocationServices"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-location-services/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"toggleLocationServices"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.toggleLocationServices()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-37",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumToggleLocationServices()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"support-28",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumtogglenetworkspeed",children:"appiumToggleNetworkSpeed"}),"\n",(0,n.jsxs)(i.p,{children:["Set network speed (Emulator only). This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"toggleNetworkSpeed"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/network/network-speed/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"toggleNetworkSpeed"}
1)," mobile command (",(0,n.jsx)(i.code,{children:"driver.toggleNetworkSpeed()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-38",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumToggleNetworkSpeed(netspeed)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-20",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"netspeed"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"Network type - 'full','gsm', 'edge', 'hscsd', 'gprs', 'umts', 'hsdpa', 'lte', 'evdo'"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-29",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumopennotifications",children:"appiumOpenNotifications"}),"\n",(0,n.jsxs)(i.p,{children:["Open Android notifications. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"openNotifications"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/system/open-notifications/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"openNotifications"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.openNotifications()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-39",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumOpenNotifications()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"support-30",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumstartactivity",children:"appiumStartActivity"}),"\n",(0,n.jsxs)(i.p,{children:["Start an Android activity by providing package name and activity name. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"startActivity"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/activity/start-activity/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"startActivity"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.startActivity()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-40",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumStartActivity(appPackage, appActivity, appWaitPackage, appWaitActivity, intentAction, intentCategory, intentFlags, optionalIntentArguments, dontStopAppOnReset)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-21",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.co
1de,{children:"appPackage"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"name of app"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"appActivity"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"name of activity"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"appWaitPackage"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"name of app to wait for"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"appWaitActivity"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"name of activity to wait for"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"intentAction=android.intent.action.MAIN"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"intent action which will be used to start activity"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"intentCategory=android.intent.category.LAUNCHER"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"intent category which will be used to start activity"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"intentFlags=0x10200000"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"flags that will be used to start activity"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"optionalIntentArguments"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"additional intent arguments that will be used to start activity"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"dontStopAppOnReset"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"doesn\u2019t stop the process of the app under test, before starting the app using adb"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-31",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumgetsystembars",children:"appiumGetSystemBars"}),"\n",(0,n.jsxs)(i.p,{children:["Retrieve visibility and bounds information of the status and navigation bars. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"getSystemBars"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/system/system-bars/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"getSystemBars"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.getSystemBars()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-41",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumGetSystemBars()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-20",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<object[]>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"systemBars"})}),":"]})," Information about visibility and bounds of status and navigation bar"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-32",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getdevicetime",children:"getDeviceTime"}),"\n",(0,n.jsxs)(i.p,{children:["Get the time on the device.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/system/system-time/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-42",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getDeviceTime()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-21",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<string>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"time"})}),":"]})," Time on the device"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-33",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumgetdisplaydensity",children:"appiumGetDisplayDensity"}),"\n",(0,n.jsxs)(i.p,{children:["Get display density from device. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"getDisplayDensity"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"getDisplayDensity"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.getDisplayDensity()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-43",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumGetDisplayDensity()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-22",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsx)(i.li,{children:(0,n.jsx)(i.strong,{children:"<*>"})}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-34",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumtouchid",children:"appiumTouchId"}),"\n",(0,n.jsxs)(i.p,{children:["Simulate a ",(0,n.jsx)(i.a,{href:"https://support.apple.com/en-ca/ht201371",children:"touch id"})," event (iOS Simulator only). To enable this feature, the ",(0,n.jsx)(i.code,{children:"allowTouchIdEnroll"})," desired capability must be set to true and the Simulator must be ",(0,n.jsx)(i.a,{href:"https://support.apple.com/en-ca/ht201371",children:"enrolled"}),". When you set allowTouchIdEnroll to true, it will set the Simulator to be enrolled by default. The enrollment state can be ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/index.html",children:"toggled"}),". This call will only work if Appium process or its parent application (e.g. Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/simulator/touch-id/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"touchId"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.touchId()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-44",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumTouchId(match)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-22",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"match"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"boolean"})}),(0,n.jsx)(i.td,{children:"are we simulating a successful touch (true) or a failed touch (false)"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-35",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumtoggleenrolltouchid",children:"appiumToggleEnrollTouchId"}),"\n",(0,n.jsxs)(i.p,{children:["Toggle the simulator being ",(0,n.jsx)(i.a,{href:"https://support.apple.com/en-ca/ht201371",children:"enrolled"})," to accept touchId (iOS Simulator only). To enable this feature, the ",(0,n.jsx)(i.code,{children:"allowTouchIdEnroll"})," desired capability must be set to true. When ",(0,n.jsx)(i.code,{children:"allowTouchIdEnroll"})," is set to true the Simulator will be enrolled by default, and the 'Toggle Touch ID Enrollment' changes the enrollment state. This call will only work if the Appium process or its parent application (e.g., Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"toggleEnrollTouchId"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.toggleEnrollTouchId()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-45",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumToggleEnrollTouchId(enabled)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-23",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"enabled=true"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"boolean"})}),(0,n.jsx)(i.td,{children:"equals to true if TouchID enrollment should be enabled"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-36",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumlaunchapp",children:"appiumLaunchApp"}),"\n",(0,n.jsxs)(i.p,{children:["Launch an app on device. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"launchApp"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/app/launch-app/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}
1),"Use the ",(0,n.jsx)(i.code,{children:"launchApp"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.launchApp()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-46",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumLaunchApp()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"support-37",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumcloseapp",children:"appiumCloseApp"}),"\n",(0,n.jsxs)(i.p,{children:["Close an app on device. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"closeApp"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/app/close-app/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"closeApp"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.closeApp()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-47",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumCloseApp()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"support-38",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumbackground",children:"appiumBackground"}),"\n",(0,n.jsxs)(i.p,{children:["Send the currently running app for this session to the background. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"background"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/app/background-app/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"background"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.background()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-48",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumBackground(seconds)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-24",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"seconds=null"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number, null"})}),(0,n.jsx)(i.td,{children:"Timeout after which to restore the app. A value of -1 disables the timeout"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-39",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"endcoverage",children:"endCoverage"}),"\n",(0,n.jsxs)(i.p,{children:["Get test coverage data.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/app/end-test-coverage/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}
1),"Use ",(0,n.jsx)(i.code,{children:"driver.execute('mobile: shell', { ... })"})," instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-49",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.endCoverage(intent, path)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-25",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"intent"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"intent to broadcast"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"path"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"path to .ec file"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-40",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumgetstrings",children:"appiumGetStrings"}),"\n",(0,n.jsxs)(i.p,{children:["Get app strings. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"getStrings"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/app/get-app-strings/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"getStrings"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.getStrings()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-50",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumGetStrings(language, stringFile)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-26",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"language"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"language code"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"stringFile"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"path to the string file"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-23",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<object>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"appStrings"})}),":"]})," all defined Strings from an app for the specified language and strings filename"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-41",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"setvalueimmediate",children:"setValueImmediate"}),"\n",(0,n.jsxs)(i.p,{children:["Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}
1),"Use ",(0,n.jsx)(i.code,{children:"driver.addValue(...)"})," or ",(0,n.jsx)(i.code,{children:"driver.setValue(...)"})," instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-51",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.setValueImmediate(elementId, text)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-27",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"elementId"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"String"})}),(0,n.jsx)(i.td,{children:"the id of an element returned in a previous call to Find Element(s)"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"text"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"text to set to an element"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-42",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"replacevalue",children:"replaceValue"}),"\n",(0,n.jsxs)(i.p,{children:["Replace the value to element directly.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use ",(0,n.jsx)(i.code,{children:"driver.addValue(...)"})," or ",(0,n.jsx)(i.code,{children:"driver.setValue(...)"})," instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-52",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.replaceValue(elementId, value)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-28",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"elementId"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"String"})}),(0,n.jsx)(i.td,{children:"the id of an element returned in a previous call to Find Element(s)"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"value"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"value to replace on element"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-43",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getsettings",children:"getSettings"}),"\n",(0,n.jsxs)(i.p,{children:["Retrieve the current session settings.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#getsettings",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-53",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getSettings()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-24",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<object>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"settings"})}),":"]})," JSON hash of all the currently specified settings, see Settings API"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-44",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for Windows (10+)",src:s(29403).A+"",width:"88",height:"88"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Windows:"})," Windows (10+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"updatesettings",children:"updateSettings"}),"\n",(0,n.jsxs)(i.p,{children:["Update the session settings.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#updatesettings",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-54",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.updateSettings(settings)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-29",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"settings"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"object"})}),(0,n.jsx)(i.td,{children:"key/value object with settings to update"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-45",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for Windows (10+)",src:s(29403).A+"",width:"88",height:"88"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Windows:"})," Windows (10+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"receiveasyncresponse",children:"receiveAsyncResponse"}),"\n",(0,n.jsxs)(i.p,{children:["Callback url for asynchronous execution of JavaScript.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use ",(0,n.jsx)(i.code,{children:"driver.executeAsyncScript(...)"})," instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-55",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.receiveAsyncResponse(response)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-30",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.co
1de,{children:"response"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"object"})}),(0,n.jsx)(i.td,{children:"response to receive on device"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-46",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumgsmcall",children:"appiumGsmCall"}),"\n",(0,n.jsxs)(i.p,{children:["Make GSM call (Emulator only). This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"gsmCall"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-call/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"gsmCall"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.gsmCall()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-56",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumGsmCall(phoneNumber, action)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-31",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"phoneNumber"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"the phone number to call to"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"action"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"The action - 'call', 'accept', 'cancel', 'hold'"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-47",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumgsmsignal",children:"appiumGsmSignal"}),"\n",(0,n.jsxs)(i.p,{children:["Set GSM signal strength (Emulator only). This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"gsmSignal"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-signal/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"gsmSignal"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.gsmSignal()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-57",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumGsmSignal(signalStrength, signalStrengh)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-32",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"signalStrength"})}
1),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"signal strength in the range [0, 4]"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"signalStrengh"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsxs)(i.td,{children:["signal strength in the range [0, 4]. Please also set this parameter with the same value if you use Appium v1.11.0 or lower (see ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium/issues/12234",children:"https://github.com/appium/appium/issues/12234"}),")."]})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-48",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumpowercapacity",children:"appiumPowerCapacity"}),"\n",(0,n.jsxs)(i.p,{children:["Set the battery percentage (Emulator only). This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"powerCapacity"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_capacity/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"powerCapacity"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.powerCapacity()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-58",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumPowerCapacity(percent)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-33",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"percent"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"percentage value in range [0, 100]"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-49",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumpowerac",children:"appiumPowerAC"}),"\n",(0,n.jsxs)(i.p,{children:["Set the state of the battery charger to connected or not (Emulator only). This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"powerAC"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_ac/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"powerAC"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.powerAC()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-59",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumPowerAC(state)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-34",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.co
1de,{children:"state"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"set the state. on or off"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-50",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumgsmvoice",children:"appiumGsmVoice"}),"\n",(0,n.jsxs)(i.p,{children:["Set GSM voice state (Emulator only). This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"gsmVoice"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-voice/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"gsmVoice"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.gsmVoice()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-60",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumGsmVoice(state)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-35",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"state"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"state of GSM voice - 'unregistered', 'home', 'roaming', 'searching', 'denied', 'off', 'on'"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-51",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumsendsms",children:"appiumSendSms"}),"\n",(0,n.jsxs)(i.p,{children:["Simulate an SMS message (Emulator only). This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"sendSms"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/network/send-sms/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"sendSms"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.sendSms()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-61",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumSendSms(phoneNumber, message)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-36",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"phoneNumber"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"the phone number to send the SMS too"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"message"})}
1),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"the SMS message"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-52",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumfingerprint",children:"appiumFingerPrint"}),"\n",(0,n.jsxs)(i.p,{children:["Authenticate users by using their finger print scans on supported emulators. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"fingerPrint"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/authentication/finger-print/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"fingerPrint"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.fingerPrint()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-62",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumFingerPrint(fingerprintId)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-37",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"fingerprintId"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"finger prints stored in Android Keystore system (from 1 to 10)"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-53",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumsetclipboard",children:"appiumSetClipboard"}),"\n",(0,n.jsxs)(i.p,{children:["Set the content of the system clipboard. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"setClipboard"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/clipboard/set-clipboard/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"setClipboard"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.setClipboard()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-63",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumSetClipboard(content, contentType, label)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-38",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"content"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"The actual base64 encoded clipboard content"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.co
1de,{children:"contentType"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"The type of the content to get. Plaintext, Image, URL. Android supports only plaintext"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"label"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"Clipboard data label for Android"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-25",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<string>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"response"})}),":"]})," Response from Appium server"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-54",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"appiumgetclipboard",children:"appiumGetClipboard"}),"\n",(0,n.jsxs)(i.p,{children:["Get the content of the system clipboard. This is the raw Appium protocol endpoint. Prefer the ",(0,n.jsx)(i.code,{children:"getClipboard"})," mobile command which provides automatic Appium 3 compatibility with fallback for older drivers.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/device/clipboard/get-clipboard/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use the ",(0,n.jsx)(i.code,{children:"getClipboard"})," mobile command (",(0,n.jsx)(i.code,{children:"driver.getClipboard()"}),") instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-64",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.appiumGetClipboard(contentType)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-39",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"contentType"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"The type of the content to get. Plaintext, Image, URL. Android supports only plaintext"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-26",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<string>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"response"})}),":"]})," Clipboard content as base64-encoded string or an empty string if the clipboard is empty"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-55",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"touchperform",children:"touchPerform"}),"\n",(0,n.jsxs)(i.p,{children:["This functionality is only available from within a native context. 'Touch Perform' works similarly to the other singular touch interactions, except that this allows you to chain together more than one touch action as one command. This is useful because Appium commands are sent over the network and there's latency between commands. This latency can make certain touch interactions impossible because some interactions need to be performed in one sequence. Vertical, for example, requires pressing down, moving to a different y coordinate, and then releasing. For it to work, there can't be a delay between the interactions.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/interactions/touch/touch-perform/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}
1),"Use ",(0,n.jsx)(i.code,{children:"driver.performActions(...)"})," instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-65",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.touchPerform(actions)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-40",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"actions"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"object[]"})}),(0,n.jsx)(i.td,{children:"The type of action to perform (e.g. moveTo, release, press, tap, wait)"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"example",children:"Example"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"// do a horizontal swipe by percentage\nconst startPercentage = 10;\nconst endPercentage = 90;\nconst anchorPercentage = 50;\n\nconst { width, height } = driver.getWindowSize();\nconst anchor = height * anchorPercentage / 100;\nconst startPoint = width * startPercentage / 100;\nconst endPoint = width * endPercentage / 100;\ndriver.touchPerform([\n {\n action: 'press',\n options: {\n x: startPoint,\n y: anchor,\n },\n },\n {\n action: 'wait',\n options: {\n ms: 100,\n },\n },\n {\n action: 'moveTo',\n options: {\n x: endPoint,\n y: anchor,\n },\n },\n {\n action: 'release',\n options: {},\n },\n]);\n"})}),"\n",(0,n.jsx)(i.h3,{id:"support-56",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for Windows (10+)",src:s(29403).A+"",width:"88",height:"88"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Windows:"})," Windows (10+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"multitouchperform",children:"multiTouchPerform"}),"\n",(0,n.jsxs)(i.p,{children:["This functionality is only available from within a native context. Perform a multi touch action sequence.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.github.io/appium.io/docs/en/commands/interactions/touch/multi-touch-perform/",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use ",(0,n.jsx)(i.code,{children:"driver.performActions(...)"})," instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-66",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.multiTouchPerform(actions)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-41",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"actions"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"object[]"})}),(0,n.jsx)(i.td,{children:"The type of action to perform (e.g. moveTo, release, press, tap, wait)"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-57",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)",src:s(28491).A+"",width:"496",height:"609"}),"\n",(0,n.jsx)(i.img,{alt:"Support for Windows (10+)",src:s(29403).A+"",width:"88",height:"88"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+), UIAutomation (8.0 to 9.3)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Windows:"})," Windows (10+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"executedriverscript",children:"executeDriverScript"}),"\n",(0,n.jsxs)(i.p,{children:["Execute a script in a child process. This approach helps minimize potential latency associated with each command. ",(0,n.jsx)(i.em,{children:(0,n.jsxs)(i.strong,{children:["Using this command in Appium 2 or later requires installing the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium/tree/master/packages/execute-driver-plugin",children:(0,n.jsx)(i.co
1de,{children:"execute-driver"})})," plugin."]})}),(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/plugins/#executedriverscript",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-67",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.executeDriverScript(script, type, timeout)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-42",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"script"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"The script to execute. It has access to a 'driver' object which represents a WebdriverIO session attached to the current server."})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"type"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"The language/framework used in the script. Currently, only 'webdriverio' is supported and is the default."})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"timeout"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"The number of milliseconds the script should be allowed to run before being killed by the Appium server. Defaults to the equivalent of 1 hour."})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-27",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<object>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"result"})}),":"]})," An object containing two fields: 'result', which is the return value of the script itself, and 'logs', which contains 3 inner fields, 'log', 'warn', and 'error', which hold an array of strings logged by console.log, console.warn, and console.error in the script's execution."]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getevents",children:"getEvents"}),"\n",(0,n.jsxs)(i.p,{children:["Get events logged in the current session.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#getlogevents",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-68",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getEvents(type)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-43",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"type"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string, string[]"})}),(0,n.jsx)(i.td,{children:"One or more event types to filter the returned events"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-28",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<object>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"result"})}),":"]})," A JSON hash of events like ",(0,n.jsx)(i.code,{children:"{'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }"}),"."]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-58",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"logevent",children:"logEvent"}),"\n",(0,n.jsxs)(i.p,{children:["Log a custom event.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/appium/#logcustomevent",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-69",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.logEvent(vendor, event)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-44",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"vendor"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"Name of the namespace (vendor) used to prefix the event"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"event"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"Name of the event"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-59",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"compareimages",children:"compareImages"}),"\n",(0,n.jsxs)(i.p,{children:["Compare two images using the specified mode of comparison. ",(0,n.jsx)(i.em,{children:(0,n.jsxs)(i.strong,{children:["Using this command in Appium 2 or later requires installing the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium/tree/master/packages/images-plugin",children:(0,n.jsx)(i.code,{children:"images"})})," plugin."]})}),(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/plugins/#compareimages",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-70",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.compareImages(mode, firstImage, secondImage, options)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-45",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"mode"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"One of possible comparison modes: 'matchFeatures', 'getSimilarity', 'matchTemplate'."})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"firstImage"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"Base64-encoded image file."})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"secondImage"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"Base64-encoded image file."})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"options=[object Object]"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"object"})}),(0,n.jsxs)(i.td,{children:["The supported values of this property depend on the ",(0,n.jsx)(i.code,{children:"mode"})," value. See Appium documentation for more details."]})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-29",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<object>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"result"})}),":"]})," The content of the resulting dictionary depends on the ",(0,n.jsx)(i.code,{children:"mode"}
1)," and ",(0,n.jsx)(i.code,{children:"options"})," values. See Appium documentation for more details."]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"implicitwait",children:"implicitWait"}),"\n",(0,n.jsxs)(i.p,{children:["Set the amount of time the driver should wait when searching for elements. When searching for a single element, the driver should poll the page until an element is found or the timeout expires, whichever occurs first. When searching for multiple elements, the driver should poll the page until at least one element is found or the timeout expires, at which point it should return an empty list. If this command is never sent, the driver should default to an implicit wait of 0ms.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use ",(0,n.jsx)(i.code,{children:"driver.setTimeouts(...)"})," instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-71",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.implicitWait(ms)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-46",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"ms"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"The amount of time, in milliseconds, to wait on an element."})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-60",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getlocationinview",children:"getLocationInView"}),"\n",(0,n.jsxs)(i.p,{children:["Determine an element's location on the screen once it has been scrolled into view.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),(0,n.jsx)(i.strong,{children:"Note:"})," This is considered an internal command and should only be used to determine an element's location for correctly generating native events.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use ",(0,n.jsx)(i.code,{children:"driver.getElementRect(...)"})," or ",(0,n.jsx)(i.code,{children:"element.getLocation()"})," instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-72",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getLocationInView(elementId)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-47",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"elementId"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"String"})}),(0,n.jsx)(i.td,{children:"ID of the element to route the command to"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-30",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<Object>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"location"})}),":"]})," The X and Y coordinates for the element on the page."]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-61",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"sendkeys",children:"sendKeys"}),"\n",(0,n.jsxs)(i.p,{children:["Send a sequence of key strokes to the active element",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}
1),"Use ",(0,n.jsx)(i.code,{children:"driver.performActions(...)"})," with ",(0,n.jsx)(i.code,{children:"keyUp"})," and ",(0,n.jsx)(i.code,{children:"keyDown"})," actions instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-73",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.sendKeys(value)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-48",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"value"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string[]"})}),(0,n.jsx)(i.td,{children:"The sequence of keys to type. An array must be provided."})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-62",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"availableimeengines",children:"availableIMEEngines"}),"\n",(0,n.jsxs)(i.p,{children:["List all available IME engines on the device. To use an engine, it has to be present in this list.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/jsonwp/#availableimeengines",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-74",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.availableIMEEngines()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-31",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<String[]>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"engines"})}),":"]})," A list of available engines"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-63",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getactiveimeengine",children:"getActiveIMEEngine"}),"\n",(0,n.jsxs)(i.p,{children:["Get the name of the active IME engine. The name string is platform specific.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/jsonwp/#getactiveimeengine",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-75",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getActiveIMEEngine()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-32",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<String>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"engine"})}),":"]})," The name of the active IME engine"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-64",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"isimeactivated",children:"isIMEActivated"}),"\n",(0,n.jsxs)(i.p,{children:["Indicates whether IME input is active at the moment",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/jsonwp/#isimeactivated",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-76",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.isIMEActivated()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-33",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<Boolean>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"isActive"})}),":"]})," true if IME input is available and currently active, false otherwise"]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-65",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"deactivateimeengine",children:"deactivateIMEEngine"}),"\n",(0,n.jsxs)(i.p,{children:["De-activates the currently-active IME engine.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/jsonwp/#deactivateimeengine",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-77",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.deactivateIMEEngine()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"support-66",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"activateimeengine",children:"activateIMEEngine"}),"\n",(0,n.jsxs)(i.p,{children:["Activates an IME engine.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/jsonwp/#activateimeengine",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-78",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.activateIMEEngine(engine)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-49",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"engine"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"name of the engine to activate"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-67",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"asyncscripttimeout",children:"asyncScriptTimeout"}),"\n",(0,n.jsxs)(i.p,{children:["Set the amount of time, in milliseconds, that asynchronous scripts executed by ",(0,n.jsx)(i.code,{children:"/session/:sessionId/execute_async"})," are permitted to run before they are aborted and a ",(0,n.jsx)(i.code,{children:"Timeout"})," error is returned to the client.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use ",(0,n.jsx)(i.code,{children:"driver.setTimeouts(...)"})," instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-79",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.asyncScriptTimeout(ms)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-50",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"ms"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"The amount of time, in milliseconds, that time-limited commands are permitted to run"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-68",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"submit",children:"submit"}),"\n",(0,n.jsxs)(i.p,{children:["Submit a form element.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Please explicitly find and click the submit element"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-80",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.submit(elementId)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-51",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"elementId"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"String"})}),(0,n.jsx)(i.td,{children:"ID of the form element to be submitted"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-69",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getelementsize",children:"getElementSize"}),"\n",(0,n.jsxs)(i.p,{children:["Determine an element's size in pixels. The size will be returned as a JSON object with ",(0,n.jsx)(i.code,{children:"width"})," and ",(0,n.jsx)(i.code,{children:"height"})," properties.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use ",(0,n.jsx)(i.code,{children:"driver.getElementRect(...)"})," or ",(0,n.jsx)(i.code,{children:"element.getSize()"})," instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-81",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getElementSize(elementId)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-52",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"elementId"})}
1),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"String"})}),(0,n.jsx)(i.td,{children:"ID of the element to route the command to"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-34",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<Object>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"size"})}),":"]})," The width and height of the element, in pixels."]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-70",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getelementlocation",children:"getElementLocation"}),"\n",(0,n.jsxs)(i.p,{children:["Determine an element's location on the page. The point ",(0,n.jsx)(i.code,{children:"(0, 0)"})," refers to the upper-left corner of the page. The element's coordinates are returned as a JSON object with ",(0,n.jsx)(i.code,{children:"x"})," and ",(0,n.jsx)(i.code,{children:"y"})," properties.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use ",(0,n.jsx)(i.code,{children:"driver.getElementRect(...)"})," or ",(0,n.jsx)(i.code,{children:"element.getLocation()"})," instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-82",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getElementLocation(elementId)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-53",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"elementId"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"String"})}),(0,n.jsx)(i.td,{children:"ID of the element to route the command to"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-35",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<Object>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"location"})}),":"]})," The X and Y coordinates for the element on the page."]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-71",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"touchclick",children:"touchClick"}),"\n",(0,n.jsxs)(i.p,{children:["Single tap on the touch enabled device.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}
1),"Use ",(0,n.jsx)(i.code,{children:"driver.performActions(...)"})," with ",(0,n.jsx)(i.code,{children:"pointerDown"})," and ",(0,n.jsx)(i.code,{children:"pointerUp"})," actions instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-83",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.touchClick(element)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-54",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"element"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"ID of the element to single tap on."})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-72",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"touchdown",children:"touchDown"}),"\n",(0,n.jsxs)(i.p,{children:["Finger down on the screen.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use ",(0,n.jsx)(i.code,{children:"driver.performActions(...)"})," with a ",(0,n.jsx)(i.code,{children:"pointerDown"})," action instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-84",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.touchDown(x, y)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-55",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"x"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"x coordinate on the screen"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"y"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"y coordinate on the screen"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-73",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"touchup",children:"touchUp"}),"\n",(0,n.jsxs)(i.p,{children:["Finger up on the screen.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use ",(0,n.jsx)(i.code,{children:"driver.performActions(...)"})," with a ",(0,n.jsx)(i.code,{children:"pointerUp"})," action instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-85",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.touchUp(x, y)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-56",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"x"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"x coordinate on the screen"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"y"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"y coordinate on the screen"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-74",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"touchmove",children:"touchMove"}),"\n",(0,n.jsxs)(i.p,{children:["Finger move on the screen.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use ",(0,n.jsx)(i.code,{children:"driver.performActions(...)"})," with a ",(0,n.jsx)(i.code,{children:"pointerMove"})," action instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-86",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.touchMove(x, y)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-57",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"x"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"x coordinate on the screen"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"y"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"y coordinate on the screen"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-75",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"touchlongclick",children:"touchLongClick"}),"\n",(0,n.jsxs)(i.p,{children:["Long press on the touch screen using finger motion events.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use ",(0,n.jsx)(i.code,{children:"driver.performActions(...)"})," with ",(0,n.jsx)(i.code,{children:"pointerDown"}),", ",(0,n.jsx)(i.code,{children:"pause"})," and ",(0,n.jsx)(i.code,{children:"pointerUp"})," actions instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-87",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.touchLongClick(element)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-58",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.co
1de,{children:"element"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"ID of the element to long press on"})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-76",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"touchflick",children:"touchFlick"}),"\n",(0,n.jsxs)(i.p,{children:["Flick on the touch screen using finger motion events. This flick command starts at a particular screen location.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.admonition,{type:"caution",children:(0,n.jsxs)(i.p,{children:["This protocol command is deprecated",(0,n.jsx)("br",{}),"Use ",(0,n.jsx)(i.code,{children:"driver.performActions(...)"})," with ",(0,n.jsx)(i.code,{children:"pointerDown"}),", ",(0,n.jsx)(i.code,{children:"pointerMove"})," and ",(0,n.jsx)(i.code,{children:"pointerUp"})," actions instead"]})}),"\n",(0,n.jsx)(i.h3,{id:"usage-88",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.touchFlick(xoffset, yoffset, element, speed, xspeed, yspeed)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-59",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsxs)(i.tbody,{children:[(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"xoffset"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"the x offset in pixels to flick by"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"yoffset"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"the y offset in pixels to flick by"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"element"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsx)(i.td,{children:"ID of the element where the flick starts"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"speed"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"the speed in pixels per seconds"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"xspeed"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"the x speed in pixels per second"})]}),(0,n.jsxs)(i.tr,{children:[(0,n.jsxs)(i.td,{children:[(0,n.jsx)(i.code,{children:"yspeed"}),(0,n.jsx)("br",{}),(0,n.jsx)(i.em,{children:"optional"})]}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"number"})}),(0,n.jsx)(i.td,{children:"the y speed in pixels per second"})]})]})]}),"\n",(0,n.jsx)(i.h3,{id:"support-77",children:"Support"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getorientation",children:"getOrientation"}),"\n",(0,n.jsxs)(i.p,{children:["Get the current device orientation.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/jsonwp/#getorientation",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-89",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getOrientation()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-36",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<String>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"orientation"})}),":"]})," The current orientation corresponding to a value defined in ScreenOrientation: ",(0,n.jsx)(i.code,{children:"LANDSCAPE|PORTRAIT"}),"."]}),"\n"]}),"\n",(0,n.jsx)(i.h3,{id:"support-78",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"setorientation",children:"setOrientation"}),"\n",(0,n.jsxs)(i.p,{children:["Set the device orientation",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/jsonwp/#setorientation",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-90",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.setOrientation(orientation)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-60",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"orientation"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"string"})}),(0,n.jsxs)(i.td,{children:["the new browser orientation as defined in ScreenOrientation: ",(0,n.jsx)(i.code,{children:"LANDSCAPE|PORTRAIT"})]})]})})]}),"\n",(0,n.jsx)(i.h3,{id:"support-79",children:"Support"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.img,{alt:"Support for UiAutomator (4.2+)",src:s(32385).A+"",width:"512",height:"512"}),"\n",(0,n.jsx)(i.img,{alt:"Support for XCUITest (9.3+)",src:s(28491).A+"",width:"496",height:"609"})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Android:"})," UiAutomator (4.2+)"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"iOS:"})," XCUITest (9.3+)"]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getgeolocation",children:"getGeoLocation"}),"\n",(0,n.jsxs)(i.p,{children:["Get the current geo location.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/jsonwp/#getgeolocation",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-91",children:"Usage"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.getGeoLocation()\n"})}),"\n",(0,n.jsx)(i.h3,{id:"returns-37",children:"Returns"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"<Object>"}),"\n",(0,n.jsxs)(i.strong,{children:[(0,n.jsx)("code",{children:(0,n.jsx)("var",{children:"location"})}),":"]})," The current geo location."]}),"\n"]}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"setgeolocation",children:"setGeoLocation"}),"\n",(0,n.jsxs)(i.p,{children:["Set the current geo location.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Appium command. More details can be found in the ",(0,n.jsx)(i.a,{href:"https://appium.io/docs/en/latest/reference/api/jsonwp/#setgeolocation",children:"official protocol docs"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"usage-92",children:"Usage"}
1),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-js",children:"await driver.setGeoLocation(location)\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-61",children:"Parameters"}),"\n",(0,n.jsxs)(i.table,{children:[(0,n.jsx)(i.thead,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.th,{children:"Name"}),(0,n.jsx)(i.th,{children:"Type"}),(0,n.jsx)(i.th,{children:"Details"})]})}),(0,n.jsx)(i.tbody,{children:(0,n.jsxs)(i.tr,{children:[(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"location"})}),(0,n.jsx)(i.td,{children:(0,n.jsx)(i.code,{children:"object"})}),(0,n.jsxs)(i.td,{children:["the new location (",(0,n.jsx)(i.code,{children:"{latitude: number, longitude: number, altitude: number}"}),")"]})]})})]})]})}function h(e={}){const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},28491:(e,i,s)=>{s.d(i,{A:()=>r});const r="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iaXNvLTg4NTktMSI/Pgo8IS0tIEdlbmVyYXRvcjogQWRvYmUgSWxsdXN0cmF0b3IgMTYuMC4wLCBTVkcgRXhwb3J0IFBsdWctSW4gLiBTVkcgVmVyc2lvbjogNi4wMCBCdWlsZCAwKSAgLS0+CjwhRE9DVFlQRSBzdmcgUFVCTElDICItLy9XM0MvL0RURCBTVkcgMS4xLy9FTiIgImh0dHA6Ly93d3cudzMub3JnL0dyYXBoaWNzL1NWRy8xLjEvRFREL3N2ZzExLmR0ZCI+CjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iRWJlbmVfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiCgkgd2lkdGg9IjQ5Ni4yNTVweCIgaGVpZ2h0PSI2MDguNzI4cHgiIHZpZXdCb3g9IjAgMCA0OTYuMjU1IDYwOC43MjgiIHN0eWxlPSJlbmFibGUtYmFja2dyb3VuZDpuZXcgMCAwIDQ5Ni4yNTUgNjA4LjcyODsiCgkgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI+CjxwYXRoIHN0eWxlPSJmaWxsOiM5OTk5OTk7IiBkPSJNMjczLjgxLDUyLjk3M0MzMTMuODA2LDAuMjU3LDM2OS40MSwwLDM2OS40MSwwczguMjcxLDQ5LjU2Mi0zMS40NjMsOTcuMzA2CgljLTQyLjQyNiw1MC45OC05MC42NDksNDIuNjM4LTkwLjY0OSw0Mi42MzhTMjM4LjI0Myw5OS44NSwyNzMuODEsNTIuOTczeiIvPgo8cGF0aCBzdHlsZT0iZmlsbDojOTk5OTk5OyIgZD0iTTI1Mi4zODUsMTc0LjY2MmMyMC41NzYsMCw1OC43NjQtMjguMjg0LDEwOC40NzEtMjguMjg0Yzg1LjU2MiwwLDExOS4yMjIsNjAuODgzLDExOS4yMjIsNjAuODgzCglzLTY1LjgzMywzMy42NTktNjUuODMzLDExNS4zMzFjMCw5Mi4xMzMsODIuMDEsMTIzLjg4NSw4Mi4wMSwxMjMuODg1cy01Ny4zMjgsMTYxLjM1Ny0xMzQuNzYyLDE2MS4zNTcKCWMtMzUuNTY1LDAtNjMuMjE1LTIzLjk2Ny0xMDAuNjg4LTIzLjk2N2MtMzguMTg4LDAtNzYuMDg0LDI0Ljg2MS0xMDAuNzY2LDI0Ljg2MUM4OS4zMyw2MDguNzMsMCw0NTUuNjY2LDAsMzMyLjYyOAoJYzAtMTIxLjA1Miw3NS42MTItMTg0LjU1NCwxNDYuNTMzLTE4NC41NTRDMTkyLjYzOCwxNDguMDc0LDIyOC40MTYsMTc0LjY2MiwyNTIuMzg1LDE3NC42NjJ6Ii8+Cjwvc3ZnPgo="},29403:(e,i,s)=>{s.d(i,{A:()=>r});const r="data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA4OCA4OCI+PHBhdGggZD0ibTAgMTIuNDAyIDM1LjY4Ny00Ljg2MDIuMDE1NiAzNC40MjMtMzUuNjcuMjAzMTN6bTM1LjY3IDMzLjUyOS4wMjc3IDM0LjQ1My0zNS42Ny00LjkwNDEtLjAwMi0yOS43OHptNC4zMjYxLTM5LjAyNSA0Ny4zMTgtNi45MDZ2NDEuNTI3bC00Ny4zMTguMzc1NjV6bTQ3LjMyOSAzOS4zNDktLjAxMTEgNDEuMzQtNDcuMzE4LTYuNjc4NC0uMDY2My0zNC43Mzl6IiBmaWxsPSIjMDBhZGVmIi8+PC9zdmc+"},32385:(e,i,s)=>{s.d(i,{A:()=>r});const r=s.p+"assets/images/android-d941e94d5839760141de31c8446b67ce.svg"}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.