Appium

getAppiumContext

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getAppiumContext()

Returnerar

• <Context> context: en sträng som representerar den aktuella kontexten eller null som representerar 'ingen kontext'

---

switchAppiumContext

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.switchAppiumContext(name)

Parametrar

Namn	Typ	Detaljer
name	string	en sträng som representerar en tillgänglig kontext

---

getAppiumContexts

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getAppiumContexts()

Returnerar

• <Context[]> contexts: en array av strängar som representerar tillgängliga kontexter, t.ex. 'WEBVIEW' eller 'NATIVE'

---

shake

Utför en skakningsåtgärd på enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.shake()

Stöd

---

lock

Lås enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.lock(seconds)

Parametrar

Namn	Typ	Detaljer
seconds frivillig	number	hur länge skärmen ska låsas (endast iOS)

Stöd

---

unlock

Lås upp enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.unlock()

Stöd

---

isLocked

Kontrollera om enheten är låst eller inte.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.isLocked()

Returnerar

• <boolean> isLocked: True om enheten är låst, false om inte

Stöd

---

startRecordingScreen

Börja spela in skärmen.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.startRecordingScreen(options)

Parametrar

Namn	Typ	Detaljer
options frivillig	object	kommandoparametrar som kan innehålla nycklar som: remotePath, username, password, method, forceRestart, timeLimit, videoType, videoQuality, videoFps, bitRate, videoSize, bugReport (se mer beskrivning i Appium-dokumentationen)

Stöd

---

stopRecordingScreen

Avsluta skärminspelning

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.stopRecordingScreen(remotePath, username, password, method)

Parametrar

Namn	Typ	Detaljer
remotePath frivillig	string	Sökvägen till fjärrplatsen, där den resulterande videon ska laddas upp. Följande protokoll stöds http/https, ftp. Detta alternativ har endast effekt om det finns en skärminspelningsprocess pågående och forceRestart-parametern inte är inställd på true. Null eller tom sträng värde (standardinställningen) betyder att innehållet i resultatfilen ska kodas som Base64.
username frivillig	string	Namnet på användaren för fjärrauthentisering.
password frivillig	string	Lösenordet för fjärrauthentisering.
method frivillig	string	HTTP-multipart uppladdningsmetodnamn. 'PUT' används som standard.

Returnerar

• <string> response: Base64-kodad sträng. Om remote_path är inställt är svaret en tom sträng

Stöd

---

getPerformanceDataTypes

Returnerar informationstyper om systemets tillstånd som stöds för att läsa som cpu, minne, nätverkstrafik och batteri.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getPerformanceDataTypes()

Returnerar

• <string[]> performanceTypes: De tillgängliga prestandadatatyperna (cpuinfo|batteryinfo|networkinfo|memoryinfo)

Stöd

---

getPerformanceData

Returnerar information om systemets tillstånd som stöds för att läsa som cpu, minne, nätverkstrafik och batteri.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getPerformanceData(packageName, dataType, dataReadTimeout)

Parametrar

Namn	Typ	Detaljer
packageName	string	paketnamnet för applikationen
dataType	string	typen av systemtillstånd som ska läsas. Det bör vara en av de stödda prestandadatatyperna
dataReadTimeout frivillig	number	antalet försök att läsa

Returnerar

• <string[]> performanceData: Informationstypen för systemets tillstånd som stöds för att läsa som cpu, minne, nätverkstrafik och batteri

Stöd

---

pressKeyCode

Tryck på en särskild tangent på enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.pressKeyCode(keycode, metastate, flags)

Parametrar

Namn	Typ	Detaljer
keycode	number	tangentbordskod att trycka på
metastate frivillig	number	meta-tillstånd att trycka på tangentbordskoden med
flags frivillig	number	flaggor för knapptryckningen

Stöd

---

longPressKeyCode

Tryck och håll en specifik tangentkod på enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.longPressKeyCode(keycode, metastate, flags)

Parametrar

Namn	Typ	Detaljer
keycode	number	tangentkod att trycka på enheten
metastate frivillig	number	metatillstånd för knapptryckningen
flags frivillig	number	flaggor för knapptryckningen

Stöd

---

sendKeyEvent

Skicka en tangentkod till enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.sendKeyEvent(keycode, metastate)

Parametrar

