Appium

getAppiumContext

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getAppiumContext()

Retorna

• <Context> context: uma string representando o contexto atual ou null representando 'sem contexto'

---

switchAppiumContext

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.switchAppiumContext(name)

Parâmetros

Nome	Tipo	Detalhes
name	string	uma string representando um contexto disponível

---

getAppiumContexts

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getAppiumContexts()

Retorna

• <Context[]> contexts: um array de strings representando contextos disponíveis, por exemplo 'WEBVIEW', ou 'NATIVE'

---

shake

Executa uma ação de agitar no dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.shake()

Suporte

---

lock

Bloqueia o dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.lock(seconds)

Parâmetros

Nome	Tipo	Detalhes
seconds opcional	number	por quanto tempo bloquear a tela (apenas iOS)

Suporte

---

unlock

Desbloqueia o dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.unlock()

Suporte

---

isLocked

Verifica se o dispositivo está bloqueado ou não.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.isLocked()

Retorna

• <boolean> isLocked: Verdadeiro se o dispositivo estiver bloqueado, falso se não estiver

Suporte

---

startRecordingScreen

Inicia a gravação da tela.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.startRecordingScreen(options)

Parâmetros

Nome	Tipo	Detalhes
options opcional	object	parâmetros de comando que podem conter chaves como: remotePath, username, password, method, forceRestart, timeLimit, videoType, videoQuality, videoFps, bitRate, videoSize, bugReport (veja mais descrições nos documentos do Appium)

Suporte

---

stopRecordingScreen

Para a gravação da tela

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

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

Parâmetros

Nome	Tipo	Detalhes
remotePath opcional	string	O caminho para o local remoto, onde o vídeo resultante deve ser enviado. Os seguintes protocolos são suportados http/https, ftp. Esta opção só tem efeito se houver processo de gravação de tela em andamento e o parâmetro forceRestart não estiver definido como true. Valor de string nula ou vazia (configuração padrão) significa que o conteúdo do arquivo resultante deve ser codificado como Base64.
username opcional	string	O nome do usuário para a autenticação remota.
password opcional	string	A senha para a autenticação remota.
method opcional	string	O nome do método de upload multipart http. O 'PUT' é usado por padrão.

Retorna

• <string> response: String codificada em Base64. Se remote_path estiver definido, a resposta é uma string vazia

Suporte

---

getPerformanceDataTypes

Retorna os tipos de informação do estado do sistema que são suportados para leitura, como cpu, memória, tráfego de rede e bateria.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getPerformanceDataTypes()

Retorna

• <string[]> performanceTypes: Os tipos de dados de desempenho disponíveis (cpuinfo|batteryinfo|networkinfo|memoryinfo)

Suporte

---

getPerformanceData

Retorna as informações do estado do sistema que são suportadas para leitura, como cpu, memória, tráfego de rede e bateria.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getPerformanceData(packageName, dataType, dataReadTimeout)

Parâmetros

Nome	Tipo	Detalhes
packageName	string	o nome do pacote da aplicação
dataType	string	o tipo de estado do sistema que deseja ler. Deve ser um dos tipos de dados de desempenho suportados
dataReadTimeout opcional	number	o número de tentativas de leitura

Retorna

• <string[]> performanceData: O tipo de informação do estado do sistema que é suportado para leitura, como cpu, memória, tráfego de rede e bateria

Suporte

---

pressKeyCode

Pressiona uma tecla específica no dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.pressKeyCode(keycode, metastate, flags)

Parâmetros

Nome	Tipo	Detalhes
keycode	number	código da tecla a ser pressionada
metastate opcional	number	estado meta para pressionar o código da tecla
flags opcional	number	flags para o pressionamento de tecla

Suporte

---

longPressKeyCode

Pressiona e segura um código de tecla específico no dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.longPressKeyCode(keycode, metastate, flags)

Parâmetros

Nome	Tipo	Detalhes
keycode	number	código da tecla a ser pressionada no dispositivo
metastate opcional	number	metastate para o pressionamento de tecla
flags opcional	number	flags para o pressionamento de tecla

