io.appium.java_client.InteractsWithApps Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation

Java client for Appium Mobile Webdriver

There is a newer version: 9.3.0

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.appium.java_client;

public interface InteractsWithApps {
    /**
     * Launch the app which was provided in the capabilities at session creation.
     */
    void launchApp();

    /**
     * Install an app on the mobile device.
     *
     * @param appPath path to app to install.
     */
    void installApp(String appPath);

    /**
     * Checks if an app is installed on the device.
     *
     * @param bundleId bundleId of the app.
     * @return True if app is installed, false otherwise.
     */
    boolean isAppInstalled(String bundleId);

    /**
     * Reset the currently running app for this session.
     */
    void resetApp();

    /**
     * Runs the current app as a background app for the number of seconds
     * requested. This is a synchronous method, it returns after the back has
     * been returned to the foreground.
     *
     * @param seconds Number of seconds to run App in background.
     */
    void runAppInBackground(int seconds);

    /**
     * Remove the specified app from the device (uninstall).
     *
     * @param bundleId the bunble identifier (or app id) of the app to remove.
     */
    void removeApp(String bundleId);

    /**
     * Close the app which was provided in the capabilities at session creation.
     */
    void closeApp();

}