Namn	Typ	Detaljer
keycode	string	tangentkod att trycka på
metastate frivillig	string	meta-tillstånd att trycka på tangentbordskoden med

Stöd

---

rotateDevice

Rotera enheten i tre dimensioner.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.rotateDevice(x, y, z)

Parametrar

Namn	Typ	Detaljer
x	number	x-offset att använda för mitten av roteringsgestens centrum
y	number	y-offset att använda för mitten av roteringsgestens centrum
z	number	z-offset att använda för mitten av roteringsgestens centrum

Stöd

---

getCurrentActivity

Hämta namnet på den aktuella Android-aktiviteten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getCurrentActivity()

Returnerar

• <string> activity: Namn på den aktuella aktiviteten

Stöd

---

getCurrentPackage

Hämta namnet på det aktuella Android-paketet.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getCurrentPackage()

Returnerar

• <string> package: Namn på det aktuella paketet

Stöd

---

installApp

Installera den angivna appen på enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.installApp(appPath)

Parametrar

Namn	Typ	Detaljer
appPath	string	sökväg till programfilen .apk

Stöd

---

activateApp

Aktivera den givna appen på enheten

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.activateApp(appId)

Parametrar

Namn	Typ	Detaljer
appId	string	App-ID (paket-ID för Android, bundle-ID för iOS)

Stöd

---

removeApp

Ta bort en app från enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.removeApp(appId)

Parametrar

Namn	Typ	Detaljer
appId	string	App-ID (paket-ID för Android, bundle-ID för iOS)

Stöd

---

terminateApp

Avsluta den angivna appen på enheten

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.terminateApp(appId, options)

Parametrar

Namn	Typ	Detaljer
appId	string	App-ID (paket-ID för Android, bundle-ID för iOS)
options frivillig	object	Kommandoalternativ. T.ex. "timeout": (Endast Android) Timeout för att försöka avsluta appen igen (se mer i Appium-dokumentationen)

Stöd

---

isAppInstalled

Kontrollera om den angivna appen är installerad på enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.isAppInstalled(appId)

Parametrar

Namn	Typ	Detaljer
appId	string	App-ID (paket-ID för Android, bundle-ID för iOS)

Returnerar

• <boolean> isAppInstalled: Returnerar true om installerad, false om inte

Stöd

---

queryAppState

Hämta den givna appens status på enheten

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.queryAppState(appId)

Parametrar

Namn	Typ	Detaljer
appId	string	App-ID (paket-ID för Android, bundle-ID för iOS)

Returnerar

• <number> appStatus: 0 är inte installerad. 1 är inte igång. 2 körs i bakgrunden eller suspenderad. 3 körs i bakgrunden. 4 körs i förgrunden

Stöd

---

hideKeyboard

Dölj tangentbordet.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.hideKeyboard(strategy, key, keyCode, keyName)

Parametrar

Namn	Typ	Detaljer
strategy frivillig	string	dölj tangentbordsstrategi (endast UIAutomation), tillgängliga strategier - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'
key frivillig	string	nyckelvärde om strategin är 'pressKey'
keyCode frivillig	string	nyckelkod om strategin är 'pressKey'
keyName frivillig	string	nyckelnamn om strategin är 'pressKey'

Stöd

---

isKeyboardShown

Om det mjuka tangentbordet visas eller inte.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.isKeyboardShown()

Returnerar

• <boolean> isKeyboardShown: True om tangentbordet visas

Stöd

---

pushFile

Placera en fil på enheten på en särskild plats.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.pushFile(path, data)

Parametrar

Namn	Typ	Detaljer
path	string	sökväg för att installera datan till
data	string	innehållet i filen i base64

Stöd

---

pullFile

Hämta en fil från enhetens filsystem.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.pullFile(path)

Parametrar

Namn	Typ	Detaljer
path	string	sökväg på enheten att hämta fil från

Returnerar

• <string> response: Innehåll i filen i base64

Stöd

---

pullFolder

Hämta en mapp från enhetens filsystem.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.pullFolder(path)

Parametrar

Namn	Typ	Detaljer
path	string	sökväg till en hel mapp på enheten

Stöd

---

toggleAirplaneMode

Växla flygplansläge på enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.toggleAirplaneMode()

Stöd

---

toggleData

Växla tillståndet för datatjänsten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.toggleData()