Suporte

---

sendKeyEvent

Envia um código de tecla para o dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.sendKeyEvent(keycode, metastate)

Parâmetros

Nome	Tipo	Detalhes
keycode	string	código da tecla a ser pressionada
metastate opcional	string	estado meta para pressionar o código da tecla

Suporte

---

rotateDevice

Gira o dispositivo em três dimensões.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.rotateDevice(x, y, z)

Parâmetros

Nome	Tipo	Detalhes
x	number	offset x a ser usado para o centro do gesto de rotação
y	number	offset y a ser usado para o centro do gesto de rotação
z	number	offset z a ser usado para o centro do gesto de rotação

Suporte

---

getCurrentActivity

Obtém o nome da atividade atual do Android.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getCurrentActivity()

Retorna

• <string> activity: Nome da atividade atual

Suporte

---

getCurrentPackage

Obtém o nome do pacote atual do Android.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getCurrentPackage()

Retorna

• <string> package: Nome do pacote atual

Suporte

---

installApp

Instala o aplicativo fornecido no dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.installApp(appPath)

Parâmetros

Nome	Tipo	Detalhes
appPath	string	caminho para o arquivo .apk da aplicação

Suporte

---

activateApp

Ativa o aplicativo fornecido no dispositivo

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.activateApp(appId)

Parâmetros

Nome	Tipo	Detalhes
appId	string	ID do aplicativo (ID do pacote para Android, ID do pacote para iOS)

Suporte

---

removeApp

Remove um aplicativo do dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.removeApp(appId)

Parâmetros

Nome	Tipo	Detalhes
appId	string	ID do aplicativo (ID do pacote para Android, ID do pacote para iOS)

Suporte

---

terminateApp

Encerra o aplicativo fornecido no dispositivo

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.terminateApp(appId, options)

Parâmetros

Nome	Tipo	Detalhes
appId	string	ID do aplicativo (ID do pacote para Android, ID do pacote para iOS)
options opcional	object	Opções de comando. Por exemplo, "timeout": (Apenas Android) Tempo limite para tentar encerrar o aplicativo novamente (veja mais nos documentos do Appium)

Suporte

---

isAppInstalled

Verifica se o aplicativo especificado está instalado no dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.isAppInstalled(appId)

Parâmetros

Nome	Tipo	Detalhes
appId	string	ID do aplicativo (ID do pacote para Android, ID do pacote para iOS)

Retorna

• <boolean> isAppInstalled: Retorna verdadeiro se instalado, falso se não

Suporte

---

queryAppState

Obtém o status do aplicativo fornecido no dispositivo

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.queryAppState(appId)

Parâmetros

Nome	Tipo	Detalhes
appId	string	ID do aplicativo (ID do pacote para Android, ID do pacote para iOS)

Retorna

• <number> appStatus: 0 não está instalado. 1 não está em execução. 2 está em execução em segundo plano ou suspenso. 3 está em execução em segundo plano. 4 está em execução em primeiro plano

Suporte

---

hideKeyboard

Oculta o teclado virtual.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

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

Parâmetros

Nome	Tipo	Detalhes
strategy opcional	string	estratégia para ocultar o teclado (apenas UIAutomation), estratégias disponíveis - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'
key opcional	string	valor da tecla se a estratégia for 'pressKey'
keyCode opcional	string	código da tecla se a estratégia for 'pressKey'
keyName opcional	string	nome da tecla se a estratégia for 'pressKey'

Suporte

---

isKeyboardShown

Verifica se o teclado virtual está visível ou não.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.isKeyboardShown()

Retorna

• <boolean> isKeyboardShown: Verdadeiro se o teclado estiver visível

Suporte

---

pushFile

Coloca um arquivo no dispositivo em um local específico.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.pushFile(path, data)

Parâmetros

Nome	Tipo	Detalhes
path	string	caminho para instalar os dados
data	string	conteúdo do arquivo em base64

Suporte

---

pullFile

Recupera um arquivo do sistema de arquivos do dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.pullFile(path)

