Appium

getAppiumContext

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getAppiumContext()

Restituisce

• <Context> context: una stringa che rappresenta il contesto corrente o null che rappresenta 'nessun contesto'

---

switchAppiumContext

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.switchAppiumContext(name)

Parametri

Nome	Tipo	Dettagli
name	string	una stringa che rappresenta un contesto disponibile

---

getAppiumContexts

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getAppiumContexts()

Restituisce

• <Context[]> contexts: un array di stringhe che rappresentano i contesti disponibili, ad esempio 'WEBVIEW', o 'NATIVE'

---

shake

Esegue un'azione di scuotimento sul dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.shake()

Supporto

---

lock

Blocca il dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.lock(seconds)

Parametri

Nome	Tipo	Dettagli
seconds opzionale	number	per quanto tempo bloccare lo schermo (solo iOS)

Supporto

---

unlock

Sblocca il dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.unlock()

Supporto

---

isLocked

Controlla se il dispositivo è bloccato o meno.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.isLocked()

Restituisce

• <boolean> isLocked: Vero se il dispositivo è bloccato, falso se non lo è

Supporto

---

startRecordingScreen

Inizia a registrare lo schermo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.startRecordingScreen(options)

Parametri

Nome	Tipo	Dettagli
options opzionale	object	parametri di comando che possono contenere chiavi come: remotePath, username, password, method, forceRestart, timeLimit, videoType, videoQuality, videoFps, bitRate, videoSize, bugReport (vedi maggiori descrizioni nella documentazione di Appium)

Supporto

---

stopRecordingScreen

Interrompe la registrazione dello schermo

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

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

Parametri

