Package io.appium.java_client
Class MobileCommand
- java.lang.Object
-
- io.appium.java_client.MobileCommand
-
- Direct Known Subclasses:
AndroidMobileCommandHelper
,IOSMobileCommandHelper
public class MobileCommand extends java.lang.Object
The repository of mobile commands defined in the Mobile JSON wire protocol.
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.String
ACTIVATE_APP
static java.lang.String
CLOSE_APP
static java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo>
commandRepository
protected static java.lang.String
COMPARE_IMAGES
protected static java.lang.String
CURRENT_ACTIVITY
protected static java.lang.String
END_TEST_COVERAGE
protected static java.lang.String
EXECUTE_DRIVER_SCRIPT
protected static java.lang.String
EXECUTE_GOOGLE_CDP_COMMAND
protected static java.lang.String
FINGER_PRINT
protected static java.lang.String
GET_ALLSESSION
static java.lang.String
GET_CLIPBOARD
protected static java.lang.String
GET_CURRENT_PACKAGE
protected static java.lang.String
GET_DEVICE_TIME
protected static java.lang.String
GET_DISPLAY_DENSITY
protected static java.lang.String
GET_EVENTS
protected static java.lang.String
GET_NETWORK_CONNECTION
protected static java.lang.String
GET_PERFORMANCE_DATA
protected static java.lang.String
GET_SESSION
protected static java.lang.String
GET_SETTINGS
protected static java.lang.String
GET_STRINGS
protected static java.lang.String
GET_SUPPORTED_PERFORMANCE_DATA_TYPES
protected static java.lang.String
GET_SYSTEM_BARS
protected static java.lang.String
GSM_CALL
protected static java.lang.String
GSM_SIGNAL
protected static java.lang.String
GSM_VOICE
protected static java.lang.String
HIDE_KEYBOARD
protected static java.lang.String
INSTALL_APP
protected static java.lang.String
IS_APP_INSTALLED
protected static java.lang.String
IS_KEYBOARD_SHOWN
protected static java.lang.String
IS_LOCKED
static java.lang.String
LAUNCH_APP
protected static java.lang.String
LOCK
protected static java.lang.String
LOG_EVENT
static java.lang.String
LONG_PRESS_KEY_CODE
protected static java.lang.String
NETWORK_SPEED
protected static java.lang.String
OPEN_NOTIFICATIONS
protected static java.lang.String
PERFORM_MULTI_TOUCH
protected static java.lang.String
PERFORM_TOUCH_ACTION
protected static java.lang.String
POWER_AC_STATE
protected static java.lang.String
POWER_CAPACITY
static java.lang.String
PRESS_KEY_CODE
protected static java.lang.String
PULL_FILE
protected static java.lang.String
PULL_FOLDER
protected static java.lang.String
PUSH_FILE
protected static java.lang.String
QUERY_APP_STATE
protected static java.lang.String
REMOVE_APP
static java.lang.String
REPLACE_VALUE
protected static java.lang.String
RESET
static java.lang.String
RUN_APP_IN_BACKGROUND
protected static java.lang.String
SEND_SMS
static java.lang.String
SET_CLIPBOARD
protected static java.lang.String
SET_NETWORK_CONNECTION
protected static java.lang.String
SET_SETTINGS
static java.lang.String
SET_VALUE
protected static java.lang.String
SHAKE
protected static java.lang.String
START_ACTIVITY
static java.lang.String
START_RECORDING_SCREEN
static java.lang.String
STOP_RECORDING_SCREEN
protected static java.lang.String
TERMINATE_APP
protected static java.lang.String
TOGGLE_AIRPLANE_MODE
protected static java.lang.String
TOGGLE_DATA
protected static java.lang.String
TOGGLE_LOCATION_SERVICES
protected static java.lang.String
TOGGLE_WIFI
protected static java.lang.String
TOUCH_ID
protected static java.lang.String
TOUCH_ID_ENROLLMENT
protected static java.lang.String
UNLOCK
-
Constructor Summary
Constructors Constructor Description MobileCommand()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
compareImagesCommand(ComparisonMode mode, byte[] img1Data, byte[] img2Data, BaseComparisonOptions options)
Forms aMap
of parameters for images comparison.static AppiumCommandInfo
deleteC(java.lang.String url)
This methods forms DELETE commands.static AppiumCommandInfo
getC(java.lang.String url)
This methods forms GET commands.static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
getIsDeviceLockedCommand()
This method forms aMap
of parameters for the device locked query.static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
getSettingsCommand()
static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
hideKeyboardCommand(java.lang.String keyName)
This method forms aMap
of parameters for the keyboard hiding.static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
hideKeyboardCommand(java.lang.String strategy, java.lang.String keyName)
This method forms aMap
of parameters for the keyboard hiding.static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
isKeyboardShownCommand()
This method forms aMap
of parameters for the checking of the keyboard state (is it shown or not).static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
lockDeviceCommand(java.time.Duration duration)
This method forms aMap
of parameters for the device locking.static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
longPressKeyCodeCommand(int key)
This method forms aMap
of parameters for the long key event invocation.static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
longPressKeyCodeCommand(int key, java.lang.Integer metastate)
This method forms aMap
of parameters for the long key event invocation.static AppiumCommandInfo
postC(java.lang.String url)
This methods forms POST commands.static com.google.common.collect.ImmutableMap<java.lang.String,java.lang.Object>
prepareArguments(java.lang.String[] params, java.lang.Object[] values)
Prepares collection of arguments.static com.google.common.collect.ImmutableMap<java.lang.String,java.lang.Object>
prepareArguments(java.lang.String param, java.lang.Object value)
Prepares single argument.static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
pressKeyCodeCommand(int key)
This method forms aMap
of parameters for the key event invocation.static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
pressKeyCodeCommand(int key, java.lang.Integer metastate)
This method forms aMap
of parameters for the key event invocation.static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
pushFileCommand(java.lang.String remotePath, byte[] base64Data)
This method forms aMap
of parameters for the file pushing.static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
setSettingsCommand(java.lang.String setting, java.lang.Object value)
static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
setSettingsCommand(java.util.Map<java.lang.String,java.lang.Object> settings)
static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
startRecordingScreenCommand(BaseStartScreenRecordingOptions opts)
static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
stopRecordingScreenCommand(BaseStopScreenRecordingOptions opts)
static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>>
unlockDeviceCommand()
This method forms aMap
of parameters for the device unlocking.
-
-
-
Field Detail
-
RESET
protected static final java.lang.String RESET
-
GET_STRINGS
protected static final java.lang.String GET_STRINGS
-
SET_VALUE
public static final java.lang.String SET_VALUE
-
PULL_FILE
protected static final java.lang.String PULL_FILE
-
PULL_FOLDER
protected static final java.lang.String PULL_FOLDER
-
RUN_APP_IN_BACKGROUND
public static final java.lang.String RUN_APP_IN_BACKGROUND
-
PERFORM_TOUCH_ACTION
protected static final java.lang.String PERFORM_TOUCH_ACTION
-
PERFORM_MULTI_TOUCH
protected static final java.lang.String PERFORM_MULTI_TOUCH
-
LAUNCH_APP
public static final java.lang.String LAUNCH_APP
-
CLOSE_APP
public static final java.lang.String CLOSE_APP
-
GET_DEVICE_TIME
protected static final java.lang.String GET_DEVICE_TIME
-
GET_SESSION
protected static final java.lang.String GET_SESSION
-
LOG_EVENT
protected static final java.lang.String LOG_EVENT
-
GET_EVENTS
protected static final java.lang.String GET_EVENTS
-
IS_APP_INSTALLED
protected static final java.lang.String IS_APP_INSTALLED
-
INSTALL_APP
protected static final java.lang.String INSTALL_APP
-
ACTIVATE_APP
protected static final java.lang.String ACTIVATE_APP
-
QUERY_APP_STATE
protected static final java.lang.String QUERY_APP_STATE
-
TERMINATE_APP
protected static final java.lang.String TERMINATE_APP
-
REMOVE_APP
protected static final java.lang.String REMOVE_APP
-
GET_CLIPBOARD
public static final java.lang.String GET_CLIPBOARD
-
SET_CLIPBOARD
public static final java.lang.String SET_CLIPBOARD
-
GET_PERFORMANCE_DATA
protected static final java.lang.String GET_PERFORMANCE_DATA
-
GET_SUPPORTED_PERFORMANCE_DATA_TYPES
protected static final java.lang.String GET_SUPPORTED_PERFORMANCE_DATA_TYPES
-
START_RECORDING_SCREEN
public static final java.lang.String START_RECORDING_SCREEN
-
STOP_RECORDING_SCREEN
public static final java.lang.String STOP_RECORDING_SCREEN
-
HIDE_KEYBOARD
protected static final java.lang.String HIDE_KEYBOARD
-
LOCK
protected static final java.lang.String LOCK
-
SHAKE
protected static final java.lang.String SHAKE
-
TOUCH_ID
protected static final java.lang.String TOUCH_ID
-
TOUCH_ID_ENROLLMENT
protected static final java.lang.String TOUCH_ID_ENROLLMENT
-
CURRENT_ACTIVITY
protected static final java.lang.String CURRENT_ACTIVITY
-
END_TEST_COVERAGE
protected static final java.lang.String END_TEST_COVERAGE
-
GET_DISPLAY_DENSITY
protected static final java.lang.String GET_DISPLAY_DENSITY
-
GET_NETWORK_CONNECTION
protected static final java.lang.String GET_NETWORK_CONNECTION
-
GET_SYSTEM_BARS
protected static final java.lang.String GET_SYSTEM_BARS
-
IS_KEYBOARD_SHOWN
protected static final java.lang.String IS_KEYBOARD_SHOWN
-
IS_LOCKED
protected static final java.lang.String IS_LOCKED
-
LONG_PRESS_KEY_CODE
public static final java.lang.String LONG_PRESS_KEY_CODE
-
FINGER_PRINT
protected static final java.lang.String FINGER_PRINT
-
OPEN_NOTIFICATIONS
protected static final java.lang.String OPEN_NOTIFICATIONS
-
PRESS_KEY_CODE
public static final java.lang.String PRESS_KEY_CODE
-
PUSH_FILE
protected static final java.lang.String PUSH_FILE
-
SET_NETWORK_CONNECTION
protected static final java.lang.String SET_NETWORK_CONNECTION
-
START_ACTIVITY
protected static final java.lang.String START_ACTIVITY
-
TOGGLE_LOCATION_SERVICES
protected static final java.lang.String TOGGLE_LOCATION_SERVICES
-
UNLOCK
protected static final java.lang.String UNLOCK
-
REPLACE_VALUE
public static final java.lang.String REPLACE_VALUE
-
GET_SETTINGS
protected static final java.lang.String GET_SETTINGS
-
SET_SETTINGS
protected static final java.lang.String SET_SETTINGS
-
GET_CURRENT_PACKAGE
protected static final java.lang.String GET_CURRENT_PACKAGE
-
SEND_SMS
protected static final java.lang.String SEND_SMS
-
GSM_CALL
protected static final java.lang.String GSM_CALL
-
GSM_SIGNAL
protected static final java.lang.String GSM_SIGNAL
-
GSM_VOICE
protected static final java.lang.String GSM_VOICE
-
NETWORK_SPEED
protected static final java.lang.String NETWORK_SPEED
-
POWER_CAPACITY
protected static final java.lang.String POWER_CAPACITY
-
POWER_AC_STATE
protected static final java.lang.String POWER_AC_STATE
-
TOGGLE_WIFI
protected static final java.lang.String TOGGLE_WIFI
-
TOGGLE_AIRPLANE_MODE
protected static final java.lang.String TOGGLE_AIRPLANE_MODE
-
TOGGLE_DATA
protected static final java.lang.String TOGGLE_DATA
-
COMPARE_IMAGES
protected static final java.lang.String COMPARE_IMAGES
-
EXECUTE_DRIVER_SCRIPT
protected static final java.lang.String EXECUTE_DRIVER_SCRIPT
-
GET_ALLSESSION
protected static final java.lang.String GET_ALLSESSION
-
EXECUTE_GOOGLE_CDP_COMMAND
protected static final java.lang.String EXECUTE_GOOGLE_CDP_COMMAND
-
commandRepository
public static final java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> commandRepository
-
-
Method Detail
-
getC
public static AppiumCommandInfo getC(java.lang.String url)
This methods forms GET commands.- Parameters:
url
- is the command URL- Returns:
- an instance of
CommandInfo
-
postC
public static AppiumCommandInfo postC(java.lang.String url)
This methods forms POST commands.- Parameters:
url
- is the command URL- Returns:
- an instance of
CommandInfo
-
deleteC
public static AppiumCommandInfo deleteC(java.lang.String url)
This methods forms DELETE commands.- Parameters:
url
- is the command URL- Returns:
- an instance of
CommandInfo
-
hideKeyboardCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> hideKeyboardCommand(java.lang.String keyName)
This method forms aMap
of parameters for the keyboard hiding.- Parameters:
keyName
- The button pressed by the mobile driver to attempt hiding the keyboard.- Returns:
- a key-value pair. The key is the command name. The value is a
Map
command arguments.
-
hideKeyboardCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> hideKeyboardCommand(java.lang.String strategy, java.lang.String keyName)
This method forms aMap
of parameters for the keyboard hiding.- Parameters:
strategy
- HideKeyboardStrategy.keyName
- a String, representing the text displayed on the button of the keyboard you want to press. For example: "Done".- Returns:
- a key-value pair. The key is the command name. The value is a
Map
command arguments.
-
prepareArguments
public static com.google.common.collect.ImmutableMap<java.lang.String,java.lang.Object> prepareArguments(java.lang.String param, java.lang.Object value)
Prepares single argument.- Parameters:
param
- is a parameter name.value
- is the parameter value.- Returns:
- built
ImmutableMap
.
-
prepareArguments
public static com.google.common.collect.ImmutableMap<java.lang.String,java.lang.Object> prepareArguments(java.lang.String[] params, java.lang.Object[] values)
Prepares collection of arguments.- Parameters:
params
- is the array with parameter names.values
- is the array with parameter values.- Returns:
- built
ImmutableMap
.
-
pressKeyCodeCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> pressKeyCodeCommand(int key)
This method forms aMap
of parameters for the key event invocation.- Parameters:
key
- code for the key pressed on the device.- Returns:
- a key-value pair. The key is the command name. The value is a
Map
command arguments.
-
pressKeyCodeCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> pressKeyCodeCommand(int key, java.lang.Integer metastate)
This method forms aMap
of parameters for the key event invocation.- Parameters:
key
- code for the key pressed on the Android device.metastate
- metastate for the keypress.- Returns:
- a key-value pair. The key is the command name. The value is a
Map
command arguments.
-
longPressKeyCodeCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> longPressKeyCodeCommand(int key)
This method forms aMap
of parameters for the long key event invocation.- Parameters:
key
- code for the long key pressed on the device.- Returns:
- a key-value pair. The key is the command name. The value is a
Map
command arguments.
-
longPressKeyCodeCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> longPressKeyCodeCommand(int key, java.lang.Integer metastate)
This method forms aMap
of parameters for the long key event invocation.- Parameters:
key
- code for the long key pressed on the Android device.metastate
- metastate for the long key press.- Returns:
- a key-value pair. The key is the command name. The value is a
Map
command arguments.
-
lockDeviceCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> lockDeviceCommand(java.time.Duration duration)
This method forms aMap
of parameters for the device locking.- Parameters:
duration
- for how long to lock the screen for. Minimum time resolution is one second- Returns:
- a key-value pair. The key is the command name. The value is a
Map
command arguments.
-
unlockDeviceCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> unlockDeviceCommand()
This method forms aMap
of parameters for the device unlocking.- Returns:
- a key-value pair. The key is the command name. The value is a
Map
command arguments.
-
getIsDeviceLockedCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> getIsDeviceLockedCommand()
This method forms aMap
of parameters for the device locked query.- Returns:
- a key-value pair. The key is the command name. The value is a
Map
command arguments.
-
getSettingsCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> getSettingsCommand()
-
setSettingsCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> setSettingsCommand(java.lang.String setting, java.lang.Object value)
-
setSettingsCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> setSettingsCommand(java.util.Map<java.lang.String,java.lang.Object> settings)
-
pushFileCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> pushFileCommand(java.lang.String remotePath, byte[] base64Data)
This method forms aMap
of parameters for the file pushing.- Parameters:
remotePath
- Path to file to write data to on remote devicebase64Data
- Base64 encoded byte array of data to write to remote device- Returns:
- a key-value pair. The key is the command name. The value is a
Map
command arguments.
-
startRecordingScreenCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> startRecordingScreenCommand(BaseStartScreenRecordingOptions opts)
-
stopRecordingScreenCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> stopRecordingScreenCommand(BaseStopScreenRecordingOptions opts)
-
compareImagesCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> compareImagesCommand(ComparisonMode mode, byte[] img1Data, byte[] img2Data, @Nullable BaseComparisonOptions options)
Forms aMap
of parameters for images comparison.- Parameters:
mode
- one of possible comparison modesimg1Data
- base64-encoded data of the first imageimg2Data
- base64-encoded data of the second imageoptions
- comparison options- Returns:
- key-value pairs
-
isKeyboardShownCommand
public static java.util.Map.Entry<java.lang.String,java.util.Map<java.lang.String,?>> isKeyboardShownCommand()
This method forms aMap
of parameters for the checking of the keyboard state (is it shown or not).- Returns:
- a key-value pair. The key is the command name. The value is a
Map
command arguments.
-
-