Parâmetros

Nome	Tipo	Detalhes
path	string	caminho no dispositivo para extrair o arquivo

Retorna

• <string> response: Conteúdo do arquivo em base64

Suporte

---

pullFolder

Recupera uma pasta do sistema de arquivos do dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.pullFolder(path)

Parâmetros

Nome	Tipo	Detalhes
path	string	caminho para uma pasta inteira no dispositivo

Suporte

---

toggleAirplaneMode

Ativa/desativa o modo avião no dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.toggleAirplaneMode()

Suporte

---

toggleData

Muda o estado do serviço de dados.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.toggleData()

Suporte

---

toggleWiFi

Muda o estado do serviço de wifi.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.toggleWiFi()

Suporte

---

toggleLocationServices

Muda o estado do serviço de localização.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.toggleLocationServices()

Suporte

---

toggleNetworkSpeed

Define a velocidade da rede (apenas Emulador)

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.toggleNetworkSpeed(netspeed)

Parâmetros

Nome	Tipo	Detalhes
netspeed	string	Tipo de rede - 'full','gsm', 'edge', 'hscsd', 'gprs', 'umts', 'hsdpa', 'lte', 'evdo'

Suporte

---

openNotifications

Abre as notificações do Android (apenas Emulador).

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.openNotifications()

Suporte

---

startActivity

Inicia uma atividade do Android fornecendo o nome do pacote e o nome da atividade.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

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

Parâmetros

Nome	Tipo	Detalhes
appPackage	string	nome do aplicativo
appActivity	string	nome da atividade
appWaitPackage opcional	string	nome do aplicativo a aguardar
appWaitActivity opcional	string	nome da atividade a aguardar
intentAction=android.intent.action.MAIN opcional	string	ação de intent que será usada para iniciar a atividade
intentCategory=android.intent.category.LAUNCHER opcional	string	categoria de intent que será usada para iniciar a atividade
intentFlags=0x10200000 opcional	string	flags que serão usados para iniciar a atividade
optionalIntentArguments opcional	string	argumentos adicionais de intent que serão usados para iniciar a atividade
dontStopAppOnReset opcional	string	não para o processo do aplicativo em teste, antes de iniciar o aplicativo usando adb

Suporte

---

getSystemBars

Recupera informações de visibilidade e limites das barras de status e navegação.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getSystemBars()

Retorna

• <object[]> systemBars: Informações sobre visibilidade e limites das barras de status e navegação

Suporte

---

getDeviceTime

Obtém a hora no dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getDeviceTime()

Retorna

• <string> time: Hora no dispositivo

Suporte

---

getDisplayDensity

Obtém a densidade de exibição do dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getDisplayDensity()

Retorna

• <*>

Suporte

---

touchId

Simula um evento de touch id (apenas Simulador iOS). Para habilitar este recurso, a capacidade desejada allowTouchIdEnroll deve ser definida como true e o Simulador deve estar registrado. Quando você define allowTouchIdEnroll como true, ele configurará o Simulador para ser registrado por padrão. O estado de registro pode ser alternado. Esta chamada só funcionará se o processo Appium ou seu aplicativo pai (por exemplo, Terminal.app ou Appium.app) tiver acesso à acessibilidade do Mac OS na lista Preferências do Sistema > Segurança e Privacidade > Privacidade > Acessibilidade.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.touchId(match)

Parâmetros

Nome	Tipo	Detalhes
match	boolean	estamos simulando um toque bem-sucedido (true) ou um toque com falha (false)

Suporte

---

toggleEnrollTouchId

Alterna o simulador sendo registrado para aceitar touchId (apenas Simulador iOS). Para habilitar este recurso, a capacidade desejada allowTouchIdEnroll deve ser definida como true. Quando allowTouchIdEnroll é definido como true, o Simulador será registrado por padrão, e o 'Toggle Touch ID Enrollment' muda o estado de registro. Esta chamada só funcionará se o processo Appium ou seu aplicativo pai (por exemplo, Terminal.app ou Appium.app) tiver acesso à acessibilidade do Mac OS na lista Preferências do Sistema > Segurança e Privacidade > Privacidade > Acessibilidade.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.toggleEnrollTouchId(enabled)