Nome	Tipo	Dettagli
remotePath opzionale	string	Il percorso della posizione remota dove caricare il video risultante. Sono supportati i seguenti protocolli: http/https, ftp. Questa opzione ha effetto solo se è in corso un processo di registrazione dello schermo e il parametro forceRestart non è impostato su true. Un valore null o una stringa vuota (l'impostazione predefinita) significa che il contenuto del file risultante dovrebbe essere codificato come Base64.
username opzionale	string	Il nome utente per l'autenticazione remota.
password opzionale	string	La password per l'autenticazione remota.
method opzionale	string	Il nome del metodo di caricamento multipart http. Il 'PUT' viene utilizzato di default.

Restituisce

• <string> response: Stringa codificata in Base64. Se remote_path è impostato, la risposta è una stringa vuota

Supporto

---

getPerformanceDataTypes

Restituisce i tipi di informazioni sullo stato del sistema che è possibile leggere, come cpu, memoria, traffico di rete e batteria.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getPerformanceDataTypes()

Restituisce

• <string[]> performanceTypes: I tipi di dati sulle prestazioni disponibili (cpuinfo|batteryinfo|networkinfo|memoryinfo)

Supporto

---

getPerformanceData

Restituisce le informazioni sullo stato del sistema che è possibile leggere, come cpu, memoria, traffico di rete e batteria.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getPerformanceData(packageName, dataType, dataReadTimeout)

Parametri

Nome	Tipo	Dettagli
packageName	string	il nome del pacchetto dell'applicazione
dataType	string	il tipo di stato del sistema che si desidera leggere. Dovrebbe essere uno dei tipi di dati sulle prestazioni supportati
dataReadTimeout opzionale	number	il numero di tentativi di lettura

Restituisce

• <string[]> performanceData: Il tipo di informazione sullo stato del sistema che è possibile leggere come cpu, memoria, traffico di rete e batteria

Supporto

---

pressKeyCode

Premere un tasto particolare sul dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.pressKeyCode(keycode, metastate, flags)

Parametri

Nome	Tipo	Dettagli
keycode	number	keycode da premere
metastate opzionale	number	metastate con cui premere il keycode
flags opzionale	number	flags per la pressione del tasto

Supporto

---

longPressKeyCode

Premere e tenere premuto un particolare codice tasto sul dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.longPressKeyCode(keycode, metastate, flags)

Parametri

Nome	Tipo	Dettagli
keycode	number	keycode da premere sul dispositivo
metastate opzionale	number	metastate per la pressione del tasto
flags opzionale	number	flags per la pressione del tasto

Supporto

---

sendKeyEvent

Invia un codice tasto al dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.sendKeyEvent(keycode, metastate)

Parametri

Nome	Tipo	Dettagli
keycode	string	keycode da premere
metastate opzionale	string	metastate con cui premere il keycode

Supporto

---

rotateDevice

Ruota il dispositivo in tre dimensioni.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.rotateDevice(x, y, z)

Parametri

Nome	Tipo	Dettagli
x	number	offset x da utilizzare per il centro del gesto di rotazione
y	number	offset y da utilizzare per il centro del gesto di rotazione
z	number	offset z da utilizzare per il centro del gesto di rotazione

Supporto

---

getCurrentActivity

Ottieni il nome dell'attività Android corrente.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getCurrentActivity()

Restituisce

• <string> activity: Nome dell'attività corrente

Supporto

---

getCurrentPackage

Ottieni il nome del pacchetto Android corrente.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getCurrentPackage()

Restituisce

• <string> package: Nome del pacchetto corrente

Supporto

---

installApp

Installa l'app data sul dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.installApp(appPath)

Parametri

Nome	Tipo	Dettagli
appPath	string	percorso del file .apk dell'applicazione

Supporto

---

activateApp

Attiva l'app data sul dispositivo

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.activateApp(appId)

Parametri

Nome	Tipo	Dettagli
appId	string	ID dell'app (ID del pacchetto per Android, ID del bundle per iOS)

Supporto

---

removeApp

Rimuove un'app dal dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.removeApp(appId)

Parametri

Nome	Tipo	Dettagli
appId	string	ID dell'app (ID del pacchetto per Android, ID del bundle per iOS)

Supporto

---

terminateApp

Termina l'app data sul dispositivo

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.terminateApp(appId, options)

Parametri

Nome	Tipo	Dettagli
appId	string	ID dell'app (ID del pacchetto per Android, ID del bundle per iOS)
options opzionale	object	Opzioni del comando. Ad esempio "timeout": (Solo Android) Timeout per riprovare a terminare l'app (vedi altro nella documentazione di Appium)

Supporto

---

isAppInstalled

Controlla se l'app specificata è installata sul dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.isAppInstalled(appId)

Parametri

Nome	Tipo	Dettagli
appId	string	ID dell'app (ID del pacchetto per Android, ID del bundle per iOS)

Restituisce

• <boolean> isAppInstalled: Restituisce vero se installata, falso se non lo è

Supporto

---

queryAppState

Ottieni lo stato dell'app data sul dispositivo

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.queryAppState(appId)

Parametri

Nome	Tipo	Dettagli
appId	string	ID dell'app (ID del pacchetto per Android, ID del bundle per iOS)

Restituisce

• <number> appStatus: 0 non è installato. 1 non è in esecuzione. 2 è in esecuzione in background o sospeso. 3 è in esecuzione in background. 4 è in esecuzione in primo piano

Supporto

---

hideKeyboard

Nascondi la tastiera.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

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

Parametri

Nome	Tipo	Dettagli
strategy opzionale	string	strategia per nascondere la tastiera (solo UIAutomation), strategie disponibili - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'
key opzionale	string	valore del tasto se la strategia è 'pressKey'
keyCode opzionale	string	codice del tasto se la strategia è 'pressKey'
keyName opzionale	string	nome del tasto se la strategia è 'pressKey'

Supporto

---

isKeyboardShown

Verifica se la tastiera è mostrata o meno.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.isKeyboardShown()

Restituisce

• <boolean> isKeyboardShown: Vero se la tastiera è mostrata

Supporto

---

pushFile

Inserisce un file sul dispositivo in un determinato luogo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.pushFile(path, data)

Parametri

Nome	Tipo	Dettagli
path	string	percorso dove installare i dati
data	string	contenuto del file in base64

Supporto

---

pullFile

Recupera un file dal file system del dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.pullFile(path)

Parametri

Nome	Tipo	Dettagli
path	string	percorso sul dispositivo da cui prelevare il file

Restituisce

• <string> response: Contenuto del file in base64

Supporto

---

pullFolder

Recupera una cartella dal file system del dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.pullFolder(path)

Parametri

Nome	Tipo	Dettagli
path	string	percorso di un'intera cartella sul dispositivo

Supporto

---

toggleAirplaneMode

Attiva o disattiva la modalità aereo sul dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.toggleAirplaneMode()

Supporto

---

toggleData

Cambia lo stato del servizio dati.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.toggleData()

Supporto

---

toggleWiFi

Cambia lo stato del servizio wifi.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.toggleWiFi()

Supporto

---

toggleLocationServices

Cambia lo stato del servizio di localizzazione.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.toggleLocationServices()

Supporto

---

toggleNetworkSpeed

Imposta la velocità di rete (solo Emulatore)

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.toggleNetworkSpeed(netspeed)

Parametri

Nome	Tipo	Dettagli
netspeed	string	Tipo di rete - 'full','gsm', 'edge', 'hscsd', 'gprs', 'umts', 'hsdpa', 'lte', 'evdo'

Supporto

---

openNotifications

Apri le notifiche Android (solo Emulatore).

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.openNotifications()

Supporto

---

startActivity

Avvia un'attività Android fornendo il nome del pacchetto e il nome dell'attività.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

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

Parametri

Nome	Tipo	Dettagli
appPackage	string	nome dell'app
appActivity	string	nome dell'attività
appWaitPackage opzionale	string	nome dell'app da attendere
appWaitActivity opzionale	string	nome dell'attività da attendere
intentAction=android.intent.action.MAIN opzionale	string	azione intent che verrà utilizzata per avviare l'attività
intentCategory=android.intent.category.LAUNCHER opzionale	string	categoria intent che verrà utilizzata per avviare l'attività
intentFlags=0x10200000 opzionale	string	flag che verranno utilizzati per avviare l'attività
optionalIntentArguments opzionale	string	argomenti intent aggiuntivi che verranno utilizzati per avviare l'attività
dontStopAppOnReset opzionale	string	non interrompe il processo dell'app in fase di test, prima di avviare l'app utilizzando adb

Supporto

---

getSystemBars

Recupera informazioni sulla visibilità e i limiti delle barre di stato e di navigazione.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getSystemBars()

Restituisce

• <object[]> systemBars: Informazioni sulla visibilità e i limiti della barra di stato e di navigazione

Supporto

---

getDeviceTime

Ottieni l'orario sul dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getDeviceTime()

Restituisce

• <string> time: Orario sul dispositivo

Supporto

---

getDisplayDensity

Ottieni la densità dello schermo dal dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getDisplayDensity()

Restituisce

• <*>

Supporto

---

touchId

Simula un evento touch id (solo iOS Simulator). Per abilitare questa funzionalità, la capacità desiderata allowTouchIdEnroll deve essere impostata su true e il Simulator deve essere registrato. Quando imposti allowTouchIdEnroll su true, imposterà il Simulator come registrato di default. Lo stato di registrazione può essere attivato/disattivato. Questa chiamata funzionerà solo se il processo Appium o la sua applicazione principale (ad esempio Terminal.app o Appium.app) ha accesso all'accessibilità di Mac OS in Preferenze di Sistema > Sicurezza e Privacy > Privacy > Accessibilità.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.touchId(match)

Parametri

Nome	Tipo	Dettagli
match	boolean	stiamo simulando un tocco riuscito (vero) o un tocco fallito (falso)

Supporto

---

toggleEnrollTouchId

Attiva/disattiva il simulatore registrato per accettare touchId (solo iOS Simulator). Per abilitare questa funzionalità, la capacità desiderata allowTouchIdEnroll deve essere impostata su true. Quando allowTouchIdEnroll è impostato su true, il Simulator sarà registrato di default, e l'opzione 'Toggle Touch ID Enrollment' modifica lo stato di registrazione. Questa chiamata funzionerà solo se il processo Appium o la sua applicazione principale (ad esempio Terminal.app o Appium.app) ha accesso all'accessibilità di Mac OS in Preferenze di Sistema > Sicurezza e Privacy > Privacy > Accessibilità.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.toggleEnrollTouchId(enabled)

Parametri

Nome	Tipo	Dettagli
enabled=true opzionale	boolean	uguale a true se la registrazione TouchID dovrebbe essere abilitata

Supporto

---

launchApp

Avvia un'app sul dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

attenzione

Questo comando del protocollo è deprecato
Per iOS, utilizza driver.execute('mobile: launchApp', { ... }), e per Android, utilizza driver.execute('mobile: activateApp', { ... }).

Utilizzo

driver.launchApp()

Supporto

---

closeApp

Chiude un'app sul dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

attenzione

Questo comando del protocollo è deprecato
Usa driver.execute('mobile: terminateApp', { ... }) invece

Utilizzo

driver.closeApp()

Supporto

---

background

Invia l'app attualmente in esecuzione per questa sessione in background.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

attenzione

Questo comando del protocollo è deprecato
Usa driver.execute('mobile: backgroundApp', { ... }) invece

Utilizzo

driver.background(seconds)

Parametri

Nome	Tipo	Dettagli
seconds=null	number, null	timeout per ripristinare l'app, se 'null' l'app non sarà ripristinata

Supporto

---

endCoverage

Ottieni i dati di copertura dei test.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.endCoverage(intent, path)

Parametri

Nome	Tipo	Dettagli
intent	string	intent da trasmettere
path	string	percorso al file .ec

Supporto

---

getStrings

Ottieni le stringhe dell'app.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getStrings(language, stringFile)

Parametri

Nome	Tipo	Dettagli
language opzionale	string	codice lingua
stringFile opzionale	string	percorso al file di stringa

Restituisce

• <object> appStrings: tutte le stringhe definite da un'app per la lingua e il nome file di stringhe specificati

Supporto

---

setValueImmediate

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.setValueImmediate(elementId, text)

Parametri

Nome	Tipo	Dettagli
elementId	String	l'id di un elemento restituito in una precedente chiamata a Find Element(s)
text	string	testo da impostare a un elemento

Supporto

---

replaceValue

Sostituisci direttamente il valore dell'elemento.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.replaceValue(elementId, value)

Parametri

Nome	Tipo	Dettagli
elementId	String	l'id di un elemento restituito in una precedente chiamata a Find Element(s)
value	string	valore da sostituire sull'elemento

Supporto

---

getSettings

Recupera le impostazioni correnti sul dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getSettings()

Restituisce

• <object> settings: Hash JSON di tutte le impostazioni attualmente specificate, vedi API Settings

Supporto

---

updateSettings

Aggiorna l'impostazione corrente sul dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.updateSettings(settings)

Parametri

Nome	Tipo	Dettagli
settings	object	oggetto chiave/valore con le impostazioni da aggiornare

Supporto

---

receiveAsyncResponse

URL di callback per l'esecuzione asincrona di JavaScript.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.receiveAsyncResponse(response)

Parametri

Nome	Tipo	Dettagli
response	object	risposta da ricevere sul dispositivo

Supporto

---

gsmCall

Effettua una chiamata GSM (solo Emulatore).

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.gsmCall(phoneNumber, action)

Parametri

Nome	Tipo	Dettagli
phoneNumber	string	il numero di telefono da chiamare
action	string	L'azione - 'call', 'accept', 'cancel', 'hold'

Supporto

---

gsmSignal

Imposta la potenza del segnale GSM (solo Emulatore).

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.gsmSignal(signalStrength, signalStrengh)

Parametri

Nome	Tipo	Dettagli
signalStrength	string	potenza del segnale nell'intervallo [0, 4]
signalStrengh opzionale	string	potenza del segnale nell'intervallo [0, 4]. Si prega di impostare anche questo parametro con lo stesso valore se si utilizza Appium v1.11.0 o inferiore (vedi https://github.com/appium/appium/issues/12234).

Supporto

---

powerCapacity

Imposta la percentuale della batteria (solo Emulatore).

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.powerCapacity(percent)

Parametri

Nome	Tipo	Dettagli
percent	number	valore percentuale nell'intervallo [0, 100]

Supporto

---

powerAC

Imposta lo stato del caricabatterie a collegato o meno (solo Emulatore).

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.powerAC(state)

Parametri

Nome	Tipo	Dettagli
state	string	imposta lo stato. on o off

Supporto

---

gsmVoice

Imposta lo stato della voce GSM (solo Emulatore).

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.gsmVoice(state)

Parametri

Nome	Tipo	Dettagli
state	string	stato della voce GSM - 'unregistered', 'home', 'roaming', 'searching', 'denied', 'off', 'on'

Supporto

---

sendSms

Simula un messaggio SMS (solo Emulatore).

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.sendSms(phoneNumber, message)

Parametri

Nome	Tipo	Dettagli
phoneNumber	string	il numero di telefono a cui inviare l'SMS
message	string	il messaggio SMS

Supporto

---

fingerPrint

Autentica gli utenti utilizzando le scansioni delle impronte digitali sugli emulatori supportati.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.fingerPrint(fingerprintId)

Parametri

Nome	Tipo	Dettagli
fingerprintId	number	impronte digitali memorizzate nel sistema Android Keystore (da 1 a 10)

Supporto

---

setClipboard

Imposta il contenuto degli appunti di sistema

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.setClipboard(content, contentType, label)

Parametri

Nome	Tipo	Dettagli
content	string	Il contenuto effettivo degli appunti codificato in base64
contentType opzionale	string	Il tipo di contenuto da ottenere. Plaintext, Image, URL. Android supporta solo plaintext
label opzionale	string	Etichetta dei dati degli appunti per Android

Restituisce

• <string> response: Risposta dal server Appium

Supporto

---

getClipboard

Ottieni il contenuto degli appunti di sistema

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getClipboard(contentType)

Parametri

Nome	Tipo	Dettagli
contentType opzionale	string	Il tipo di contenuto da ottenere. Plaintext, Image, URL. Android supporta solo plaintext

Restituisce

• <string> response: Contenuto degli appunti come stringa codificata in base64 o una stringa vuota se gli appunti sono vuoti

Supporto

---

touchPerform

Questa funzionalità è disponibile solo all'interno di un contesto nativo. 'Touch Perform' funziona in modo simile alle altre interazioni touch singole, tranne che questa consente di concatenare più di un'azione touch come un unico comando. Questo è utile perché i comandi Appium vengono inviati tramite la rete e c'è latenza tra i comandi. Questa latenza può rendere impossibili certe interazioni touch perché alcune interazioni devono essere eseguite in una sequenza. Il trascinamento verticale, ad esempio, richiede di premere, spostarsi su una coordinata y diversa e poi rilasciare. Perché funzioni, non ci può essere un ritardo tra le interazioni.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.touchPerform(actions)

Parametri

Nome	Tipo	Dettagli
actions	object[]	Il tipo di azione da eseguire (ad esempio moveTo, release, press, tap, wait)

Esempio

// 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: {},
  },
]);

