io.appium.java_client

Interface InteractsWithApps

All Superinterfaces:

ExecutesMethod

All Known Subinterfaces:

MobileDriver<T>

All Known Implementing Classes:

AndroidDriver, AppiumDriver, IOSDriver, WindowsDriver

public interface InteractsWithApps
extends ExecutesMethod

Method Summary

Modifier and Type	Method and Description
default void	activateApp(java.lang.String bundleId) Activates the given app if it installed, but not running or if it is running in the background.
default void	activateApp(java.lang.String bundleId, BaseActivateApplicationOptions options) Activates the given app if it installed, but not running or if it is running in the background.
default void	closeApp() Close the app which was provided in the capabilities at session creation and quits the session.
default void	installApp(java.lang.String appPath) Install an app on the mobile device.
default void	installApp(java.lang.String appPath, BaseInstallApplicationOptions options) Install an app on the mobile device.
default boolean	isAppInstalled(java.lang.String bundleId) Checks if an app is installed on the device.
default void	launchApp() Launches the app, which was provided in the capabilities at session creation, and (re)starts the session.
default ApplicationState	queryAppState(java.lang.String bundleId) Queries the state of an application.
default boolean	removeApp(java.lang.String bundleId) Remove the specified app from the device (uninstall).
default boolean	removeApp(java.lang.String bundleId, BaseRemoveApplicationOptions options) Remove the specified app from the device (uninstall).
default void	resetApp() Resets the currently running app together with the session.
default void	runAppInBackground(java.time.Duration duration) Runs the current app as a background app for the time requested.
default boolean	terminateApp(java.lang.String bundleId) Terminate the particular application if it is running.
default boolean	terminateApp(java.lang.String bundleId, BaseTerminateApplicationOptions options) Terminate the particular application if it is running.

Methods inherited from interface io.appium.java_client.ExecutesMethod

execute, execute

Method Detail

launchApp

default void launchApp()

Launches the app, which was provided in the capabilities at session creation, and (re)starts the session.

installApp

default void installApp(java.lang.String appPath)

Install an app on the mobile device.

Parameters:

appPath - path to app to install.

installApp

default void installApp(java.lang.String appPath,
                        @Nullable
                        BaseInstallApplicationOptions options)

Install an app on the mobile device.

Parameters:

appPath - path to app to install or a remote URL.

options - Set of the corresponding instllation options for the particular platform.

isAppInstalled

default boolean isAppInstalled(java.lang.String bundleId)

Checks if an app is installed on the device.

Parameters:

bundleId - bundleId of the app.

Returns:

True if app is installed, false otherwise.

resetApp

default void resetApp()

Resets the currently running app together with the session.

runAppInBackground

default void runAppInBackground(java.time.Duration duration)

Runs the current app as a background app for the time requested. This is a synchronous method, it returns after the back has been returned to the foreground.

Parameters:

duration - The time to run App in background. Minimum time resolution is one second

removeApp

default boolean removeApp(java.lang.String bundleId)

Remove the specified app from the device (uninstall).

Parameters:

bundleId - the bundle identifier (or app id) of the app to remove.

Returns:

true if the uninstall was successful.

removeApp

default boolean removeApp(java.lang.String bundleId,
                          @Nullable
                          BaseRemoveApplicationOptions options)

Remove the specified app from the device (uninstall).

Parameters:

bundleId - the bundle identifier (or app id) of the app to remove.

options - the set of uninstall options supported by the particular platform.

Returns:

true if the uninstall was successful.

closeApp

default void closeApp()

Close the app which was provided in the capabilities at session creation and quits the session.

activateApp

default void activateApp(java.lang.String bundleId)

Activates the given app if it installed, but not running or if it is running in the background.

Parameters:

bundleId - the bundle identifier (or app id) of the app to activate.

activateApp

default void activateApp(java.lang.String bundleId,
                         @Nullable
                         BaseActivateApplicationOptions options)

Activates the given app if it installed, but not running or if it is running in the background.

Parameters:

bundleId - the bundle identifier (or app id) of the app to activate.

options - the set of activation options supported by the particular platform.

queryAppState

default ApplicationState queryAppState(java.lang.String bundleId)

Queries the state of an application.

Parameters:

bundleId - the bundle identifier (or app id) of the app to query the state of.

Returns:

one of possible ApplicationState values,

terminateApp

default boolean terminateApp(java.lang.String bundleId)

Terminate the particular application if it is running.

Parameters:

bundleId - the bundle identifier (or app id) of the app to be terminated.

Returns:

true if the app was running before and has been successfully stopped.

terminateApp

default boolean terminateApp(java.lang.String bundleId,
                             @Nullable
                             BaseTerminateApplicationOptions options)

Terminate the particular application if it is running.

Parameters:

bundleId - the bundle identifier (or app id) of the app to be terminated.

options - the set of termination options supported by the particular platform.

Returns:

true if the app was running before and has been successfully stopped.