io.appium.java_client.android

Class AndroidMobileCommandHelper

java.lang.Object

io.appium.java_client.MobileCommand

io.appium.java_client.android.AndroidMobileCommandHelper

public class AndroidMobileCommandHelper
extends MobileCommand

This util class helps to prepare parameters of Android-specific JSONWP commands.

Field Summary

Fields inherited from class io.appium.java_client.MobileCommand

CLOSE_APP, commandRepository, COMPLEX_FIND, CURRENT_ACTIVITY, END_TEST_COVERAGE, GET_DEVICE_TIME, GET_NETWORK_CONNECTION, GET_SESSION, GET_SETTINGS, GET_STRINGS, HIDE_KEYBOARD, INSTALL_APP, IS_APP_INSTALLED, IS_LOCKED, LAUNCH_APP, LOCK, LONG_PRESS_KEY_CODE, OPEN_NOTIFICATIONS, PERFORM_MULTI_TOUCH, PERFORM_TOUCH_ACTION, PRESS_KEY_CODE, PULL_FILE, PULL_FOLDER, PUSH_FILE, REMOVE_APP, REPLACE_VALUE, RESET, RUN_APP_IN_BACKGROUND, SET_NETWORK_CONNECTION, SET_SETTINGS, SET_VALUE, SHAKE, START_ACTIVITY, TOGGLE_LOCATION_SERVICES, UNLOCK

Constructor Summary

Constructors

Constructor and Description
AndroidMobileCommandHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static Map.Entry<String,Map<String,?>>	currentActivityCommand() This method forms a Map of parameters for the getting of the current activity.
static Map.Entry<String,Map<String,?>>	endTestCoverageCommand(String intent, String path) This method forms a Map of parameters for the ending of the test coverage.
static Map.Entry<String,Map<String,?>>	getNetworkConnectionCommand() This method forms a Map of parameters for the getting of a network connection value.
static Map.Entry<String,Map<String,?>>	isLockedCommand() This method forms a Map of parameters for the checking of the device state (is it locked or not).
static Map.Entry<String,Map<String,?>>	lockDeviceCommand() This method forms a Map of parameters for the device locking.
static Map.Entry<String,Map<String,?>>	longPressKeyCodeCommand(int key) This method forms a Map of parameters for the long key event invocation.
static Map.Entry<String,Map<String,?>>	longPressKeyCodeCommand(int key, Integer metastate) This method forms a Map of parameters for the long key event invocation.
static Map.Entry<String,Map<String,?>>	openNotificationsCommand() This method forms a Map of parameters for the notification opening.
static Map.Entry<String,Map<String,?>>	pressKeyCodeCommand(int key) This method forms a Map of parameters for the key event invocation.
static Map.Entry<String,Map<String,?>>	pressKeyCodeCommand(int key, Integer metastate) This method forms a Map of parameters for the key event invocation.
static Map.Entry<String,Map<String,?>>	pushFileCommandCommand(String remotePath, byte[] base64Data) This method forms a Map of parameters for the file pushing
static Map.Entry<String,Map<String,?>>	replaceElementValueCommand(org.openqa.selenium.internal.HasIdentity hasIdentityObject, String value) This method forms a Map of parameters for the element value replacement.
static Map.Entry<String,Map<String,?>>	setConnectionCommand(Connection connection) This method forms a Map of parameters for the setting of device network connection.
static Map.Entry<String,Map<String,?>>	startActivityCommand(String appPackage, String appActivity, String appWaitPackage, String appWaitActivity, String intentAction, String intentCategory, String intentFlags, String optionalIntentArguments, boolean stopApp) This method forms a Map of parameters for the activity starting.
static Map.Entry<String,Map<String,?>>	toggleLocationServicesCommand() This method forms a Map of parameters for the toggling of location services.
static Map.Entry<String,Map<String,?>>	unlockCommand() This method forms a Map of parameters for the device unlocking.

Methods inherited from class io.appium.java_client.MobileCommand

deleteC, getC, postC, prepareArguments, prepareArguments

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AndroidMobileCommandHelper

public AndroidMobileCommandHelper()

Method Detail

currentActivityCommand

public static Map.Entry<String,Map<String,?>> currentActivityCommand()

This method forms a Map of parameters for the getting of the current activity.

Returns:

a key-value pair. The key is the command name. The value is a Map command arguments.

