Appium

getAppiumContext

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getAppiumContext()

Devuelve

• <Context> context: una cadena que representa el contexto actual o null que representa 'sin contexto'

---

switchAppiumContext

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.switchAppiumContext(name)

Parámetros

Nombre	Tipo	Detalles
name	string	una cadena que representa un contexto disponible

---

getAppiumContexts

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getAppiumContexts()

Devuelve

• <Context[]> contexts: un array de cadenas que representan contextos disponibles, p. ej. 'WEBVIEW', o 'NATIVE'

---

shake

Realiza una acción de agitar en el dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.shake()

Soporte

---

lock

Bloquea el dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.lock(seconds)

Parámetros

Nombre	Tipo	Detalles
seconds opcional	number	cuánto tiempo bloquear la pantalla (solo iOS)

Soporte

---

unlock

Desbloquea el dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.unlock()

Soporte

---

isLocked

Comprueba si el dispositivo está bloqueado o no.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.isLocked()

Devuelve

• <boolean> isLocked: Verdadero si el dispositivo está bloqueado, falso si no

Soporte

---

startRecordingScreen

Comienza a grabar la pantalla.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.startRecordingScreen(options)

Parámetros

Nombre	Tipo	Detalles
options opcional	object	parámetros de comando que pueden contener claves como: remotePath, username, password, method, forceRestart, timeLimit, videoType, videoQuality, videoFps, bitRate, videoSize, bugReport (ver más descripción en la documentación de Appium)

Soporte

---

stopRecordingScreen

Detiene la grabación de la pantalla

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

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

Parámetros

Nombre	Tipo	Detalles
remotePath opcional	string	La ruta a la ubicación remota, donde se debe cargar el video resultante. Se admiten los siguientes protocolos: http/https, ftp. Esta opción solo tiene efecto si hay un proceso de grabación de pantalla en progreso y el parámetro forceRestart no está configurado en true. Un valor nulo o de cadena vacía (la configuración por defecto) significa que el contenido del archivo resultante debe codificarse como Base64.
username opcional	string	El nombre del usuario para la autenticación remota.
password opcional	string	La contraseña para la autenticación remota.
method opcional	string	El nombre del método de carga multiparte http. Por defecto se usa 'PUT'.

Devuelve

• <string> response: Cadena codificada en Base64. Si remote_path está configurado, la respuesta es una cadena vacía

Soporte

---

getPerformanceDataTypes

Devuelve los tipos de información del estado del sistema que se pueden leer, como cpu, memoria, tráfico de red y batería.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getPerformanceDataTypes()

Devuelve

• <string[]> performanceTypes: Los tipos de datos de rendimiento disponibles (cpuinfo|batteryinfo|networkinfo|memoryinfo)

Soporte

---

getPerformanceData

Devuelve la información del estado del sistema que se puede leer, como cpu, memoria, tráfico de red y batería.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getPerformanceData(packageName, dataType, dataReadTimeout)

Parámetros

Nombre	Tipo	Detalles
packageName	string	el nombre del paquete de la aplicación
dataType	string	el tipo de estado del sistema que se quiere leer. Debe ser uno de los tipos de datos de rendimiento soportados
dataReadTimeout opcional	number	el número de intentos de lectura

Devuelve

• <string[]> performanceData: El tipo de información del estado del sistema que se puede leer, como cpu, memoria, tráfico de red y batería

Soporte

---

pressKeyCode

Pulsa una tecla específica en el dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.pressKeyCode(keycode, metastate, flags)

Parámetros

Nombre	Tipo	Detalles
keycode	number	código de tecla a presionar
metastate opcional	number	estado meta para presionar el código de tecla
flags opcional	number	banderas para la pulsación de tecla

Soporte

---

longPressKeyCode

Presiona y mantiene un código de tecla particular en el dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.longPressKeyCode(keycode, metastate, flags)

Parámetros

Nombre	Tipo	Detalles
keycode	number	código de tecla a presionar en el dispositivo
metastate opcional	number	metaestado para la pulsación de tecla
flags opcional	number	banderas para la pulsación de tecla

Soporte

---

sendKeyEvent

Envía un código de tecla al dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.sendKeyEvent(keycode, metastate)

