Appium
getContext
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getContext()
戻り値
- <Context>
context: 現在のコンテキストを表す文字列、または 'コンテキストなし' を表す null
switchContext
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.switchContext(name)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
name | 文字列 | 使用可能なコンテキストを表す文字列 |
getContexts
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getContexts()
戻り値
- <Context[]>
contexts: 使用可能なコンテキストを表す文字列の配列（例： 'WEBVIEW'、'NATIVE'）
shake
デバイスでシェイク操作を実行します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.shake()
サポート
lock
デバイスをロックします。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.lock(seconds)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
secondsオプション | 数値 | 画面をロックする時間（iOSのみ） |
サポート
unlock
デバイスのロックを解除します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.unlock()
サポート
isLocked
デバイスがロックされているかどうかを確認します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.isLocked()
戻り値
- <boolean>
isLocked: デバイスがロックされている場合は true、そうでない場合は false
サポート
startRecordingScreen
画面の録画を開始します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.startRecordingScreen(options)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
optionsオプション | オブジェクト | remotePath、username、password、method、forceRestart、timeLimit、videoType、videoQuality、videoFps、bitRate、videoSize、bugReport などのキーを含むことができるコマンドパラメータ（Appiumドキュメントで詳細を参照） |
サポート
stopRecordingScreen
画面の録画を停止します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.stopRecordingScreen(remotePath, username, password, method)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
remotePathオプション | 文字列 | 結果のビデオをアップロードするリモートロケーションへのパス。http/https、ftpプロトコルがサポートされています。このオプションは、画面録画プロセスが進行中で、forceRestartパラメータがtrueに設定されていない場合にのみ有効です。Nullまたは空文字列値（デフォルト設定）は、結果ファイルの内容をBase64でエンコードする必要があることを意味します。 |
usernameオプション | 文字列 | リモート認証のユーザー名。 |
passwordオプション | 文字列 | リモート認証のパスワード。 |
methodオプション | 文字列 | httpマルチパートアップロードメソッド名。デフォルトでは'PUT'が使用されます。 |
戻り値
- <string>
response: Base64でエンコードされた文字列。remote_pathが設定されている場合、応答は空文字列です。
サポート
getPerformanceDataTypes
CPU、メモリ、ネットワークトラフィック、バッテリーなど、読み取りをサポートするシステム状態の情報タイプを返します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getPerformanceDataTypes()
戻り値
- <string[]>
performanceTypes: 使用可能なパフォーマンスデータタイプ (cpuinfo|batteryinfo|networkinfo|memoryinfo)
サポート
getPerformanceData
CPU、メモリ、ネットワークトラフィック、バッテリーなど、読み取りをサポートするシステム状態の情報を返します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getPerformanceData(packageName, dataType, dataReadTimeout)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
packageName | 文字列 | アプリケーションのパッケージ名 |
dataType | 文字列 | 読み取りたいシステム状態の種類。サポートされているパフォーマンスデータタイプのいずれかである必要があります。 |
dataReadTimeoutオプション | 数値 | 読み取り試行回数 |
戻り値
- <string[]>
performanceData: CPU、メモリ、ネットワークトラフィック、バッテリーなど、読み取りをサポートするシステム状態の情報タイプ
サポート
pressKeyCode
デバイスの特定のキーを押します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.pressKeyCode(keycode, metastate, flags)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
keycode | 数値 | 押すキーコード |
metastateオプション | 数値 | キーコードを押すためのメタステート |
flagsオプション | 数値 | キー押下フラグ |
サポート
longPressKeyCode
デバイス上で特定のキーコードを長押しします。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.longPressKeyCode(keycode, metastate, flags)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
keycode | 数値 | デバイスで押すキーコード |
metastateオプション | 数値 | キー押下のメタステート |
flagsオプション | 数値 | キー押下フラグ |
サポート
sendKeyEvent
デバイスにキーコードを送信します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.sendKeyEvent(keycode, metastate)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
keycode | 文字列 | 押すキーコード |
metastateオプション | 文字列 | キーコードを押すためのメタステート |
サポート
rotateDevice
デバイスを3次元で回転します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.rotateDevice(x, y, z)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
x | 数値 | 回転ジェスチャの中心点に使用するxオフセット |
y | 数値 | 回転ジェスチャの中心点に使用するyオフセット |
z | 数値 | 回転ジェスチャの中心点に使用するzオフセット |
サポート
getCurrentActivity
現在のAndroidアクティビティの名前を取得します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getCurrentActivity()
戻り値
- <string>
activity: 現在のアクティビティの名前
サポート
getCurrentPackage
現在のAndroidパッケージの名前を取得します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getCurrentPackage()
戻り値
- <string>
package: 現在のパッケージの名前
サポート
installApp
指定されたアプリをデバイスにインストールします。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.installApp(appPath)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
appPath | 文字列 | アプリケーション.apkファイルへのパス |
サポート
activateApp
指定されたアプリをデバイスでアクティブにします。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.activateApp(appId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
appId | 文字列 | アプリID（Androidの場合はパッケージID、iOSの場合はバンドルID） |
サポート
removeApp
デバイスからアプリを削除します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.removeApp(appId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
appId | 文字列 | アプリID（Androidの場合はパッケージID、iOSの場合はバンドルID） |
サポート
terminateApp
デバイス上で指定されたアプリを終了します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.terminateApp(appId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
appId | 文字列 | アプリID（Androidの場合はパッケージID、iOSの場合はバンドルID） |
サポート
isAppInstalled
指定されたアプリがデバイスにインストールされているかどうかを確認します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.isAppInstalled(appId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
appId | 文字列 | アプリID（Androidの場合はパッケージID、iOSの場合はバンドルID） |
戻り値
- <boolean>
isAppInstalled: インストール済みの場合はtrue、そうでない場合はfalseを返します。
サポート
queryAppState
デバイス上の指定されたアプリの状態を取得します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.queryAppState(appId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
appId | 文字列 | アプリID（Androidの場合はパッケージID、iOSの場合はバンドルID） |
戻り値
- <number>
appStatus: 0:インストールされていません。1:実行されていません。2:バックグラウンドまたは中断状態で実行中。3:バックグラウンドで実行中。4:フォアグラウンドで実行中
サポート
hideKeyboard
ソフトキーボードを隠します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.hideKeyboard(strategy, key, keyCode, keyName)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
strategyオプション | 文字列 | キーボードを隠すための戦略（UIAutomationのみ）。使用可能な戦略 - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default' |
keyオプション | 文字列 | strategyが'pressKey'の場合のキー値 |
keyCodeオプション | 文字列 | strategyが'pressKey'の場合のキーコード |
keyNameオプション | 文字列 | strategyが'pressKey'の場合のキー名 |
サポート
isKeyboardShown
ソフトキーボードが表示されているかどうか。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.isKeyboardShown()
戻り値
- <boolean>
isKeyboardShown: キーボードが表示されている場合はtrue
サポート
pushFile
特定の場所にファイルをデバイスに配置します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.pushFile(path, data)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
path | 文字列 | データをインストールするパス |
data | 文字列 | Base64でエンコードされたファイルの内容 |
サポート
pullFile
デバイスのファイルシステムからファイルを取得します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.pullFile(path)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
path | 文字列 | ファイルの取得元のデバイス上のパス |
戻り値
- <string>
response: Base64でエンコードされたファイルの内容
サポート
pullFolder
デバイスのファイルシステムからフォルダを取得します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.pullFolder(path)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
path | 文字列 | デバイス上のフォルダ全体のパス |
サポート
toggleAirplaneMode
デバイスで機内モードを切り替えます。
Appiumコマンド。詳細は、公式プロトコルドキュメントを参照してください。
使用方法
driver.toggleAirplaneMode()
サポート
toggleData
データサービスの状態を切り替えます。
Appiumコマンド。詳細は、公式プロトコルドキュメントを参照してください。
使用方法
driver.toggleData()
サポート
toggleWiFi
WiFiサービスの状態を切り替えます。
Appiumコマンド。詳細は、公式プロトコルドキュメントを参照してください。
使用方法
driver.toggleWiFi()
サポート
toggleLocationServices
位置情報サービスの状態を切り替えます。
Appiumコマンド。詳細は、公式プロトコルドキュメントを参照してください。
使用方法
driver.toggleLocationServices()
サポート
toggleNetworkSpeed
ネットワーク速度を設定します（エミュレータのみ）。
Appiumコマンド。詳細は、公式プロトコルドキュメントを参照してください。
使用方法
driver.toggleNetworkSpeed(netspeed)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
netspeed | 文字列 | ネットワークタイプ - 'full','gsm', 'edge', 'hscsd', 'gprs', 'umts', 'hsdpa', 'lte', 'evdo' |
サポート
openNotifications
Android通知を開きます（エミュレータのみ）。
Appiumコマンド。詳細は、公式プロトコルドキュメントを参照してください。
使用方法
driver.openNotifications()
サポート
startActivity
パッケージ名とアクティビティ名を指定してAndroidアクティビティを開始します。
Appiumコマンド。詳細は、公式プロトコルドキュメントを参照してください。
使用方法
driver.startActivity(appPackage, appActivity, appWaitPackage, appWaitActivity, intentAction, intentCategory, intentFlags, optionalIntentArguments, dontStopAppOnReset)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
appPackage | 文字列 | アプリ名 |
appActivity | 文字列 | アクティビティ名 |
appWaitPackageオプション | 文字列 | 待機するアプリ名 |
appWaitActivityオプション | 文字列 | 待機するアクティビティ名 |
intentActionオプション | 文字列 | アクティビティの開始に使用されるインテントアクション |
intentCategoryオプション | 文字列 | アクティビティの開始に使用されるインテントカテゴリ |
intentFlagsオプション | 文字列 | アクティビティの開始に使用されるフラグ |
optionalIntentArgumentsオプション | 文字列 | アクティビティの開始に使用される追加のインテント引数 |
dontStopAppOnResetオプション | 文字列 | adbを使用してアプリを起動する前に、テスト対象アプリのプロセスを停止しません。 |
サポート
getSystemBars
ステータスバーとナビゲーションバーの表示状態と境界情報を取得します。
Appiumコマンド。詳細は、公式プロトコルドキュメントを参照してください。
使用方法
driver.getSystemBars()
戻り値
- <object[]>
systemBars: ステータスバーとナビゲーションバーの表示状態と境界に関する情報
サポート
getDeviceTime
デバイスの時刻を取得します。
Appiumコマンド。詳細は、公式プロトコルドキュメントを参照してください。
使用方法
driver.getDeviceTime()
戻り値
- <string>
time: デバイスの時刻
サポート
getDisplayDensity
デバイスからディスプレイ密度を取得します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getDisplayDensity()
戻り値
- <*>
displayDensity: 未定義
サポート
touchId
Touch IDイベントをシミュレートします（iOSシミュレータのみ）。この機能を有効にするには、allowTouchIdEnroll desired capabilityをtrueに設定し、シミュレータを登録する必要があります。allowTouchIdEnrollをtrueに設定すると、シミュレータはデフォルトで登録されます。登録状態は切り替えることができます。この呼び出しは、Appiumプロセスまたはその親アプリケーション（例：Terminal.appまたはAppium.app）が、システム環境設定 > セキュリティとプライバシー > プライバシー > アクセシビリティリストでMac OSアクセシビリティにアクセスできる場合にのみ機能します。
Appiumコマンド。詳細は、公式プロトコルドキュメントを参照してください。
使用方法
driver.touchId(match)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
match | boolean | 成功したタッチ（true）または失敗したタッチ（false）をシミュレートしますか |
サポート
toggleEnrollTouchId
シミュレータがTouch IDを受け入れるように登録されているかどうかを切り替えます（iOSシミュレータのみ）。この機能を有効にするには、allowTouchIdEnroll desired capabilityをtrueに設定する必要があります。allowTouchIdEnrollがtrueに設定されている場合、シミュレータはデフォルトで登録され、「Touch ID登録の切り替え」によって登録状態が変更されます。この呼び出しは、Appiumプロセスまたはその親アプリケーション（例：Terminal.appまたはAppium.app）が、システム環境設定 > セキュリティとプライバシー > プライバシー > アクセシビリティリストでMac OSアクセシビリティにアクセスできる場合にのみ機能します。
Appiumコマンド。詳細は、公式プロトコルドキュメントを参照してください。
使用方法
driver.toggleEnrollTouchId(enabled)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
enabledオプション | boolean | Touch ID登録を有効にする必要がある場合はtrueになります。 |
サポート
launchApp
デバイスでアプリを起動します。
Appiumコマンド。詳細は、公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは非推奨です。
iOSの場合はdriver.execute('mobile: launchApp', { ... })を使用し、Androidの場合はdriver.execute('mobile: activateApp', { ... })を使用してください。
使用方法
driver.launchApp()
サポート
closeApp
デバイスでアプリを閉じます。
Appiumコマンド。詳細は、公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは非推奨です。
代わりにdriver.execute('mobile: terminateApp', { ... })を使用してください
使用方法
driver.closeApp()
サポート
背景
このセッションで現在実行されているアプリをバックグラウンドに送ります。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは非推奨です。
代わりにdriver.execute('mobile: backgroundApp', { ... })を使用してください
使用方法
driver.background(seconds)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
seconds | 数値、null | アプリを復元するタイムアウト。'null'の場合、アプリは復元されません |
サポート
endCoverage
テストカバレッジデータを取得します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.endCoverage(intent, path)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
intent | 文字列 | ブロードキャストするintent |
path | 文字列 | .ecファイルへのパス |
サポート
getStrings
アプリの文字列を取得します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getStrings(language, stringFile)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
languageオプション | 文字列 | 言語コード |
stringFileオプション | 文字列 | 文字列ファイルへのパス |
戻り値
- <object>
appStrings: 指定された言語と文字列ファイル名に対するアプリから定義されたすべての文字列
サポート
setValueImmediate
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.setValueImmediate(elementId, text)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | 文字列 | findElement(s)への以前の呼び出しで返された要素のID |
text | 文字列 | 要素に設定するテキスト |
サポート
replaceValue
要素の値を直接置き換えます。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.replaceValue(elementId, value)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | 文字列 | findElement(s)への以前の呼び出しで返された要素のID |
value | 文字列 | 要素で置き換える値 |
サポート
getSettings
デバイスの現在の設定を取得します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getSettings()
戻り値
- <object>
settings: 現在指定されているすべての設定のJSONハッシュ、設定APIを参照
サポート
updateSettings
デバイスの現在の設定を更新します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.updateSettings(settings)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
settings | オブジェクト | 更新する設定を含むキー/値オブジェクト |
サポート
receiveAsyncResponse
JavaScriptの非同期実行のためのコールバックURL。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.receiveAsyncResponse(response)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
response | オブジェクト | デバイスで受信するレスポンス |
サポート
gsmCall
GSM通話の発信（エミュレータのみ）。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.gsmCall(phoneNumber, action)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
phoneNumber | 文字列 | 発信先の電話番号 |
action | 文字列 | アクション - 'call', 'accept', 'cancel', 'hold' |
サポート
gsmSignal
GSM信号強度を設定します（エミュレータのみ）。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.gsmSignal(signalStrength, signalStrengh)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
signalStrength | 文字列 | 信号強度（0～4の範囲） |
signalStrenghオプション | 文字列 | 信号強度（0～4の範囲）。Appium v1.11.0以前を使用する場合は、同じ値でこのパラメータも設定してください（https://github.com/appium/appium/issues/12234を参照）。 |
サポート
powerCapacity
バッテリー残量パーセンテージを設定します（エミュレータのみ）。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.powerCapacity(percent)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
percent | 数値 | パーセンテージ値（0～100の範囲） |
サポート
powerAC
バッテリー充電器の状態を接続済みまたは未接続に設定します（エミュレータのみ）。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.powerAC(state)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
state | 文字列 | 状態を設定します。onまたはoff |
サポート
gsmVoice
GSM音声状態を設定します（エミュレータのみ）。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.gsmVoice(state)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
state | 文字列 | GSM音声の状態 - 'unregistered', 'home', 'roaming', 'searching', 'denied', 'off', 'on' |
サポート
sendSms
SMSメッセージをシミュレートします（エミュレータのみ）。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.sendSms(phoneNumber, message)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
phoneNumber | 文字列 | SMSを送信する電話番号 |
message | 文字列 | SMSメッセージ |
サポート
fingerPrint
サポートされているエミュレータで、指紋スキャンを使用してユーザーを認証します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.fingerPrint(fingerprintId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
fingerprintId | 数値 | Android Keystoreシステムに保存されている指紋（1～10） |
サポート
setClipboard
システムクリップボードの内容を設定します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.setClipboard(content, contentType, label)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
content | 文字列 | 実際のコピーされたコンテンツ（Base64エンコード済み） |
contentTypeオプション | 文字列 | 取得するコンテンツの種類。Plaintext、Image、URL。AndroidはPlaintextのみサポート |
labelオプション | 文字列 | Androidのクリップボードデータラベル |
戻り値
- <string>
response: Appiumサーバーからのレスポンス
サポート
getClipboard
システムクリップボードの内容を取得します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getClipboard(contentType)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
contentTypeオプション | 文字列 | 取得するコンテンツの種類。Plaintext、Image、URL。AndroidはPlaintextのみサポート |
戻り値
- <string>
response: クリップボードの内容（Base64エンコードされた文字列）。クリップボードが空の場合は空文字列。
サポート
touchPerform
この機能はネイティブコンテキスト内でのみ使用可能です。「タッチ実行」は他の単一タッチ操作と同様に機能しますが、複数のタッチアクションを1つのコマンドとして連結できます。これは、Appiumコマンドがネットワーク経由で送信され、コマンド間に遅延があるため便利です。この遅延により、一部の操作は1つのシーケンスで実行する必要があるため、特定のタッチ操作が不可能になる可能性があります。たとえば、垂直スクロールは、押下、y座標の変更、そして解放という手順が必要です。正しく動作するには、操作間に遅延があってはなりません。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.touchPerform(actions)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
actions | object[] | 実行するアクションの種類（例：moveTo、release、press、tap、wait） |
例
// 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: {},
},
]);
サポート
multiTouchPerform
この機能はネイティブコンテキスト内でのみ使用可能です。マルチタッチアクションシーケンスを実行します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.multiTouchPerform(actions)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
actions | object[] | 実行するアクションの種類（例：moveTo、release、press、tap、wait） |
サポート
executeDriverScript
このコマンドを使用すると、WebdriverIOスクリプトを文字列として指定し、サーバー自体でのローカル実行のためにAppiumサーバーに送信できます。このアプローチは、各コマンドに関連する潜在的な遅延を最小限に抑えるのに役立ちます。Appium 2.0でこのコマンドを使用するには、execute-driver-pluginプラグインをインストールする必要があります。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.executeDriverScript(script, type, timeout)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
script | 文字列 | 実行するスクリプト。現在のサーバーにアタッチされたWebdriverIOセッションを表す「driver」オブジェクトにアクセスできます。 |
typeオプション | 文字列 | スクリプトで使用される言語/フレームワーク。現在、「webdriverio」のみサポートされており、デフォルトです。 |
timeoutオプション | 数値 | Appiumサーバーによって強制終了されるまでにスクリプトの実行が許可されるミリ秒数。デフォルトは1時間に相当します。 |
戻り値
- <object>
result: 2つのフィールドを含むオブジェクト。「result」はスクリプト自体の戻り値、「logs」は3つの内部フィールド（「log」、「warn」、「error」）を含み、スクリプトの実行中のconsole.log、console.warn、console.errorによってログされた文字列の配列を保持します。
getEvents
Appiumサーバーに保存されているイベントを取得します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getEvents(type)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
type | string[] | 種類が指定されている場合、種類でフィルタリングされたイベントを取得します。 |
戻り値
- <object>
result: イベントのJSONハッシュ（例：{'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }）。
サポート
logEvent
カスタムイベントを保存します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.logEvent(vendor, event)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
vendor | 文字列 | ベンダー名。vendor:eventのvendorになります。 |
event | 文字列 | イベント名。vendor:eventのeventになります。 |
サポート
compareImages
この機能は、OpenCVフレームワークの機能を使用して画像の比較を行います。この機能が動作するには、OpenCVフレームワークとopencv4nodejsモジュールがAppiumサーバーが動作しているマシンにインストールされている必要があります。さらに、Appium 2.0でこの機能を使用するには、images-pluginプラグインをインストールする必要があります。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.compareImages(mode, firstImage, secondImage, options)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
mode | 文字列 | 可能な比較モードの1つ：「matchFeatures」、「getSimilarity」、「matchTemplate」。デフォルトは「matchFeatures」。 |
firstImage | 文字列 | 画像データ。OpenCVライブラリ自体が受け入れるすべての画像形式がサポートされています。 |
secondImage | 文字列 | 画像データ。OpenCVライブラリ自体が受け入れるすべての画像形式がサポートされています。 |
options | オブジェクト | この辞書のコンテンツは、実際のmode値によって異なります。詳細はappium-supportモジュールのドキュメントを参照してください。 |
戻り値
- <object>
result: 結果の辞書のコンテンツは、実際のmodeとoptionsの値によって異なります。詳細はappium-supportモジュールのドキュメントを参照してください。
implicitWait
ドライバーが要素を検索する際に待つ時間を設定します。単一の要素を検索する場合、ドライバーは要素が見つかるかタイムアウト期限が切れるまでページをポーリングする必要があります。複数の要素を検索する場合、ドライバーは少なくとも1つの要素が見つかるかタイムアウト期限が切れるまでページをポーリングする必要があります。その時点で空のリストを返す必要があります。このコマンドが送信されない場合、ドライバーはデフォルトで0msの暗黙的な待機時間を使用します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.implicitWait(ms)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
ms | 数値 | 要素を待つ時間（ミリ秒）。 |
サポート
getLocationInView
スクロールして表示された後の画面上の要素の位置を特定します。
注記：これは内部コマンドとみなされ、ネイティブイベントを正しく生成するために要素の位置を特定する場合にのみ使用してください。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getLocationInView(elementId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | 文字列 | コマンドをルーティングする要素のID |
戻り値
- <Object>
location: ページ上の要素のX座標とY座標。
サポート
sendKeys
アクティブな要素にキーストロークのシーケンスを送信します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.sendKeys(value)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
value | string[] | 入力するキーのシーケンス。配列を指定する必要があります。 |
サポート
availableIMEEngines
マシン上で利用可能なすべてのIMEエンジンを一覧表示します。エンジンを使用するには、このリストに存在している必要があります。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.availableIMEEngines()
戻り値
- <String[]>
engines: 利用可能なエンジンのリスト
サポート
getActiveIMEEngine
アクティブなIMEエンジンの名前を取得します。名前文字列はプラットフォーム固有です。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getActiveIMEEngine()
戻り値
- <String>
engine: アクティブなIMEエンジンの名前
サポート
isIMEActivated
IME入力が現在アクティブかどうかを示します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.isIMEActivated()
戻り値
- <Boolean>
isActive: IME入力が利用可能で現在アクティブな場合はtrue、それ以外の場合はfalse
サポート
deactivateIMEEngine
現在アクティブなIMEエンジンを非アクティブ化します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.deactivateIMEEngine()
サポート
activateIMEEngine
利用可能なエンジンをアクティブにします。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.activateIMEEngine(engine)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
engine | 文字列 | アクティブ化するエンジンの名前 |
サポート
asyncScriptTimeout
/session/:sessionId/execute_asyncによって実行される非同期スクリプトが、中止される前に実行されることを許可される時間（ミリ秒単位）を設定します。タイムアウトエラーはクライアントに返されます。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.asyncScriptTimeout(ms)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
ms | 数値 | 時間制限付きコマンドが実行されることを許可される時間（ミリ秒単位） |
サポート
submit
フォーム要素を送信します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.submit(elementId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | 文字列 | 送信するフォーム要素のID |
サポート
getElementSize
要素のサイズをピクセル単位で決定します。サイズは、widthプロパティとheightプロパティを持つJSONオブジェクトとして返されます。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getElementSize(elementId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | 文字列 | コマンドをルーティングする要素のID |
戻り値
- <Object>
size: 要素の幅と高さ（ピクセル単位）。
サポート
getElementLocation
ページ上の要素の位置を決定します。点(0, 0)はページの左上隅を参照します。要素の座標は、xプロパティとyプロパティを持つJSONオブジェクトとして返されます。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getElementLocation(elementId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | 文字列 | コマンドをルーティングする要素のID |
戻り値
- <Object>
location: ページ上の要素のX座標とY座標。
サポート
touchClick
タッチ対応デバイスでのシングルタップ。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.touchClick(element)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
要素 | 文字列 | シングルタップする要素のID。 |
サポート
touchDown
画面への指のタッチ。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.touchDown(x, y)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
x | 数値 | 画面上のx座標 |
y | 数値 | 画面上のy座標 |
サポート
touchUp
画面からの指の離脱。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.touchUp(x, y)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
x | 数値 | 画面上のx座標 |
y | 数値 | 画面上のy座標 |
サポート
touchMove
画面上での指の移動。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.touchMove(x, y)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
x | 数値 | 画面上のx座標 |
y | 数値 | 画面上のy座標 |
サポート
touchLongClick
指の動作イベントを使用して、タッチスクリーンを長押しします。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.touchLongClick(element)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
要素 | 文字列 | 長押しする要素のID |
サポート
touchFlick
指の動作イベントを使用して、タッチスクリーンをフリックします。このフリックコマンドは、特定の画面位置から開始されます。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.touchFlick(xoffset, yoffset, element, speed, xspeed, yspeed)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
xoffsetオプション | 数値 | フリックするx方向のオフセット（ピクセル単位） |
yoffsetオプション | 数値 | フリックするy方向のオフセット（ピクセル単位） |
要素オプション | 文字列 | フリックを開始する要素のID |
speedオプション | 数値 | 速度（ピクセル/秒） |
xspeedオプション | 数値 | x方向の速度（ピクセル/秒） |
yspeedオプション | 数値 | y方向の速度（ピクセル/秒） |
サポート
getOrientation
現在のデバイスの向きを取得します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getOrientation()
戻り値
- <String>
orientation: ScreenOrientationで定義されている値に対応する現在の向き:LANDSCAPE|PORTRAIT。
サポート
setOrientation
デバイスの向きを設定します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.setOrientation(orientation)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
orientation | 文字列 | ScreenOrientationで定義されている新しいブラウザの向き: `LANDSCAPE` |
サポート
getLogs
指定されたログタイプのログを取得します。ログバッファは、各リクエスト後にリセットされます。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getLogs(type)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
type | 文字列 | ログタイプ |
戻り値
- <Object[]>
logs: ログエントリのリスト。
サポート
getLogTypes
利用可能なログタイプを取得します。
Appiumコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用方法
driver.getLogTypes()
戻り値
- <String[]>
logTypes: 使用可能なログタイプのリスト。
サポート