Parâmetros

Nome	Tipo	Detalhes
enabled=true opcional	boolean	igual a true se o registro TouchID deve ser habilitado

Suporte

---

launchApp

Inicia um aplicativo no dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

cuidado

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

Uso

driver.launchApp()

Suporte

---

closeApp

Fecha um aplicativo no dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

cuidado

Este comando de protocolo está obsoleto
Use driver.execute('mobile: terminateApp', { ... }) em vez disso

Uso

driver.closeApp()

Suporte

---

background

Envia o aplicativo em execução atual para esta sessão para o segundo plano.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

cuidado

Este comando de protocolo está obsoleto
Use driver.execute('mobile: backgroundApp', { ... }) em vez disso

Uso

driver.background(seconds)

Parâmetros

Nome	Tipo	Detalhes
seconds=null	number, null	tempo limite para restaurar o aplicativo, se 'null' o aplicativo não será restaurado

Suporte

---

endCoverage

Obtém dados de cobertura de teste.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.endCoverage(intent, path)

Parâmetros

Nome	Tipo	Detalhes
intent	string	intent para transmitir
path	string	caminho para o arquivo .ec

Suporte

---

getStrings

Obtém as strings do aplicativo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getStrings(language, stringFile)

Parâmetros

Nome	Tipo	Detalhes
language opcional	string	código de idioma
stringFile opcional	string	caminho para o arquivo de strings

Retorna

• <object> appStrings: todas as Strings definidas de um aplicativo para o idioma especificado e nome de arquivo de strings

Suporte

---

setValueImmediate

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.setValueImmediate(elementId, text)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)
text	string	texto para definir em um elemento

Suporte

---

replaceValue

Substitui o valor do elemento diretamente.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.replaceValue(elementId, value)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)
value	string	valor para substituir no elemento

Suporte

---

getSettings

Recupera as configurações atuais no dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getSettings()

Retorna

• <object> settings: Hash JSON de todas as configurações atualmente especificadas, veja a API de Configurações

Suporte

---

updateSettings

Atualiza a configuração atual no dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.updateSettings(settings)

Parâmetros

Nome	Tipo	Detalhes
settings	object	objeto chave/valor com configurações para atualizar

Suporte

---

receiveAsyncResponse

URL de retorno de chamada para execução assíncrona de JavaScript.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.receiveAsyncResponse(response)

Parâmetros

Nome	Tipo	Detalhes
response	object	resposta para receber no dispositivo

Suporte

---

gsmCall

Faz chamada GSM (apenas Emulador).

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.gsmCall(phoneNumber, action)

Parâmetros

Nome	Tipo	Detalhes
phoneNumber	string	o número de telefone para chamar
action	string	A ação - 'call', 'accept', 'cancel', 'hold'

Suporte

---

gsmSignal

Define a força do sinal GSM (apenas Emulador).

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.gsmSignal(signalStrength, signalStrengh)

Parâmetros