Stöd

---

toggleWiFi

Växla tillståndet för WiFi-tjänsten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.toggleWiFi()

Stöd

---

toggleLocationServices

Växla tillståndet för platstjänsten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.toggleLocationServices()

Stöd

---

toggleNetworkSpeed

Ställ in nätverkshastighet (endast emulator)

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.toggleNetworkSpeed(netspeed)

Parametrar

Namn	Typ	Detaljer
netspeed	string	Nätverkstyp - 'full','gsm', 'edge', 'hscsd', 'gprs', 'umts', 'hsdpa', 'lte', 'evdo'

Stöd

---

openNotifications

Öppna Android-aviseringar (endast emulator).

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.openNotifications()

Stöd

---

startActivity

Starta en Android-aktivitet genom att ange paketnamn och aktivitetsnamn.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.startActivity(appPackage, appActivity, appWaitPackage, appWaitActivity, intentAction, intentCategory, intentFlags, optionalIntentArguments, dontStopAppOnReset)

Parametrar

Namn	Typ	Detaljer
appPackage	string	appens namn
appActivity	string	aktivitetens namn
appWaitPackage frivillig	string	namn på app att vänta på
appWaitActivity frivillig	string	namn på aktivitet att vänta på
intentAction=android.intent.action.MAIN frivillig	string	intent-åtgärd som används för att starta aktiviteten
intentCategory=android.intent.category.LAUNCHER frivillig	string	intent-kategori som används för att starta aktiviteten
intentFlags=0x10200000 frivillig	string	flaggor som används för att starta aktiviteten
optionalIntentArguments frivillig	string	ytterligare intent-argument som används för att starta aktiviteten
dontStopAppOnReset frivillig	string	stoppar inte processen för appen som testas, innan appen startas med adb

Stöd

---

getSystemBars

Hämta synlighets- och begränsningsinformation för status- och navigeringsfälten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getSystemBars()

Returnerar

• <object[]> systemBars: Information om synlighet och gränser för status- och navigeringsfält

Stöd

---

getDeviceTime

Hämta tiden på enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getDeviceTime()

Returnerar

• <string> time: Tid på enheten

Stöd

---

getDisplayDensity

Hämta skärmens densitet från enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getDisplayDensity()

Returnerar

• <*>

Stöd

---

touchId

Simulera en touch id-händelse (endast iOS Simulator). För att aktivera denna funktion måste desired capability allowTouchIdEnroll vara inställd på true och Simulatorn måste vara registrerad. När du ställer in allowTouchIdEnroll till true, kommer det att sätta Simulatorn till att vara registrerad som standard. Registreringstillståndet kan växlas. Detta anrop fungerar endast om Appium-processen eller dess föräldraapplikation (t.ex. Terminal.app eller Appium.app) har tillgång till Mac OS-tillgänglighet i Systeminställningar > Säkerhet och integritet > Integritet > Tillgänglighet-listan.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.touchId(match)

Parametrar

Namn	Typ	Detaljer
match	boolean	simulerar vi en lyckad touch (true) eller en misslyckad touch (false)

Stöd

---

toggleEnrollTouchId

Växla simulatorn mellan att vara registrerad för att acceptera touchId (endast iOS Simulator). För att aktivera denna funktion måste desired capability allowTouchIdEnroll vara inställd på true. När allowTouchIdEnroll är inställd på true kommer Simulatorn att registreras som standard, och 'Toggle Touch ID Enrollment' ändrar registreringstillståndet. Detta anrop fungerar endast om Appium-processen eller dess föräldraapplikation (t.ex. Terminal.app eller Appium.app) har tillgång till Mac OS-tillgänglighet i Systeminställningar > Säkerhet och integritet > Integritet > Tillgänglighet-listan.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.toggleEnrollTouchId(enabled)

Parametrar

Namn	Typ	Detaljer
enabled=true frivillig	boolean	lika med true om TouchID-registrering ska aktiveras

Stöd

---

launchApp

Starta en app på enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

varning

Detta protokollkommando är föråldrat
För iOS, använd driver.execute('mobile: launchApp', { ... }), och för Android, använd driver.execute('mobile: activateApp', { ... }).

Användning

driver.launchApp()

Stöd

---

closeApp

Stäng en app på enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