Parámetros

Nombre	Tipo	Detalles
keycode	string	código de tecla a presionar
metastate opcional	string	estado meta para presionar el código de tecla

Soporte

---

rotateDevice

Rotar el dispositivo en tres dimensiones.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.rotateDevice(x, y, z)

Parámetros

Nombre	Tipo	Detalles
x	number	desplazamiento x para usar en el centro del gesto de rotación
y	number	desplazamiento y para usar en el centro del gesto de rotación
z	number	desplazamiento z para usar en el centro del gesto de rotación

Soporte

---

getCurrentActivity

Obtiene el nombre de la actividad actual de Android.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getCurrentActivity()

Devuelve

• <string> activity: Nombre de la actividad actual

Soporte

---

getCurrentPackage

Obtiene el nombre del paquete Android actual.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getCurrentPackage()

Devuelve

• <string> package: Nombre del paquete actual

Soporte

---

installApp

Instala la aplicación dada en el dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.installApp(appPath)

Parámetros

Nombre	Tipo	Detalles
appPath	string	ruta al archivo de aplicación .apk

Soporte

---

activateApp

Activa la aplicación dada en el dispositivo

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.activateApp(appId)

Parámetros

Nombre	Tipo	Detalles
appId	string	ID de la aplicación (ID del paquete para Android, ID del paquete para iOS)

Soporte

---

removeApp

Elimina una aplicación del dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.removeApp(appId)

Parámetros

Nombre	Tipo	Detalles
appId	string	ID de la aplicación (ID del paquete para Android, ID del paquete para iOS)

Soporte

---

terminateApp

Termina la aplicación dada en el dispositivo

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.terminateApp(appId, options)

Parámetros

Nombre	Tipo	Detalles
appId	string	ID de la aplicación (ID del paquete para Android, ID del paquete para iOS)
options opcional	object	Opciones de comando. Ej. "timeout": (Solo Android) Tiempo de espera para reintentar terminar la aplicación (ver más en la documentación de Appium)

Soporte

---

isAppInstalled

Comprueba si la aplicación especificada está instalada en el dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.isAppInstalled(appId)

Parámetros

Nombre	Tipo	Detalles
appId	string	ID de la aplicación (ID del paquete para Android, ID del paquete para iOS)

Devuelve

• <boolean> isAppInstalled: Devuelve verdadero si está instalada, falso si no

Soporte

---

queryAppState

Obtiene el estado de la aplicación dada en el dispositivo

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.queryAppState(appId)

Parámetros

Nombre	Tipo	Detalles
appId	string	ID de la aplicación (ID del paquete para Android, ID del paquete para iOS)

Devuelve

• <number> appStatus: 0 no está instalada. 1 no está ejecutándose. 2 se está ejecutando en segundo plano o suspendida. 3 se está ejecutando en segundo plano. 4 se está ejecutando en primer plano

Soporte

---

hideKeyboard

Oculta el teclado en pantalla.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

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

Parámetros

Nombre	Tipo	Detalles
strategy opcional	string	estrategia para ocultar el teclado (solo UIAutomation), estrategias disponibles - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'
key opcional	string	valor de la tecla si la estrategia es 'pressKey'
keyCode opcional	string	código de tecla si la estrategia es 'pressKey'
keyName opcional	string	nombre de la tecla si la estrategia es 'pressKey'

Soporte

---

isKeyboardShown

Si el teclado en pantalla se muestra o no.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.isKeyboardShown()

Devuelve

• <boolean> isKeyboardShown: Verdadero si el teclado se muestra

Soporte

---

pushFile

Coloca un archivo en el dispositivo en un lugar particular.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.pushFile(path, data)

Parámetros

Nombre	Tipo	Detalles
path	string	ruta donde instalar los datos
data	string	contenido del archivo en base64

Soporte

---

pullFile

Recupera un archivo del sistema de archivos del dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.pullFile(path)

Parámetros

Nombre	Tipo	Detalles
path	string	ruta en el dispositivo donde extraer el archivo

Devuelve

• <string> response: Contenido del archivo en base64

Soporte

---

pullFolder

Recupera una carpeta del sistema de archivos del dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.pullFolder(path)

Parámetros