endTestCoverageCommand

public static Map.Entry<String,Map<String,?>> endTestCoverageCommand(String intent,
                                                     String path)

This method forms a Map of parameters for the ending of the test coverage.

Parameters:

intent - intent to broadcast.

path - path to .ec file.

Returns:

a key-value pair. The key is the command name. The value is a Map command arguments.

getNetworkConnectionCommand

public static Map.Entry<String,Map<String,?>> getNetworkConnectionCommand()

This method forms a Map of parameters for the getting of a network connection value.

Returns:

a key-value pair. The key is the command name. The value is a Map command arguments.

isLockedCommand

public static Map.Entry<String,Map<String,?>> isLockedCommand()

This method forms a Map of parameters for the checking of the device state (is it locked or not).

Returns:

a key-value pair. The key is the command name. The value is a Map command arguments.

pressKeyCodeCommand

public static Map.Entry<String,Map<String,?>> pressKeyCodeCommand(int key)

This method forms a Map 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 Map.Entry<String,Map<String,?>> pressKeyCodeCommand(int key,
                                                  Integer metastate)

This method forms a Map 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 Map.Entry<String,Map<String,?>> longPressKeyCodeCommand(int key)

This method forms a Map 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 Map.Entry<String,Map<String,?>> longPressKeyCodeCommand(int key,
                                                      Integer metastate)

This method forms a Map 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.

openNotificationsCommand

public static Map.Entry<String,Map<String,?>> openNotificationsCommand()

This method forms a Map of parameters for the notification opening.

Returns:

a key-value pair. The key is the command name. The value is a Map command arguments.

pushFileCommandCommand

public static Map.Entry<String,Map<String,?>> pushFileCommandCommand(String remotePath,
                                                     byte[] base64Data)

This method forms a Map of parameters for the file pushing

Parameters:

remotePath - Path to file to write data to on remote device

base64Data - 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.

setConnectionCommand

public static Map.Entry<String,Map<String,?>> setConnectionCommand(Connection connection)

This method forms a Map of parameters for the setting of device network connection.

Parameters:

connection - The bitmask of the desired connection

Returns:

a key-value pair. The key is the command name. The value is a Map command arguments.

startActivityCommand

public static Map.Entry<String,Map<String,?>> startActivityCommand(String appPackage,
                                                   String appActivity,
                                                   String appWaitPackage,
                                                   String appWaitActivity,
                                                   String intentAction,
                                                   String intentCategory,
                                                   String intentFlags,
                                                   String optionalIntentArguments,
                                                   boolean stopApp)
                                                            throws IllegalArgumentException

This method forms a Map of parameters for the activity starting.

Parameters:

appPackage - The package containing the activity. [Required]

appActivity - The activity to start. [Required]

appWaitPackage - Automation will begin after this package starts. [Optional]

appWaitActivity - Automation will begin after this activity starts. [Optional]

intentAction - Intent action which will be used to start activity [Optional]

intentCategory - Intent category which will be used to start activity [Optional]

intentFlags - Flags that will be used to start activity [Optional]

optionalIntentArguments - Additional intent arguments that will be used to start activity [Optional]

Returns:

a key-value pair. The key is the command name. The value is a Map command arguments.

Throws:

IllegalArgumentException - when any required argument is empty

toggleLocationServicesCommand

public static Map.Entry<String,Map<String,?>> toggleLocationServicesCommand()

This method forms a Map of parameters for the toggling of location services.

Returns:

a key-value pair. The key is the command name. The value is a Map command arguments.

unlockCommand

public static Map.Entry<String,Map<String,?>> unlockCommand()

This method forms a Map of parameters for the device unlocking.

Returns:

a key-value pair. The key is the command name. The value is a Map command arguments.

lockDeviceCommand

public static Map.Entry<String,Map<String,?>> lockDeviceCommand()

This method forms a Map of parameters for the device locking.

Returns:

a key-value pair. The key is the command name. The value is a Map command arguments.

replaceElementValueCommand

public static Map.Entry<String,Map<String,?>> replaceElementValueCommand(org.openqa.selenium.internal.HasIdentity hasIdentityObject,
                                                         String value)

This method forms a Map of parameters for the element value replacement. It is used against input elements

Parameters:

hasIdentityObject - an instance which contains an element ID

value - a new value

Returns:

a key-value pair. The key is the command name. The value is a Map command arguments.