varning

Detta protokollkommando är föråldrat
Använd driver.execute('mobile: terminateApp', { ... }) istället

Användning

driver.closeApp()

Stöd

---

background

Skicka den för närvarande körande appen för denna session till bakgrunden.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

varning

Detta protokollkommando är föråldrat
Använd driver.execute('mobile: backgroundApp', { ... }) istället

Användning

driver.background(seconds)

Parametrar

Namn	Typ	Detaljer
seconds=null	number, null	timeout för att återställa appen, om 'null' kommer appen inte att återställas

Stöd

---

endCoverage

Hämta testens täckningsdata.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.endCoverage(intent, path)

Parametrar

Namn	Typ	Detaljer
intent	string	intent att sända
path	string	sökväg till .ec-fil

Stöd

---

getStrings

Hämta app-strängar.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getStrings(language, stringFile)

Parametrar

Namn	Typ	Detaljer
language frivillig	string	språkkod
stringFile frivillig	string	sökväg till strängfilen

Returnerar

• <object> appStrings: alla definierade strängar från en app för det angivna språket och strängfilnamnet

Stöd

---

setValueImmediate

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.setValueImmediate(elementId, text)

Parametrar

Namn	Typ	Detaljer
elementId	String	ID för ett element som returnerades i ett tidigare anrop till Find Element(s)
text	string	text att ange för ett element

Stöd

---

replaceValue

Ersätt värdet för elementet direkt.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.replaceValue(elementId, value)

Parametrar

Namn	Typ	Detaljer
elementId	String	ID för ett element som returnerades i ett tidigare anrop till Find Element(s)
value	string	värde att ersätta på elementet

Stöd

---

getSettings

Hämta de aktuella inställningarna på enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getSettings()

Returnerar

• <object> settings: JSON-hash av alla för närvarande specificerade inställningar, se Settings API

Stöd

---

updateSettings

Uppdatera den aktuella inställningen på enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.updateSettings(settings)

Parametrar

Namn	Typ	Detaljer
settings	object	nyckel/värde-objekt med inställningar att uppdatera

Stöd

---

receiveAsyncResponse

Callback-url för asynkron körning av JavaScript.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.receiveAsyncResponse(response)

Parametrar

Namn	Typ	Detaljer
response	object	svar att ta emot på enheten

Stöd

---

gsmCall

Gör GSM-samtal (endast emulator).

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.gsmCall(phoneNumber, action)

Parametrar

Namn	Typ	Detaljer
phoneNumber	string	telefonnumret att ringa till
action	string	Åtgärden - 'call', 'accept', 'cancel', 'hold'

Stöd

---

gsmSignal

Ställ in GSM-signalstyrka (endast emulator).

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.gsmSignal(signalStrength, signalStrengh)

Parametrar