Nombre	Tipo	Detalles
path	string	ruta a una carpeta completa en el dispositivo

Soporte

---

toggleAirplaneMode

Alterna el modo avión en el dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.toggleAirplaneMode()

Soporte

---

toggleData

Cambia el estado del servicio de datos.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.toggleData()

Soporte

---

toggleWiFi

Cambia el estado del servicio wifi.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.toggleWiFi()

Soporte

---

toggleLocationServices

Cambia el estado del servicio de ubicación.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.toggleLocationServices()

Soporte

---

toggleNetworkSpeed

Establece la velocidad de red (solo emulador)

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.toggleNetworkSpeed(netspeed)

Parámetros

Nombre	Tipo	Detalles
netspeed	string	Tipo de red - 'full','gsm', 'edge', 'hscsd', 'gprs', 'umts', 'hsdpa', 'lte', 'evdo'

Soporte

---

openNotifications

Abre las notificaciones de Android (solo emulador).

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.openNotifications()

Soporte

---

startActivity

Inicia una actividad de Android proporcionando el nombre del paquete y el nombre de la actividad.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

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

Parámetros

Nombre	Tipo	Detalles
appPackage	string	nombre de la aplicación
appActivity	string	nombre de la actividad
appWaitPackage opcional	string	nombre de la aplicación a esperar
appWaitActivity opcional	string	nombre de la actividad a esperar
intentAction=android.intent.action.MAIN opcional	string	acción de intención que se usará para iniciar la actividad
intentCategory=android.intent.category.LAUNCHER opcional	string	categoría de intención que se usará para iniciar la actividad
intentFlags=0x10200000 opcional	string	banderas que se usarán para iniciar la actividad
optionalIntentArguments opcional	string	argumentos de intención adicionales que se usarán para iniciar la actividad
dontStopAppOnReset opcional	string	no detiene el proceso de la aplicación bajo prueba, antes de iniciar la aplicación usando adb

Soporte

---

getSystemBars

Recupera información de visibilidad y límites de las barras de estado y navegación.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getSystemBars()

Devuelve

• <object[]> systemBars: Información sobre visibilidad y límites de la barra de estado y navegación

Soporte

---

getDeviceTime

Obtiene la hora en el dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getDeviceTime()

Devuelve

• <string> time: Hora en el dispositivo

Soporte

---

getDisplayDensity

Obtiene la densidad de la pantalla del dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getDisplayDensity()

Devuelve

• <*>

Soporte

---

touchId

Simula un evento de touch id (solo simulador iOS). Para habilitar esta función, la capacidad deseada allowTouchIdEnroll debe establecerse en true y el Simulador debe estar inscrito. Cuando estableces allowTouchIdEnroll en true, establecerá el Simulador como inscrito por defecto. El estado de inscripción puede ser alternado. Esta llamada solo funcionará si el proceso de Appium o su aplicación principal (por ejemplo, Terminal.app o Appium.app) tiene acceso a la accesibilidad de Mac OS en Preferencias del Sistema > Seguridad y Privacidad > Privacidad > Accesibilidad.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.touchId(match)

Parámetros

Nombre	Tipo	Detalles
match	boolean	estamos simulando un toque exitoso (true) o un toque fallido (false)

Soporte

---

toggleEnrollTouchId

Alterna el simulador siendo inscrito para aceptar touchId (solo simulador iOS). Para habilitar esta función, la capacidad deseada allowTouchIdEnroll debe establecerse en true. Cuando allowTouchIdEnroll está establecido en true, el Simulador se inscribirá por defecto, y el 'Toggle Touch ID Enrollment' cambia el estado de inscripción. Esta llamada solo funcionará si el proceso de Appium o su aplicación principal (por ejemplo, Terminal.app o Appium.app) tiene acceso a la accesibilidad de Mac OS en Preferencias del Sistema > Seguridad y Privacidad > Privacidad > Accesibilidad.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.toggleEnrollTouchId(enabled)

Parámetros

Nombre	Tipo	Detalles
enabled=true opcional	boolean	igual a true si la inscripción de TouchID debe ser habilitada

Soporte

---

launchApp

Lanza una aplicación en el dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

precaución

