Package io.appium.java_client.remote

Class MobileOptions<T extends MobileOptions<T>>

  • Type Parameters:
    T - The child class for a proper chaining.
    All Implemented Interfaces:
    java.io.Serializable, org.openqa.selenium.Capabilities
    Direct Known Subclasses:
    AndroidOptions, IOSOptions
    @Deprecated
public class MobileOptions<T extends MobileOptions<T>>
extends org.openqa.selenium.MutableCapabilities
    Deprecated.
    Use the specific options class for your driver, for example XCUITestOptions or UiAutomator2Options.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      MobileOptions()
      Deprecated.
      Creates new instance with no preset capabilities.
      MobileOptions​(org.openqa.selenium.Capabilities source)
      Deprecated.
      Creates new instance with provided capabilities capabilities.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      protected T amend​(java.lang.String optionName, java.lang.Object value)
      Deprecated.
       
      boolean doesAutoWebview()
      Deprecated.
      Get whether the app moves directly into Webview context.
      boolean doesClearSystemFiles()
      Deprecated.
      Get whether the app deletes generated files at the end of a session.
      boolean doesEventTimings()
      Deprecated.
      Get whether the app reports the timings for various Appium-internal events.
      boolean doesFullReset()
      Deprecated.
      Get whether the app does a full reset.
      boolean doesNoReset()
      Deprecated.
      Get whether the app does not do a reset.
      boolean doesPrintPageSourceOnFindFailure()
      Deprecated.
      Get whether the app to print page source when a find operation fails.
      java.lang.String getApp()
      Deprecated.
      Get the app location.
      java.lang.String getAutomationName()
      Deprecated.
      Get the automation engine to use.
      java.lang.String getDeviceName()
      Deprecated.
      Get the name of the device.
      java.lang.String getLanguage()
      Deprecated.
      Get language abbreviation for use in session.
      java.lang.String getLocale()
      Deprecated.
      Get locale abbreviation for use in session.
      java.time.Duration getNewCommandTimeout()
      Deprecated.
      Get the timeout for new commands.
      org.openqa.selenium.ScreenOrientation getOrientation()
      Deprecated.
      Get the orientation of the screen.
      java.lang.String getOtherApps()
      Deprecated.
      Get the list of apps to install before running a test.
      java.lang.String getPlatformVersion()
      Deprecated.
      Get the version of the platform.
      java.lang.String getUdid()
      Deprecated.
      Get the id of the device.
      boolean isEnablePerformanceLogging()
      Deprecated.
      Get the app logs performance.
      T merge​(org.openqa.selenium.Capabilities extraCapabilities)
      Deprecated.
       
      T setApp​(java.lang.String path)
      Deprecated.
      Set the absolute local path for the location of the App.
      T setApp​(java.net.URL url)
      Deprecated.
      Set the remote http URL for the location of the App.
      T setAutomationName​(java.lang.String name)
      Deprecated.
      Set the automation engine to use.
      T setAutoWebview()
      Deprecated.
      Set the app to move directly into Webview context.
      T setAutoWebview​(boolean bool)
      Deprecated.
      Set whether the app moves directly into Webview context.
      T setClearSystemFiles()
      Deprecated.
      Set the app to delete any generated files at the end of a session.
      T setClearSystemFiles​(boolean bool)
      Deprecated.
      Set whether the app deletes generated files at the end of a session.
      T setDeviceName​(java.lang.String deviceName)
      Deprecated.
      Set the name of the device.
      T setEnablePerformanceLogging()
      Deprecated.
      Set the app to enable performance logging.
      T setEnablePerformanceLogging​(boolean bool)
      Deprecated.
      Set whether the app logs performance.
      T setEventTimings()
      Deprecated.
      Set the app to report the timings for various Appium-internal events.
      T setEventTimings​(boolean bool)
      Deprecated.
      Set whether the app reports the timings for various Appium-internal events.
      T setFullReset()
      Deprecated.
      Set the app to do a full reset.
      T setFullReset​(boolean bool)
      Deprecated.
      Set whether the app does a full reset.
      T setLanguage​(java.lang.String language)
      Deprecated.
      Set language abbreviation for use in session.
      T setLocale​(java.lang.String locale)
      Deprecated.
      Set locale abbreviation for use in session.
      T setNewCommandTimeout​(java.time.Duration duration)
      Deprecated.
      Set the timeout for new commands.
      T setNoReset()
      Deprecated.
      Set the app not to do a reset.
      T setNoReset​(boolean bool)
      Deprecated.
      Set whether the app does not do a reset.
      T setOrientation​(org.openqa.selenium.ScreenOrientation orientation)
      Deprecated.
      Set the orientation of the screen.
      T setOtherApps​(java.lang.String apps)
      Deprecated.
      Set the location of the app(s) to install before running a test.
      T setPlatformName​(java.lang.String platform)
      Deprecated.
      Set the kind of mobile device or emulator to use.
      T setPlatformVersion​(java.lang.String version)
      Deprecated.
      Set the version of the platform.
      T setPrintPageSourceOnFindFailure()
      Deprecated.
      Set the app to print page source when a find operation fails.
      T setPrintPageSourceOnFindFailure​(boolean bool)
      Deprecated.
      Set whether the app to print page source when a find operation fails.
      T setUdid​(java.lang.String id)
      Deprecated.
      Set the id of the device.

      • Methods inherited from class org.openqa.selenium.MutableCapabilities

        asMap, equals, getCapability, getCapabilityNames, hashCode, setCapability, setCapability, setCapability, setCapability, toJson, toString

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface org.openqa.selenium.Capabilities

        getBrowserName, getBrowserVersion, getPlatform, getPlatformName, getVersion, is

    • Constructor Detail

      • MobileOptions

        public MobileOptions()
        Deprecated.
        Creates new instance with no preset capabilities.

      • MobileOptions

        public MobileOptions​(org.openqa.selenium.Capabilities source)
        Deprecated.
        Creates new instance with provided capabilities capabilities.
        Parameters:
        source - is Capabilities instance to merge into new instance

    • Method Detail

      • setPlatformName

        public T setPlatformName​(java.lang.String platform)
        Deprecated.
        Set the kind of mobile device or emulator to use.
        Parameters:
        platform - the kind of mobile device or emulator to use.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        CapabilityType.PLATFORM_NAME

      • setApp

        public T setApp​(java.lang.String path)
        Deprecated.
        Set the absolute local path for the location of the App. The or remote http URL to a .ipa file (IOS),
        Parameters:
        path - is a String representing the location of the App
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.APP

      • setApp

        public T setApp​(java.net.URL url)
        Deprecated.
        Set the remote http URL for the location of the App.
        Parameters:
        url - is the URL representing the location of the App
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.APP

      • getApp

        public java.lang.String getApp()
        Deprecated.
        Get the app location.
        Returns:
        String representing app location
        See Also:
        MobileCapabilityType.APP

      • setAutomationName

        public T setAutomationName​(java.lang.String name)
        Deprecated.
        Set the automation engine to use.
        Parameters:
        name - is the name of the automation engine
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.AUTOMATION_NAME

      • getAutomationName

        public java.lang.String getAutomationName()
        Deprecated.
        Get the automation engine to use.
        Returns:
        String representing the name of the automation engine
        See Also:
        MobileCapabilityType.AUTOMATION_NAME

      • setAutoWebview

        public T setAutoWebview()
        Deprecated.
        Set the app to move directly into Webview context.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.AUTO_WEBVIEW

      • setAutoWebview

        public T setAutoWebview​(boolean bool)
        Deprecated.
        Set whether the app moves directly into Webview context.
        Parameters:
        bool - is whether the app moves directly into Webview context.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.AUTO_WEBVIEW

      • doesAutoWebview

        public boolean doesAutoWebview()
        Deprecated.
        Get whether the app moves directly into Webview context.
        Returns:
        true if app moves directly into Webview context.
        See Also:
        MobileCapabilityType.AUTO_WEBVIEW

      • setClearSystemFiles

        public T setClearSystemFiles()
        Deprecated.
        Set the app to delete any generated files at the end of a session.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.CLEAR_SYSTEM_FILES

      • setClearSystemFiles

        public T setClearSystemFiles​(boolean bool)
        Deprecated.
        Set whether the app deletes generated files at the end of a session.
        Parameters:
        bool - is whether the app deletes generated files at the end of a session.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.CLEAR_SYSTEM_FILES

      • doesClearSystemFiles

        public boolean doesClearSystemFiles()
        Deprecated.
        Get whether the app deletes generated files at the end of a session.
        Returns:
        true if the app deletes generated files at the end of a session.
        See Also:
        MobileCapabilityType.CLEAR_SYSTEM_FILES

      • setDeviceName

        public T setDeviceName​(java.lang.String deviceName)
        Deprecated.
        Set the name of the device.
        Parameters:
        deviceName - is the name of the device.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.DEVICE_NAME

      • getDeviceName

        public java.lang.String getDeviceName()
        Deprecated.
        Get the name of the device.
        Returns:
        String representing the name of the device.
        See Also:
        MobileCapabilityType.DEVICE_NAME

      • setEnablePerformanceLogging

        public T setEnablePerformanceLogging​(boolean bool)
        Deprecated.
        Set whether the app logs performance.
        Parameters:
        bool - is whether the app logs performance.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.ENABLE_PERFORMANCE_LOGGING

      • setEventTimings

        public T setEventTimings()
        Deprecated.
        Set the app to report the timings for various Appium-internal events.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.EVENT_TIMINGS

      • setEventTimings

        public T setEventTimings​(boolean bool)
        Deprecated.
        Set whether the app reports the timings for various Appium-internal events.
        Parameters:
        bool - is whether the app enables event timings.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.EVENT_TIMINGS

      • doesEventTimings

        public boolean doesEventTimings()
        Deprecated.
        Get whether the app reports the timings for various Appium-internal events.
        Returns:
        true if the app reports event timings.
        See Also:
        MobileCapabilityType.EVENT_TIMINGS

      • setFullReset

        public T setFullReset()
        Deprecated.
        Set the app to do a full reset.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.FULL_RESET

      • setFullReset

        public T setFullReset​(boolean bool)
        Deprecated.
        Set whether the app does a full reset.
        Parameters:
        bool - is whether the app does a full reset.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.FULL_RESET

      • doesFullReset

        public boolean doesFullReset()
        Deprecated.
        Get whether the app does a full reset.
        Returns:
        true if the app does a full reset.
        See Also:
        MobileCapabilityType.FULL_RESET

      • setLanguage

        public T setLanguage​(java.lang.String language)
        Deprecated.
        Set language abbreviation for use in session.
        Parameters:
        language - is the language abbreviation.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.LANGUAGE

      • getLanguage

        public java.lang.String getLanguage()
        Deprecated.
        Get language abbreviation for use in session.
        Returns:
        String representing the language abbreviation.
        See Also:
        MobileCapabilityType.LANGUAGE

      • setLocale

        public T setLocale​(java.lang.String locale)
        Deprecated.
        Set locale abbreviation for use in session.
        Parameters:
        locale - is the locale abbreviation.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.LOCALE

      • getLocale

        public java.lang.String getLocale()
        Deprecated.
        Get locale abbreviation for use in session.
        Returns:
        String representing the locale abbreviation.
        See Also:
        MobileCapabilityType.LOCALE

      • setNewCommandTimeout

        public T setNewCommandTimeout​(java.time.Duration duration)
        Deprecated.
        Set the timeout for new commands.
        Parameters:
        duration - is the allowed time before seeing a new command.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.NEW_COMMAND_TIMEOUT

      • getNewCommandTimeout

        public java.time.Duration getNewCommandTimeout()
        Deprecated.
        Get the timeout for new commands.
        Returns:
        allowed time before seeing a new command.
        See Also:
        MobileCapabilityType.NEW_COMMAND_TIMEOUT

      • setNoReset

        public T setNoReset()
        Deprecated.
        Set the app not to do a reset.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.NO_RESET

      • setNoReset

        public T setNoReset​(boolean bool)
        Deprecated.
        Set whether the app does not do a reset.
        Parameters:
        bool - is whether the app does not do a reset.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.NO_RESET

      • doesNoReset

        public boolean doesNoReset()
        Deprecated.
        Get whether the app does not do a reset.
        Returns:
        true if the app does not do a reset.
        See Also:
        MobileCapabilityType.NO_RESET

      • setOrientation

        public T setOrientation​(org.openqa.selenium.ScreenOrientation orientation)
        Deprecated.
        Set the orientation of the screen.
        Parameters:
        orientation - is the screen orientation.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.ORIENTATION

      • getOrientation

        public org.openqa.selenium.ScreenOrientation getOrientation()
        Deprecated.
        Get the orientation of the screen.
        Returns:
        ScreenOrientation of the app.
        See Also:
        MobileCapabilityType.ORIENTATION

      • setOtherApps

        public T setOtherApps​(java.lang.String apps)
        Deprecated.
        Set the location of the app(s) to install before running a test.
        Parameters:
        apps - is the apps to install.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.OTHER_APPS

      • getOtherApps

        public java.lang.String getOtherApps()
        Deprecated.
        Get the list of apps to install before running a test.
        Returns:
        String of apps to install.
        See Also:
        MobileCapabilityType.OTHER_APPS

      • setPlatformVersion

        public T setPlatformVersion​(java.lang.String version)
        Deprecated.
        Set the version of the platform.
        Parameters:
        version - is the platform version.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.PLATFORM_VERSION

      • getPlatformVersion

        public java.lang.String getPlatformVersion()
        Deprecated.
        Get the version of the platform.
        Returns:
        String representing the platform version.
        See Also:
        MobileCapabilityType.PLATFORM_VERSION

      • setPrintPageSourceOnFindFailure

        public T setPrintPageSourceOnFindFailure​(boolean bool)
        Deprecated.
        Set whether the app to print page source when a find operation fails.
        Parameters:
        bool - is whether to print page source.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.PRINT_PAGE_SOURCE_ON_FIND_FAILURE

      • doesPrintPageSourceOnFindFailure

        public boolean doesPrintPageSourceOnFindFailure()
        Deprecated.
        Get whether the app to print page source when a find operation fails.
        Returns:
        true if app prints page source.
        See Also:
        MobileCapabilityType.PRINT_PAGE_SOURCE_ON_FIND_FAILURE

      • setUdid

        public T setUdid​(java.lang.String id)
        Deprecated.
        Set the id of the device.
        Parameters:
        id - is the unique device identifier.
        Returns:
        this MobileOptions, for chaining.
        See Also:
        MobileCapabilityType.UDID

      • getUdid

        public java.lang.String getUdid()
        Deprecated.
        Get the id of the device.
        Returns:
        String representing the unique device identifier.
        See Also:
        MobileCapabilityType.UDID

      • merge

        public T merge​(org.openqa.selenium.Capabilities extraCapabilities)
        Deprecated.
        Specified by:
        merge in interface org.openqa.selenium.Capabilities
        Overrides:
        merge in class org.openqa.selenium.MutableCapabilities

      • amend

        protected T amend​(java.lang.String optionName,
                  java.lang.Object value)
        Deprecated.