Supporto

---

multiTouchPerform

Questa funzionalità è disponibile solo all'interno di un contesto nativo. Esegue una sequenza di azioni multi-touch.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.multiTouchPerform(actions)

Parametri

Nome	Tipo	Dettagli
actions	object[]	Il tipo di azione da eseguire (ad esempio moveTo, release, press, tap, wait)

Supporto

---

executeDriverScript

Questo comando ti permette di specificare uno script WebdriverIO come stringa e trasmetterlo al server Appium per l'esecuzione locale sul server stesso. Questo approccio aiuta a minimizzare la potenziale latenza associata a ogni comando. Per utilizzare questo comando con Appium 2.0, è necessario avere installato il plugin execute-driver-plugin.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.executeDriverScript(script, type, timeout)

Parametri

Nome	Tipo	Dettagli
script	string	Lo script da eseguire. Ha accesso a un oggetto 'driver' che rappresenta una sessione WebdriverIO collegata al server corrente.
type opzionale	string	Il linguaggio/framework utilizzato nello script. Attualmente, solo 'webdriverio' è supportato ed è il valore predefinito.
timeout opzionale	number	Il numero di millisecondi per cui lo script dovrebbe essere autorizzato a funzionare prima di essere terminato dal server Appium. Il valore predefinito è l'equivalente di 1 ora.