Este comando de protocolo está obsoleto
Para iOS, utiliza driver.execute('mobile: launchApp', { ... }), y para Android, utiliza driver.execute('mobile: activateApp', { ... }).

Uso

driver.launchApp()

Soporte

---

closeApp

Cierra una aplicación en el dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

precaución

Este comando de protocolo está obsoleto
Usa driver.execute('mobile: terminateApp', { ... }) en su lugar

Uso

driver.closeApp()

Soporte

---

background

Envía la aplicación actualmente en ejecución para esta sesión al fondo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

precaución

Este comando de protocolo está obsoleto
Usa driver.execute('mobile: backgroundApp', { ... }) en su lugar

Uso

driver.background(seconds)

Parámetros

Nombre	Tipo	Detalles
seconds=null	number, null	tiempo de espera para restaurar la aplicación, si es 'null' la aplicación no se restaurará

Soporte

---

endCoverage

Obtiene datos de cobertura de prueba.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.endCoverage(intent, path)

Parámetros

Nombre	Tipo	Detalles
intent	string	intención para transmitir
path	string	ruta al archivo .ec

Soporte

---

getStrings

Obtiene cadenas de la aplicación.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getStrings(language, stringFile)

Parámetros

Nombre	Tipo	Detalles
language opcional	string	código de idioma
stringFile opcional	string	ruta al archivo de cadenas

Devuelve

• <object> appStrings: todas las cadenas definidas de una aplicación para el idioma y nombre de archivo de cadenas especificados

Soporte

---

setValueImmediate

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.setValueImmediate(elementId, text)

Parámetros

Nombre	Tipo	Detalles
elementId	String	el id de un elemento devuelto en una llamada anterior a Find Element(s)
text	string	texto para establecer en un elemento

Soporte

---

replaceValue

Reemplaza directamente el valor en un elemento.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.replaceValue(elementId, value)

Parámetros

Nombre	Tipo	Detalles
elementId	String	el id de un elemento devuelto en una llamada anterior a Find Element(s)
value	string	valor para reemplazar en el elemento

Soporte

---

getSettings

Recupera la configuración actual en el dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getSettings()

Devuelve

• <object> settings: Hash JSON de todas las configuraciones actualmente especificadas, consulta la API de configuración

Soporte

---

updateSettings

Actualiza la configuración actual en el dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.updateSettings(settings)

Parámetros

Nombre	Tipo	Detalles
settings	object	objeto clave/valor con configuraciones para actualizar

Soporte

---

receiveAsyncResponse

URL de retorno para la ejecución asíncrona de JavaScript.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.receiveAsyncResponse(response)

Parámetros

Nombre	Tipo	Detalles
response	object	respuesta para recibir en el dispositivo

Soporte

---

gsmCall

Realiza una llamada GSM (solo emulador).

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.gsmCall(phoneNumber, action)

Parámetros

Nombre	Tipo	Detalles
phoneNumber	string	el número de teléfono al que llamar
action	string	La acción - 'call', 'accept', 'cancel', 'hold'

Soporte

---

gsmSignal

Establece la intensidad de la señal GSM (solo emulador).

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.gsmSignal(signalStrength, signalStrengh)

Parámetros