Nome	Tipo	Detalhes
signalStrength	string	força do sinal no intervalo [0, 4]
signalStrengh opcional	string	força do sinal no intervalo [0, 4]. Por favor, defina também este parâmetro com o mesmo valor se você usar o Appium v1.11.0 ou inferior (veja https://github.com/appium/appium/issues/12234).

Suporte

---

powerCapacity

Define a porcentagem da bateria (apenas Emulador).

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.powerCapacity(percent)

Parâmetros

Nome	Tipo	Detalhes
percent	number	valor percentual no intervalo [0, 100]

Suporte

---

powerAC

Define o estado do carregador de bateria como conectado ou não (apenas Emulador).

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.powerAC(state)

Parâmetros

Nome	Tipo	Detalhes
state	string	define o estado. on ou off

Suporte

---

gsmVoice

Define o estado da voz GSM (apenas Emulador).

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.gsmVoice(state)

Parâmetros

Nome	Tipo	Detalhes
state	string	estado da voz GSM - 'unregistered', 'home', 'roaming', 'searching', 'denied', 'off', 'on'

Suporte

---

sendSms

Simula uma mensagem SMS (apenas Emulador).

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.sendSms(phoneNumber, message)

Parâmetros

Nome	Tipo	Detalhes
phoneNumber	string	o número de telefone para enviar o SMS
message	string	a mensagem SMS

Suporte

---

fingerPrint

Autentica usuários usando suas digitais em emuladores compatíveis.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.fingerPrint(fingerprintId)

Parâmetros

Nome	Tipo	Detalhes
fingerprintId	number	impressões digitais armazenadas no sistema Android Keystore (de 1 a 10)

Suporte

---

setClipboard

Define o conteúdo da área de transferência do sistema

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.setClipboard(content, contentType, label)

Parâmetros

Nome	Tipo	Detalhes
content	string	O conteúdo da área de transferência codificado em base64
contentType opcional	string	O tipo de conteúdo a ser obtido. Plaintext, Image, URL. Android suporta apenas plaintext
label opcional	string	Rótulo de dados da área de transferência para Android

Retorna

• <string> response: Resposta do servidor Appium

Suporte

---

getClipboard

Obtém o conteúdo da área de transferência do sistema

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getClipboard(contentType)

Parâmetros

Nome	Tipo	Detalhes
contentType opcional	string	O tipo de conteúdo a ser obtido. Plaintext, Image, URL. Android suporta apenas plaintext

Retorna

• <string> response: Conteúdo da área de transferência como string codificada em base64 ou uma string vazia se a área de transferência estiver vazia

Suporte

---

touchPerform

Esta funcionalidade está disponível apenas dentro de um contexto nativo. 'Touch Perform' funciona de forma semelhante às outras interações de toque singular, exceto que isso permite que você encadeie mais de uma ação de toque como um comando. Isso é útil porque os comandos Appium são enviados pela rede e há latência entre os comandos. Esta latência pode tornar certas interações de toque impossíveis porque algumas interações precisam ser realizadas em uma sequência. Vertical, por exemplo, requer pressionar, mover para uma coordenada y diferente e depois soltar. Para funcionar, não pode haver um atraso entre as interações.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.touchPerform(actions)

Parâmetros

Nome	Tipo	Detalhes
actions	object[]	O tipo de ação a ser executada (por exemplo, moveTo, release, press, tap, wait)

Exemplo

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

Suporte

---

multiTouchPerform

Esta funcionalidade está disponível apenas dentro de um contexto nativo. Executa uma sequência de ação multi-toque.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.multiTouchPerform(actions)

Parâmetros

Nome	Tipo	Detalhes
actions	object[]	O tipo de ação a ser executada (por exemplo, moveTo, release, press, tap, wait)

Suporte

---

executeDriverScript

Este comando permite que você especifique um script WebdriverIO como uma string e o transmita para o servidor Appium para execução local no próprio servidor. Esta abordagem ajuda a minimizar a latência potencial associada a cada comando. Para utilizar este comando com o Appium 2.0, você deve ter o plugin execute-driver-plugin instalado.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.executeDriverScript(script, type, timeout)

Parâmetros

Nome	Tipo	Detalhes
script	string	O script a ser executado. Ele tem acesso a um objeto 'driver' que representa uma sessão WebdriverIO anexada ao servidor atual.
type opcional	string	A linguagem/framework usado no script. Atualmente, apenas 'webdriverio' é suportado e é o padrão.
timeout opcional	number	O número de milissegundos que o script deve ser permitido para executar antes de ser encerrado pelo servidor Appium. O padrão é o equivalente a 1 hora.

Retorna

• <object> result: Um objeto contendo dois campos: 'result', que é o valor de retorno do próprio script, e 'logs', que contém 3 campos internos, 'log', 'warn' e 'error', que contêm um array de strings registradas por console.log, console.warn e console.error na execução do script.

---

getEvents

Obtém eventos armazenados no servidor appium.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getEvents(type)

Parâmetros

Nome	Tipo	Detalhes
type	string[]	Obtém eventos filtrados pelo tipo se o tipo for fornecido.

Retorna

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

Suporte

---

logEvent

Armazena um evento personalizado.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.logEvent(vendor, event)

Parâmetros

Nome	Tipo	Detalhes
vendor	string	O nome do fornecedor. Será vendor em vendor:event.
event	string	O nome do evento. Será event em vendor:event.

Suporte

---

compareImages

Este recurso conduz comparações de imagens utilizando as capacidades do framework OpenCV. Por favor, note que para que essa funcionalidade funcione, tanto o framework OpenCV quanto o módulo opencv4nodejs devem estar instalados na máquina onde o servidor Appium está operacional. Além disso, você precisará ter o plugin images-plugin instalado para usar esse recurso com o Appium 2.0.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

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

Parâmetros

Nome	Tipo	Detalhes
mode=matchFeatures	string	Um dos modos de comparação possíveis: 'matchFeatures', 'getSimilarity', 'matchTemplate'. 'matchFeatures' é o padrão.
firstImage	string	Dados de imagem. Todos os formatos de imagem que a própria biblioteca OpenCV aceita são suportados.
secondImage	string	Dados de imagem. Todos os formatos de imagem que a própria biblioteca OpenCV aceita são suportados.
options=[object Object]	object	O conteúdo deste dicionário depende do valor real de mode. Veja a documentação no módulo appium-support para mais detalhes.

Retorna

• <object> result: O conteúdo do dicionário resultante depende dos valores reais de mode e options. Veja a documentação no módulo appium-support para mais detalhes.

---

implicitWait

Define o tempo que o driver deve esperar ao procurar elementos. Ao procurar um único elemento, o driver deve sondar a página até que um elemento seja encontrado ou o tempo limite expire, o que ocorrer primeiro. Ao procurar vários elementos, o driver deve sondar a página até que pelo menos um elemento seja encontrado ou o tempo limite expire, momento em que deve retornar uma lista vazia. Se este comando nunca for enviado, o driver deve usar como padrão uma espera implícita de 0ms.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.implicitWait(ms)

Parâmetros

Nome	Tipo	Detalhes
ms	number	O tempo, em milissegundos, para esperar por um elemento.

Suporte

---

getLocationInView

Determina a localização de um elemento na tela depois de ter sido rolado para a visualização.

Nota: Isso é considerado um comando interno e deve ser usado apenas para determinar a localização de um elemento para gerar corretamente eventos nativos.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getLocationInView(elementId)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	ID do elemento para o qual direcionar o comando

Retorna

• <Object> location: As coordenadas X e Y do elemento na página.

Suporte

---

sendKeys

Envia uma sequência de pressionamentos de teclas para o elemento ativo

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.sendKeys(value)

Parâmetros

Nome	Tipo	Detalhes
value	string[]	A sequência de teclas a digitar. Um array deve ser fornecido.

Suporte

---

availableIMEEngines

Lista todos os mecanismos disponíveis na máquina. Para usar um mecanismo, ele deve estar presente nesta lista.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.availableIMEEngines()

Retorna

• <String[]> engines: Uma lista de mecanismos disponíveis

Suporte

---

getActiveIMEEngine

Obtém o nome do mecanismo IME ativo. A string do nome é específica da plataforma.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getActiveIMEEngine()

Retorna

• <String> engine: O nome do mecanismo IME ativo

Suporte

---

isIMEActivated

Indica se a entrada IME está ativa no momento

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.isIMEActivated()

Retorna

• <Boolean> isActive: Verdadeiro se a entrada IME estiver disponível e atualmente ativa, falso caso contrário

Suporte

---

deactivateIMEEngine

Desativa o mecanismo IME atualmente ativo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.deactivateIMEEngine()

Suporte

---

activateIMEEngine

Ativa um mecanismo que está disponível

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.activateIMEEngine(engine)

Parâmetros

Nome	Tipo	Detalhes
engine	string	nome do mecanismo a ser ativado

Suporte

---

asyncScriptTimeout

Define o tempo, em milissegundos, que scripts assíncronos executados por /session/:sessionId/execute_async são permitidos a executar antes de serem abortados e um erro Timeout é retornado ao cliente.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.asyncScriptTimeout(ms)

Parâmetros

Nome	Tipo	Detalhes
ms	number	O tempo, em milissegundos, que comandos com limite de tempo são permitidos a executar

Suporte

---

submit

Envia um elemento de formulário.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.submit(elementId)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	ID do elemento de formulário a ser enviado

Suporte

---

getElementSize

Determina o tamanho de um elemento em pixels. O tamanho será retornado como um objeto JSON com propriedades width e height.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getElementSize(elementId)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	ID do elemento para o qual direcionar o comando

Retorna

• <Object> size: A largura e altura do elemento, em pixels.

Suporte

---

getElementLocation

Determina a localização de um elemento na página. O ponto (0, 0) refere-se ao canto superior esquerdo da página. As coordenadas do elemento são retornadas como um objeto JSON com propriedades x e y.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getElementLocation(elementId)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	ID do elemento para o qual direcionar o comando

Retorna

• <Object> location: As coordenadas X e Y do elemento na página.

Suporte

---

touchClick

Toque único no dispositivo habilitado para toque.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.touchClick(element)

Parâmetros

Nome	Tipo	Detalhes
element	string	ID do elemento para tocar uma vez.

Suporte

---

touchDown

Dedo para baixo na tela.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.touchDown(x, y)

Parâmetros

Nome	Tipo	Detalhes
x	number	coordenada x na tela
y	number	coordenada y na tela

Suporte

---

touchUp

Dedo para cima na tela.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.touchUp(x, y)

Parâmetros

Nome	Tipo	Detalhes
x	number	coordenada x na tela
y	number	coordenada y na tela

Suporte

---

touchMove

Movimento do dedo na tela.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.touchMove(x, y)

Parâmetros

Nome	Tipo	Detalhes
x	number	coordenada x na tela
y	number	coordenada y na tela

Suporte

---

touchLongClick

Pressionar longamente na tela sensível ao toque usando eventos de movimento do dedo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.touchLongClick(element)

Parâmetros

Nome	Tipo	Detalhes
element	string	ID do elemento para pressionar longamente

Suporte

---

touchFlick

Movimento rápido na tela sensível ao toque usando eventos de movimento do dedo. Este comando de movimento rápido começa em um local específico da tela.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

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

Parâmetros

Nome	Tipo	Detalhes
xoffset opcional	number	o deslocamento x em pixels para mover rapidamente
yoffset opcional	number	o deslocamento y em pixels para mover rapidamente
element opcional	string	ID do elemento onde o movimento rápido começa
speed opcional	number	a velocidade em pixels por segundos
xspeed opcional	number	a velocidade x em pixels por segundo
yspeed opcional	number	a velocidade y em pixels por segundo

Suporte

---

getOrientation

Obtém a orientação atual do dispositivo.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getOrientation()

Retorna

• <String> orientation: A orientação atual correspondente a um valor definido em ScreenOrientation: LANDSCAPE|PORTRAIT.

Suporte

---

setOrientation

Define a orientação do dispositivo

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.setOrientation(orientation)

Parâmetros

Nome	Tipo	Detalhes
orientation	string	a nova orientação do navegador conforme definido em ScreenOrientation: LANDSCAPE|PORTRAIT

Suporte

---

getLogs

Obtém o log para um determinado tipo de log. O buffer de log é redefinido após cada solicitação.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getLogs(type)

Parâmetros

Nome	Tipo	Detalhes
type	string	o tipo de log

Retorna

• <Object[]> logs: A lista de entradas de log.

Suporte

---

getLogTypes

Obtém os tipos de log disponíveis.

Comando Appium. Mais detalhes podem ser encontrados nos documentos oficiais do protocolo.

Uso

driver.getLogTypes()

Retorna

• <String[]> logTypes: A lista de tipos de log disponíveis.

Suporte