Namn	Typ	Detaljer
signalStrength	string	signalstyrka i intervallet [0, 4]
signalStrengh frivillig	string	signalstyrka i intervallet [0, 4]. Vänligen sätt även denna parameter med samma värde om du använder Appium v1.11.0 eller lägre (se https://github.com/appium/appium/issues/12234).

Stöd

---

powerCapacity

Ställ in batteriprocenten (endast emulator).

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.powerCapacity(percent)

Parametrar

Namn	Typ	Detaljer
percent	number	procentvärde i intervallet [0, 100]

Stöd

---

powerAC

Ställ in tillståndet för batteriladdaren till ansluten eller inte (endast emulator).

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.powerAC(state)

Parametrar

Namn	Typ	Detaljer
state	string	ange tillståndet. on eller off

Stöd

---

gsmVoice

Ställ in GSM-rösttillstånd (endast emulator).

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.gsmVoice(state)

Parametrar

Namn	Typ	Detaljer
state	string	tillstånd för GSM-röst - 'unregistered', 'home', 'roaming', 'searching', 'denied', 'off', 'on'

Stöd

---

sendSms

Simulera ett SMS-meddelande (endast emulator).

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.sendSms(phoneNumber, message)

Parametrar

Namn	Typ	Detaljer
phoneNumber	string	telefonnumret att skicka SMS till
message	string	SMS-meddelandet

Stöd

---

fingerPrint

Autentisera användare genom att använda deras fingeravtrycksskanningar på stödda emulatorer.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.fingerPrint(fingerprintId)

Parametrar

Namn	Typ	Detaljer
fingerprintId	number	fingeravtryck lagrade i Android Keystore-systemet (från 1 till 10)

Stöd

---

setClipboard

Ställ in innehållet i systemets urklipp

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.setClipboard(content, contentType, label)

Parametrar

Namn	Typ	Detaljer
content	string	Det faktiska Base64-kodade urklippsinnehållet
contentType frivillig	string	Typen av innehåll att hämta. Plaintext, Image, URL. Android stöder endast plaintext
label frivillig	string	Etiketten för urklippsdata för Android

Returnerar

• <string> response: Svar från Appium-servern

Stöd

---

getClipboard

Hämta innehållet i systemets urklipp

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getClipboard(contentType)

Parametrar

Namn	Typ	Detaljer
contentType frivillig	string	Typen av innehåll att hämta. Plaintext, Image, URL. Android stöder endast plaintext

Returnerar

• <string> response: Urklippsinnehåll som base64-kodad sträng eller en tom sträng om urklippet är tomt

Stöd

---

touchPerform

Denna funktionalitet är endast tillgänglig från en ursprunglig kontext. 'Touch Perform' fungerar liknande som de andra enskilda beröringsfunktionerna, förutom att detta låter dig kedja ihop mer än en beröringshändelse som ett kommando. Detta är användbart eftersom Appium-kommandon skickas över nätverket och det finns latens mellan kommandon. Denna latens kan göra vissa beröringsfunktioner omöjliga eftersom vissa interaktioner behöver utföras i en sekvens. Vertikal, till exempel, kräver att du trycker ner, flyttar till en annan y-koordinat och sedan släpper. För att det ska fungera får det inte finnas någon fördröjning mellan interaktionerna.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.touchPerform(actions)

Parametrar

Namn	Typ	Detaljer
actions	object[]	Typen av åtgärd att utföra (t.ex. moveTo, release, press, tap, wait)

Exempel

// do a horizontal swipe by percentage
const startPercentage = 10;
const endPercentage = 90;
const anchorPercentage = 50;

const { width, height } = driver.getWindowSize();
const anchor = height * anchorPercentage / 100;
const startPoint = width * startPercentage / 100;
const endPoint = width * endPercentage / 100;
driver.touchPerform([
  {
    action: 'press',
    options: {
      x: startPoint,
      y: anchor,
    },
  },
  {
    action: 'wait',
    options: {
      ms: 100,
    },
  },
  {
    action: 'moveTo',
    options: {
      x: endPoint,
      y: anchor,
    },
  },
  {
    action: 'release',
    options: {},
  },
]);

Stöd

---

multiTouchPerform

Denna funktionalitet är endast tillgänglig från en ursprunglig kontext. Utför en multiberöringssekvens.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.multiTouchPerform(actions)

Parametrar

Namn	Typ	Detaljer
actions	object[]	Typen av åtgärd att utföra (t.ex. moveTo, release, press, tap, wait)

Stöd

---

executeDriverScript

Detta kommando gör det möjligt för dig att ange ett WebdriverIO-skript som en sträng och överföra det till Appium-servern för lokal körning på själva servern. Detta tillvägagångssätt hjälper till att minimera potentiell latens associerad med varje kommando. För att använda detta kommando med Appium 2.0 måste du ha execute-driver-plugin pluginen installerad.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.executeDriverScript(script, type, timeout)

Parametrar

Namn	Typ	Detaljer
script	string	Skriptet att köra. Det har tillgång till ett 'driver' objekt som representerar en WebdriverIO-session ansluten till den aktuella servern.
type frivillig	string	Språket/ramverket som används i skriptet. För närvarande stöds endast 'webdriverio' och är standard.
timeout frivillig	number	Antalet millisekunder som skriptet ska tillåtas köra innan det avslutas av Appium-servern. Standardvärdet är motsvarande 1 timme.

Returnerar

• <object> result: Ett objekt som innehåller två fält: 'result', som är returvärdet för själva skriptet, och 'logs', som innehåller 3 inre fält, 'log', 'warn' och 'error', som innehåller en array av strängar loggade av console.log, console.warn och console.error i skriptets körning.

---

getEvents

Hämta händelser lagrade i Appium-servern.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getEvents(type)

Parametrar

Namn	Typ	Detaljer
type	string[]	Hämta händelser som filtreras med typen om typen är angiven.

Returnerar

• <object> result: En JSON-hash av händelser som {'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }.

Stöd

---

logEvent

Lagra en anpassad händelse.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.logEvent(vendor, event)

Parametrar

Namn	Typ	Detaljer
vendor	string	Namnet på leverantören. Det kommer att vara vendor i vendor:event.
event	string	Namnet på händelsen. Det kommer att vara event i vendor:event.

Stöd

---

compareImages

Denna funktion genomför bildjämförelser med hjälp av kapaciteterna i OpenCV-ramverket. Observera att för att denna funktionalitet ska fungera måste både OpenCV-ramverket och opencv4nodejs-modulen vara installerade på den maskin där Appium-servern är i drift. Dessutom behöver du ha images-plugin pluginen installerad för att använda denna funktion med Appium 2.0.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.compareImages(mode, firstImage, secondImage, options)

Parametrar

Namn	Typ	Detaljer
mode=matchFeatures	string	En av möjliga jämförelselägen: 'matchFeatures', 'getSimilarity', 'matchTemplate'. 'matchFeatures' är standard.
firstImage	string	En bilddata. Alla bildformat som OpenCV-biblioteket själv accepterar stöds.
secondImage	string	En bilddata. Alla bildformat som OpenCV-biblioteket själv accepterar stöds.
options=[object Object]	object	Innehållet i denna ordbok beror på det faktiska mode-värdet. Se dokumentationen för appium-support-modulen för mer detaljer.

Returnerar

• <object> result: Innehållet i den resulterande ordboken beror på de faktiska värdena för mode och options. Se dokumentationen för appium-support-modulen för mer detaljer.

---

implicitWait

Ange den tid som drivrutinen ska vänta vid sökning efter element. Vid sökning efter ett enskilt element bör drivrutinen avsöka sidan tills ett element hittas eller tidsfristen går ut, beroende på vilket som inträffar först. Vid sökning efter flera element bör drivrutinen avsöka sidan tills minst ett element hittas eller tidsfristen går ut, då den bör returnera en tom lista. Om detta kommando aldrig skickas bör drivrutinen som standard ha en implicit väntan på 0 ms.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.implicitWait(ms)

Parametrar

Namn	Typ	Detaljer
ms	number	Mängden tid i millisekunder att vänta på ett element.

Stöd

---

getLocationInView

Bestäm ett elements position på skärmen efter att det har rullats in i vyn.

Obs: Detta betraktas som ett internt kommando och bör endast användas för att bestämma ett elements position för att korrekt generera ursprungliga händelser.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getLocationInView(elementId)

Parametrar

Namn	Typ	Detaljer
elementId	String	ID för elementet att dirigera kommandot till

Returnerar

• <Object> location: X- och Y-koordinaterna för elementet på sidan.

Stöd

---

sendKeys

Skicka en sekvens av tangenttryckningar till det aktiva elementet

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.sendKeys(value)

Parametrar

Namn	Typ	Detaljer
value	string[]	Sekvensen av tangenter att skriva. En array måste tillhandahållas.

Stöd

---

availableIMEEngines

Lista alla tillgängliga motorer på maskinen. För att använda en motor måste den finnas i denna lista.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.availableIMEEngines()

Returnerar

• <String[]> engines: En lista över tillgängliga motorer

Stöd

---

getActiveIMEEngine

Hämta namnet på den aktiva IME-motorn. Namnsträngen är plattformsspecifik.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getActiveIMEEngine()

Returnerar

• <String> engine: Namnet på den aktiva IME-motorn

Stöd

---

isIMEActivated

Indikerar om IME-inmatning är aktiv för tillfället

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.isIMEActivated()

Returnerar

• <Boolean> isActive: Sant om IME-inmatning är tillgänglig och för närvarande aktiv, falskt annars

Stöd

---

deactivateIMEEngine

Avaktiverar den för närvarande aktiva IME-motorn.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.deactivateIMEEngine()

Stöd

---

activateIMEEngine

Aktivera en tillgänglig motor

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.activateIMEEngine(engine)

Parametrar

Namn	Typ	Detaljer
engine	string	namn på motorn att aktivera

Stöd

---

asyncScriptTimeout

Ange mängden tid, i millisekunder, som asynkrona skript som körs av /session/:sessionId/execute_async tillåts köra innan de avbryts och ett Timeout-fel returneras till klienten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.asyncScriptTimeout(ms)

Parametrar

Namn	Typ	Detaljer
ms	number	Mängden tid, i millisekunder, som tidsbegränsade kommandon tillåts köra

Stöd

---

submit

Skicka in ett formulärelement.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.submit(elementId)

Parametrar

Namn	Typ	Detaljer
elementId	String	ID för formulärelementet som ska skickas in

Stöd

---

getElementSize

Bestäm ett elements storlek i pixlar. Storleken returneras som ett JSON-objekt med width och height egenskaper.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getElementSize(elementId)

Parametrar

Namn	Typ	Detaljer
elementId	String	ID för elementet att dirigera kommandot till

Returnerar

• <Object> size: Bredden och höjden på elementet, i pixlar.

Stöd

---

getElementLocation

Bestäm ett elements position på sidan. Punkten (0, 0) hänvisar till sidans övre vänstra hörn. Elementets koordinater returneras som ett JSON-objekt med x och y egenskaper.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getElementLocation(elementId)

Parametrar

Namn	Typ	Detaljer
elementId	String	ID för elementet att dirigera kommandot till

Returnerar

• <Object> location: X- och Y-koordinaterna för elementet på sidan.

Stöd

---

touchClick

Enkel touch på den touch-aktiverade enheten.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.touchClick(element)

Parametrar

Namn	Typ	Detaljer
element	string	ID för elementet att göra en enkel touch på.

Stöd

---

touchDown

Finger ner på skärmen.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.touchDown(x, y)

Parametrar

Namn	Typ	Detaljer
x	number	x-koordinat på skärmen
y	number	y-koordinat på skärmen

Stöd

---

touchUp

Finger upp från skärmen.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.touchUp(x, y)

Parametrar

Namn	Typ	Detaljer
x	number	x-koordinat på skärmen
y	number	y-koordinat på skärmen

Stöd

---

touchMove

Finger flytta på skärmen.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.touchMove(x, y)

Parametrar

Namn	Typ	Detaljer
x	number	x-koordinat på skärmen
y	number	y-koordinat på skärmen

Stöd

---

touchLongClick

Långt tryck på pekskärmen med fingerhändelser.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.touchLongClick(element)

Parametrar

Namn	Typ	Detaljer
element	string	ID för elementet att göra långt tryck på

Stöd

---

touchFlick

Snabbt svep på pekskärmen med fingerhändelser. Detta snabbsvepskommando börjar på en viss skärmposition.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.touchFlick(xoffset, yoffset, element, speed, xspeed, yspeed)

Parametrar

Namn	Typ	Detaljer
xoffset frivillig	number	x-offset i pixlar att svepa med
yoffset frivillig	number	y-offset i pixlar att svepa med
element frivillig	string	ID för elementet där svepet börjar
speed frivillig	number	hastigheten i pixlar per sekund
xspeed frivillig	number	x-hastigheten i pixlar per sekund
yspeed frivillig	number	y-hastigheten i pixlar per sekund

Stöd

---

getOrientation

Hämta den aktuella enhetsorienteringen.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getOrientation()

Returnerar

• <String> orientation: Den aktuella orienteringen motsvarande ett värde definierat i ScreenOrientation: LANDSCAPE|PORTRAIT.

Stöd

---

setOrientation

Ställ in enhetsorienteringen

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.setOrientation(orientation)

Parametrar

Namn	Typ	Detaljer
orientation	string	den nya webbläsarorienteringen som definieras i ScreenOrientation: LANDSCAPE|PORTRAIT

Stöd

---

getLogs

Hämta loggen för en given loggtyp. Loggbufferten återställs efter varje begäran.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getLogs(type)

Parametrar

Namn	Typ	Detaljer
type	string	loggtypen

Returnerar

• <Object[]> logs: Listan över loggposter.

Stöd

---

getLogTypes

Hämta tillgängliga loggtyper.

Appium-kommando. Mer detaljer finns i officiell protokolldokumentation.

Användning

driver.getLogTypes()

Returnerar

• <String[]> logTypes: Listan över tillgängliga loggtyper.

Stöd