Nombre	Tipo	Detalles
signalStrength	string	intensidad de la señal en el rango [0, 4]
signalStrengh opcional	string	intensidad de la señal en el rango [0, 4]. Por favor, establece también este parámetro con el mismo valor si usas Appium v1.11.0 o inferior (consulta https://github.com/appium/appium/issues/12234).

Soporte

---

powerCapacity

Establece el porcentaje de batería (solo emulador).

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.powerCapacity(percent)

Parámetros

Nombre	Tipo	Detalles
percent	number	valor de porcentaje en el rango [0, 100]

Soporte

---

powerAC

Establece el estado del cargador de batería a conectado o no (solo emulador).

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.powerAC(state)

Parámetros

Nombre	Tipo	Detalles
state	string	establece el estado. on o off

Soporte

---

gsmVoice

Establece el estado de la voz GSM (solo emulador).

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.gsmVoice(state)

Parámetros

Nombre	Tipo	Detalles
state	string	estado de la voz GSM - 'unregistered', 'home', 'roaming', 'searching', 'denied', 'off', 'on'

Soporte

---

sendSms

Simula un mensaje SMS (solo emulador).

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.sendSms(phoneNumber, message)

Parámetros

Nombre	Tipo	Detalles
phoneNumber	string	el número de teléfono al que enviar el SMS
message	string	el mensaje SMS

Soporte

---

fingerPrint

Autentica usuarios utilizando sus huellas dactilares en emuladores compatibles.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.fingerPrint(fingerprintId)

Parámetros

Nombre	Tipo	Detalles
fingerprintId	number	huellas dactilares almacenadas en el sistema Android Keystore (del 1 al 10)

Soporte

---

setClipboard

Establece el contenido del portapapeles del sistema

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.setClipboard(content, contentType, label)

Parámetros

Nombre	Tipo	Detalles
content	string	El contenido del portapapeles codificado en base64
contentType opcional	string	El tipo de contenido a obtener. Plaintext, Image, URL. Android solo soporta texto plano
label opcional	string	Etiqueta de datos del portapapeles para Android

Devuelve

• <string> response: Respuesta del servidor Appium

Soporte

---

getClipboard

Obtiene el contenido del portapapeles del sistema

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getClipboard(contentType)

Parámetros

Nombre	Tipo	Detalles
contentType opcional	string	El tipo de contenido a obtener. Plaintext, Image, URL. Android solo soporta texto plano

Devuelve

• <string> response: Contenido del portapapeles como cadena codificada en base64 o una cadena vacía si el portapapeles está vacío

Soporte

---

touchPerform

Esta funcionalidad solo está disponible desde dentro de un contexto nativo. 'Touch Perform' funciona de manera similar a las otras interacciones táctiles singulares, excepto que esto te permite encadenar más de una acción táctil como un solo comando. Esto es útil porque los comandos de Appium se envían a través de la red y hay latencia entre comandos. Esta latencia puede hacer que ciertas interacciones táctiles sean imposibles porque algunas interacciones necesitan realizarse en una secuencia. El deslizamiento vertical, por ejemplo, requiere presionar, moverse a una coordenada y diferente, y luego soltar. Para que funcione, no puede haber un retraso entre las interacciones.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.touchPerform(actions)

Parámetros

Nombre	Tipo	Detalles
actions	object[]	El tipo de acción a realizar (por ejemplo, moveTo, release, press, tap, wait)

Ejemplo

// hacer un deslizamiento horizontal por porcentaje
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: {},
  },
]);

Soporte

---

multiTouchPerform

Esta funcionalidad solo está disponible desde dentro de un contexto nativo. Realiza una secuencia de acción multitáctil.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.multiTouchPerform(actions)

Parámetros

Nombre	Tipo	Detalles
actions	object[]	El tipo de acción a realizar (por ejemplo, moveTo, release, press, tap, wait)

Soporte

---

executeDriverScript

Este comando te permite especificar un script WebdriverIO como una cadena y transmitirlo al servidor Appium para su ejecución local en el propio servidor. Este enfoque ayuda a minimizar la latencia potencial asociada con cada comando. Para utilizar este comando con Appium 2.0, debes tener instalado el complemento execute-driver-plugin.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.executeDriverScript(script, type, timeout)

Parámetros

Nombre	Tipo	Detalles
script	string	El script a ejecutar. Tiene acceso a un objeto 'driver' que representa una sesión WebdriverIO adjunta al servidor actual.
type opcional	string	El lenguaje/framework utilizado en el script. Actualmente, solo se soporta 'webdriverio' y es el valor predeterminado.
timeout opcional	number	El número de milisegundos que se debe permitir que se ejecute el script antes de ser terminado por el servidor Appium. El valor predeterminado es el equivalente a 1 hora.

Devuelve

• <object> result: Un objeto que contiene dos campos: 'result', que es el valor de retorno del propio script, y 'logs', que contiene 3 campos internos, 'log', 'warn', y 'error', que contienen un array de cadenas registradas por console.log, console.warn, y console.error en la ejecución del script.

---

getEvents

Obtiene eventos almacenados en el servidor appium.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getEvents(type)

Parámetros