Restituisce

• <object> result: Un oggetto contenente due campi: 'result', che è il valore di ritorno dello script stesso, e 'logs', che contiene 3 campi interni, 'log', 'warn' e 'error', che contengono un array di stringhe registrate da console.log, console.warn e console.error nell'esecuzione dello script.

---

getEvents

Ottieni gli eventi memorizzati nel server appium.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getEvents(type)

Parametri

Nome	Tipo	Dettagli
type	string[]	Ottieni eventi filtrati con il tipo se il tipo è fornito.

Restituisce

• <object> result: Un hash JSON di eventi come {'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }.

Supporto

---

logEvent

Memorizza un evento personalizzato.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.logEvent(vendor, event)

Parametri

Nome	Tipo	Dettagli
vendor	string	Il nome del fornitore. Sarà vendor in vendor:event.
event	string	Il nome dell'evento. Sarà event in vendor:event.

Supporto

---

compareImages

Questa funzionalità conduce confronti di immagini utilizzando le capacità del framework OpenCV. Si noti che per far funzionare questa funzionalità, sia il framework OpenCV che il modulo opencv4nodejs devono essere installati sulla macchina dove è operativo il server Appium. Inoltre, sarà necessario avere installato il plugin images-plugin per utilizzare questa funzionalità con Appium 2.0.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

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

Parametri

Nome	Tipo	Dettagli
mode=matchFeatures	string	Una delle possibili modalità di confronto: 'matchFeatures', 'getSimilarity', 'matchTemplate'. 'matchFeatures' è il valore predefinito.
firstImage	string	Dati dell'immagine. Tutti i formati di immagine che la libreria OpenCV stessa accetta sono supportati.
secondImage	string	Dati dell'immagine. Tutti i formati di immagine che la libreria OpenCV stessa accetta sono supportati.
options=[object Object]	object	Il contenuto di questo dizionario dipende dal valore effettivo di mode. Consultare la documentazione sul modulo appium-support per maggiori dettagli.

Restituisce

• <object> result: Il contenuto del dizionario risultante dipende dai valori effettivi di mode e options. Consultare la documentazione sul modulo appium-support per maggiori dettagli.

---

implicitWait

Imposta la quantità di tempo che il driver dovrebbe attendere durante la ricerca degli elementi. Durante la ricerca di un singolo elemento, il driver dovrebbe interrogare la pagina fino a quando un elemento viene trovato o il timeout scade, a seconda di quale evento si verifica per primo. Durante la ricerca di più elementi, il driver dovrebbe interrogare la pagina fino a quando almeno un elemento viene trovato o il timeout scade, momento in cui dovrebbe restituire un elenco vuoto. Se questo comando non viene mai inviato, il driver dovrebbe impostare un'attesa implicita di 0ms di default.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.implicitWait(ms)

Parametri

Nome	Tipo	Dettagli
ms	number	La quantità di tempo, in millisecondi, da attendere su un elemento.

Supporto

---

getLocationInView

Determina la posizione di un elemento sullo schermo dopo che è stato fatto scorrere in vista.

Nota: Questo è considerato un comando interno e dovrebbe essere utilizzato solo per determinare la posizione di un elemento per generare correttamente eventi nativi.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getLocationInView(elementId)

Parametri

Nome	Tipo	Dettagli
elementId	String	ID dell'elemento a cui indirizzare il comando

Restituisce

• <Object> location: Le coordinate X e Y dell'elemento sulla pagina.

Supporto

---

sendKeys

Invia una sequenza di tasti all'elemento attivo

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.sendKeys(value)

Parametri

Nome	Tipo	Dettagli
value	string[]	La sequenza di tasti da digitare. Deve essere fornito un array.

Supporto

---

availableIMEEngines

Elenca tutti i motori disponibili sulla macchina. Per utilizzare un motore, deve essere presente in questo elenco.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.availableIMEEngines()

Restituisce

• <String[]> engines: Un elenco di motori disponibili

Supporto

---

getActiveIMEEngine

Ottieni il nome del motore IME attivo. La stringa del nome è specifica della piattaforma.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getActiveIMEEngine()

Restituisce

• <String> engine: Il nome del motore IME attivo

Supporto

---

isIMEActivated

Indica se l'input IME è attivo al momento

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.isIMEActivated()

Restituisce

• <Boolean> isActive: Vero se l'input IME è disponibile e attualmente attivo, falso altrimenti

Supporto

---

deactivateIMEEngine

Disattiva il motore IME attualmente attivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.deactivateIMEEngine()

Supporto

---

activateIMEEngine

Attiva un motore che è disponibile

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.activateIMEEngine(engine)

Parametri

Nome	Tipo	Dettagli
engine	string	nome del motore da attivare

Supporto

---

asyncScriptTimeout

Imposta la quantità di tempo, in millisecondi, che gli script asincroni eseguiti da /session/:sessionId/execute_async possono essere eseguiti prima di essere interrotti e un errore Timeout viene restituito al client.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.asyncScriptTimeout(ms)

Parametri

Nome	Tipo	Dettagli
ms	number	La quantità di tempo, in millisecondi, che i comandi limitati nel tempo possono essere eseguiti

Supporto

---

submit

Invia un elemento form.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.submit(elementId)

Parametri

Nome	Tipo	Dettagli
elementId	String	ID dell'elemento form da inviare

Supporto

---

getElementSize

Determina la dimensione di un elemento in pixel. La dimensione sarà restituita come un oggetto JSON con le proprietà width e height.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getElementSize(elementId)

Parametri

Nome	Tipo	Dettagli
elementId	String	ID dell'elemento a cui indirizzare il comando

Restituisce

• <Object> size: La larghezza e l'altezza dell'elemento, in pixel.

Supporto

---

getElementLocation

Determina la posizione di un elemento sulla pagina. Il punto (0, 0) si riferisce all'angolo in alto a sinistra della pagina. Le coordinate dell'elemento vengono restituite come un oggetto JSON con le proprietà x e y.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getElementLocation(elementId)

Parametri

Nome	Tipo	Dettagli
elementId	String	ID dell'elemento a cui indirizzare il comando

Restituisce

• <Object> location: Le coordinate X e Y dell'elemento sulla pagina.

Supporto

---

touchClick

Tap singolo sul dispositivo abilitato al tocco.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.touchClick(element)

Parametri

Nome	Tipo	Dettagli
element	string	ID dell'elemento su cui fare un singolo tap.

Supporto

---

touchDown

Dito giù sullo schermo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.touchDown(x, y)

Parametri

Nome	Tipo	Dettagli
x	number	coordinata x sullo schermo
y	number	coordinata y sullo schermo

Supporto

---

touchUp

Dito su sullo schermo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.touchUp(x, y)

Parametri

Nome	Tipo	Dettagli
x	number	coordinata x sullo schermo
y	number	coordinata y sullo schermo

Supporto

---

touchMove

Movimento del dito sullo schermo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.touchMove(x, y)

Parametri

Nome	Tipo	Dettagli
x	number	coordinata x sullo schermo
y	number	coordinata y sullo schermo

Supporto

---

touchLongClick

Pressione prolungata sullo schermo touch utilizzando gli eventi di movimento delle dita.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.touchLongClick(element)

Parametri

Nome	Tipo	Dettagli
element	string	ID dell'elemento su cui fare una pressione prolungata

Supporto

---

touchFlick

Sfoglia sullo schermo touch utilizzando gli eventi di movimento delle dita. Questo comando di scorrimento inizia in una posizione particolare dello schermo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

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

Parametri

Nome	Tipo	Dettagli
xoffset opzionale	number	l'offset x in pixel da scorrere
yoffset opzionale	number	l'offset y in pixel da scorrere
element opzionale	string	ID dell'elemento da cui inizia lo scorrimento
speed opzionale	number	la velocità in pixel al secondo
xspeed opzionale	number	la velocità x in pixel al secondo
yspeed opzionale	number	la velocità y in pixel al secondo

Supporto

---

getOrientation

Ottieni l'orientamento attuale del dispositivo.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getOrientation()

Restituisce

• <String> orientation: L'orientamento corrente corrispondente a un valore definito in ScreenOrientation: LANDSCAPE|PORTRAIT.

Supporto

---

setOrientation

Imposta l'orientamento del dispositivo

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.setOrientation(orientation)

Parametri

Nome	Tipo	Dettagli
orientation	string	il nuovo orientamento del browser come definito in ScreenOrientation: LANDSCAPE|PORTRAIT

Supporto

---

getLogs

Ottieni il log per un dato tipo di log. Il buffer del log viene reimpostato dopo ogni richiesta.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getLogs(type)

Parametri

Nome	Tipo	Dettagli
type	string	il tipo di log

Restituisce

• <Object[]> logs: L'elenco delle voci di log.

Supporto

---

getLogTypes

Ottieni i tipi di log disponibili.

Comando Appium. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.

Utilizzo

driver.getLogTypes()

Restituisce

• <String[]> logTypes: L'elenco dei tipi di log disponibili.

Supporto