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