Nombre	Tipo	Detalles
type	string[]	Obtiene eventos que se filtran con el tipo si se proporciona el tipo.

Devuelve

• <object> result: Un hash JSON de eventos como {'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }.

Soporte

---

logEvent

Almacena un evento personalizado.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.logEvent(vendor, event)

Parámetros

Nombre	Tipo	Detalles
vendor	string	El nombre del proveedor. Será vendor en vendor:event.
event	string	El nombre del evento. Será event en vendor:event.

Soporte

---

compareImages

Esta característica realiza comparaciones de imágenes utilizando las capacidades del marco OpenCV. Ten en cuenta que para que esta funcionalidad funcione, tanto el marco OpenCV como el módulo opencv4nodejs deben estar instalados en la máquina donde opera el servidor Appium. Además, necesitarás tener instalado el complemento images-plugin para usar esta función con Appium 2.0.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

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

Parámetros

Nombre	Tipo	Detalles
mode=matchFeatures	string	Uno de los posibles modos de comparación: 'matchFeatures', 'getSimilarity', 'matchTemplate'. 'matchFeatures' es por defecto.
firstImage	string	Datos de imagen. Se soportan todos los formatos de imagen que la propia biblioteca OpenCV acepta.
secondImage	string	Datos de imagen. Se soportan todos los formatos de imagen que la propia biblioteca OpenCV acepta.
options=[object Object]	object	El contenido de este diccionario depende del valor real de mode. Consulta la documentación del módulo appium-support para más detalles.

Devuelve

• <object> result: El contenido del diccionario resultante depende de los valores reales de mode y options. Consulta la documentación del módulo appium-support para más detalles.

---

implicitWait

Establece la cantidad de tiempo que el conductor debe esperar al buscar elementos. Al buscar un único elemento, el controlador debe sondear la página hasta que se encuentre un elemento o expire el tiempo de espera, lo que ocurra primero. Al buscar varios elementos, el controlador debe sondear la página hasta que se encuentre al menos un elemento o expire el tiempo de espera, momento en el que debe devolver una lista vacía. Si este comando nunca se envía, el controlador debe tener por defecto una espera implícita de 0ms.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.implicitWait(ms)

Parámetros

Nombre	Tipo	Detalles
ms	number	La cantidad de tiempo, en milisegundos, para esperar en un elemento.

Soporte

---

getLocationInView

Determina la ubicación de un elemento en la pantalla una vez que se ha desplazado a la vista.

Nota: Esto se considera un comando interno y solo debe usarse para determinar la ubicación de un elemento para generar correctamente eventos nativos.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getLocationInView(elementId)

Parámetros

Nombre	Tipo	Detalles
elementId	String	ID del elemento al que dirigir el comando

Devuelve

• <Object> location: Las coordenadas X e Y del elemento en la página.

Soporte

---

sendKeys

Enviar una secuencia de pulsaciones de teclas al elemento activo

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.sendKeys(value)

Parámetros

Nombre	Tipo	Detalles
value	string[]	La secuencia de teclas a escribir. Se debe proporcionar un array.

Soporte

---

availableIMEEngines

Lista todos los motores disponibles en la máquina. Para usar un motor, debe estar presente en esta lista.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.availableIMEEngines()

Devuelve

• <String[]> engines: Una lista de motores disponibles

Soporte

---

getActiveIMEEngine

Obtiene el nombre del motor IME activo. La cadena del nombre es específica de la plataforma.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getActiveIMEEngine()

Devuelve

• <String> engine: El nombre del motor IME activo

Soporte

---

isIMEActivated

Indica si la entrada IME está activa en este momento

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.isIMEActivated()

Devuelve

• <Boolean> isActive: Verdadero si la entrada IME está disponible y actualmente activa, falso en caso contrario

Soporte

---

deactivateIMEEngine

Desactiva el motor IME actualmente activo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.deactivateIMEEngine()

Soporte

---

activateIMEEngine

Activa un motor que está disponible

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.activateIMEEngine(engine)

Parámetros

Nombre	Tipo	Detalles
engine	string	nombre del motor a activar

Soporte

---

asyncScriptTimeout

Establece la cantidad de tiempo, en milisegundos, que los scripts asincrónicos ejecutados por /session/:sessionId/execute_async pueden ejecutarse antes de que se aborten y se devuelva un error Timeout al cliente.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.asyncScriptTimeout(ms)

Parámetros

Nombre	Tipo	Detalles
ms	number	La cantidad de tiempo, en milisegundos, que los comandos con tiempo limitado pueden ejecutarse

Soporte

---

submit

Envía un elemento de formulario.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.submit(elementId)

Parámetros

Nombre	Tipo	Detalles
elementId	String	ID del elemento de formulario a enviar

Soporte

---

getElementSize

Determina el tamaño de un elemento en píxeles. El tamaño se devolverá como un objeto JSON con propiedades width y height.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getElementSize(elementId)

Parámetros

Nombre	Tipo	Detalles
elementId	String	ID del elemento al que dirigir el comando

Devuelve

• <Object> size: El ancho y alto del elemento, en píxeles.

Soporte

---

getElementLocation

Determina la ubicación de un elemento en la página. El punto (0, 0) se refiere a la esquina superior izquierda de la página. Las coordenadas del elemento se devuelven como un objeto JSON con propiedades x e y.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getElementLocation(elementId)

Parámetros

Nombre	Tipo	Detalles
elementId	String	ID del elemento al que dirigir el comando

Devuelve

• <Object> location: Las coordenadas X e Y del elemento en la página.

Soporte

---

touchClick

Toque único en el dispositivo habilitado para táctil.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.touchClick(element)

Parámetros

Nombre	Tipo	Detalles
element	string	ID del elemento para realizar un toque único.

Soporte

---

touchDown

Dedo abajo en la pantalla.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.touchDown(x, y)

Parámetros

Nombre	Tipo	Detalles
x	number	coordenada x en la pantalla
y	number	coordenada y en la pantalla

Soporte

---

touchUp

Dedo arriba en la pantalla.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.touchUp(x, y)

Parámetros

Nombre	Tipo	Detalles
x	number	coordenada x en la pantalla
y	number	coordenada y en la pantalla

Soporte

---

touchMove

Movimiento del dedo en la pantalla.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.touchMove(x, y)

Parámetros

Nombre	Tipo	Detalles
x	number	coordenada x en la pantalla
y	number	coordenada y en la pantalla

Soporte

---

touchLongClick

Pulsación larga en la pantalla táctil usando eventos de movimiento de dedos.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.touchLongClick(element)

Parámetros

Nombre	Tipo	Detalles
element	string	ID del elemento sobre el que hacer una pulsación larga

Soporte

---

touchFlick

Desliza rápidamente en la pantalla táctil usando eventos de movimiento de dedos. Este comando de deslizamiento rápido comienza en una ubicación particular de la pantalla.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

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

Parámetros

Nombre	Tipo	Detalles
xoffset opcional	number	el desplazamiento x en píxeles para deslizar
yoffset opcional	number	el desplazamiento y en píxeles para deslizar
element opcional	string	ID del elemento donde comienza el deslizamiento
speed opcional	number	la velocidad en píxeles por segundo
xspeed opcional	number	la velocidad x en píxeles por segundo
yspeed opcional	number	la velocidad y en píxeles por segundo

Soporte

---

getOrientation

Obtiene la orientación actual del dispositivo.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getOrientation()

Devuelve

• <String> orientation: La orientación actual correspondiente a un valor definido en ScreenOrientation: LANDSCAPE|PORTRAIT.

Soporte

---

setOrientation

Establece la orientación del dispositivo

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.setOrientation(orientation)

Parámetros

Nombre	Tipo	Detalles
orientation	string	la nueva orientación del navegador como se define en ScreenOrientation: LANDSCAPE|PORTRAIT

Soporte

---

getLogs

Obtiene el registro para un tipo de registro dado. El búfer de registro se restablece después de cada solicitud.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getLogs(type)

Parámetros

Nombre	Tipo	Detalles
type	string	el tipo de registro

Devuelve

• <Object[]> logs: La lista de entradas de registro.

Soporte

---

getLogTypes

Obtiene los tipos de registro disponibles.

Comando de Appium. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso

driver.getLogTypes()

Devuelve

• <String[]> logTypes: La lista de tipos de registro disponibles.

Soporte