Package org.openqa.selenium.safari

Class SafariOptions

  • All Implemented Interfaces:
    org.openqa.selenium.Capabilities
    public class SafariOptions
extends org.openqa.selenium.remote.AbstractDriverOptions<SafariOptions>
    Class to manage options specific to SafariDriver.

    Example usage: 

    
 SafariOptions options = new SafariOptions()
 options.setUseTechnologyPreview(true);

 // For use with SafariDriver:
 SafariDriver driver = new SafariDriver(options);

 // For use with RemoteWebDriver:
 RemoteWebDriver driver = new RemoteWebDriver(
     new URL("http://localhost:4444/"),
     options);

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String CAPABILITY
      Deprecated.
      No replacement.

    • Constructor Summary

      Constructors 
      Constructor Description
      SafariOptions()  
      SafariOptions​(org.openqa.selenium.Capabilities source)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected int amendHashCode()  
      java.util.Map<java.lang.String,​java.lang.Object> asMap()  
      static SafariOptions fromCapabilities​(org.openqa.selenium.Capabilities capabilities)
      Construct a SafariOptions instance from given capabilities.
      boolean getAutomaticInspection()  
      boolean getAutomaticProfiling()  
      boolean getUseTechnologyPreview()  
      SafariOptions merge​(org.openqa.selenium.Capabilities extraCapabilities)  
      SafariOptions setAutomaticInspection​(boolean automaticInspection)
      Instruct the SafariDriver to enable the Automatic Inspection if true, otherwise disable the automatic inspection.
      SafariOptions setAutomaticProfiling​(boolean automaticProfiling)
      Instruct the SafariDriver to enable the Automatic profiling if true, otherwise disable the automatic profiling.
      SafariOptions setUseTechnologyPreview​(boolean useTechnologyPreview)
      Instruct the SafariDriver to use the Safari Technology Preview if true, otherwise use the release version of Safari.

      • Methods inherited from class org.openqa.selenium.remote.AbstractDriverOptions

        setAcceptInsecureCerts, setPageLoadStrategy, setProxy, setStrictFileInteractability, setUnhandledPromptBehaviour

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

        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

    • Field Detail

      • CAPABILITY

        @Deprecated
public static final java.lang.String CAPABILITY
        Deprecated.
        No replacement. Use the methods on this class
        Key used to store SafariOptions in a Capabilities object.
        See Also:
        Constant Field Values

    • Constructor Detail

      • SafariOptions

        public SafariOptions()

      • SafariOptions

        public SafariOptions​(org.openqa.selenium.Capabilities source)

    • Method Detail

      • merge

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

      • fromCapabilities

        public static SafariOptions fromCapabilities​(org.openqa.selenium.Capabilities capabilities)
                                      throws org.openqa.selenium.WebDriverException
        Construct a SafariOptions instance from given capabilities. When the CAPABILITY capability is set, all other capabilities will be ignored!
        Parameters:
        capabilities - Desired capabilities from which the options are derived.
        Returns:
        SafariOptions
        Throws:
        org.openqa.selenium.WebDriverException - If an error occurred during the reconstruction of the options

      • setAutomaticInspection

        public SafariOptions setAutomaticInspection​(boolean automaticInspection)
        Instruct the SafariDriver to enable the Automatic Inspection if true, otherwise disable the automatic inspection. Defaults to disabling the automatic inspection.
        Parameters:
        automaticInspection - If true, the SafariDriver will enable the Automation Inspection, otherwise will disable.

      • setAutomaticProfiling

        public SafariOptions setAutomaticProfiling​(boolean automaticProfiling)
        Instruct the SafariDriver to enable the Automatic profiling if true, otherwise disable the automatic profiling. Defaults to disabling the automatic profiling.
        Parameters:
        automaticProfiling - If true, the SafariDriver will enable the Automation Profiling, otherwise will disable.

      • setUseTechnologyPreview

        public SafariOptions setUseTechnologyPreview​(boolean useTechnologyPreview)
        Instruct the SafariDriver to use the Safari Technology Preview if true, otherwise use the release version of Safari. Defaults to using the release version of Safari.
        Parameters:
        useTechnologyPreview - If true, the SafariDriver will use the Safari Technology Preview, otherwise will use the release version of Safari.

      • getAutomaticInspection

        public boolean getAutomaticInspection()

      • getAutomaticProfiling

        public boolean getAutomaticProfiling()

      • getUseTechnologyPreview

        public boolean getUseTechnologyPreview()

      • amendHashCode

        protected int amendHashCode()
        Overrides:
        amendHashCode in class org.openqa.selenium.MutableCapabilities

      • asMap

        public java.util.Map<java.lang.String,​java.lang.Object> asMap()
        Specified by:
        asMap in interface org.openqa.selenium.Capabilities
        Overrides:
        asMap in class org.openqa.selenium.MutableCapabilities