Set proxy settings and properties for scripted monitors

Sets a proxy server to be used for all per-URL requests (HTTP, HTTPS, and FTP).

Additional notes:

• The port is optional. If not provided, it will be derived from the scheme. For example, for HTTP the port would be 80.

• The username and password are assumed to be the result of a call to encodeURIComponent(). Special characters like @ and : in the username and/or the password must be escaped.

  Returns

  This method returns a Promise that will resolve once the configuration has been applied.

  Parameters

  Parameter	Data Type	Description
  proxyURL | proxyUrlParsed	String or Object	The URL to connect to the proxy server. A string containing a proxyURL (for example, http://proxy_host:8888) or a plain object in the same format as defined by Node's url.parse(urlString) method.

  Examples

  An example of setting a proxy server with HTTP protocol on port 1234 with no authentication:

  $network.setProxy('http://host.com:1234')

  Copy

  An example of setting a proxy server with HTTP protocol with authentication credentials.

  $network.setProxy('http://proxyUsername:proxyPassword@proxyHost:1234')

  Copy

Sets a proxy server to be used for all HTTP requests.

Additional notes:

• The port is optional. If not provided, it will be derived from the scheme. For example, for HTTP the port would be 80.

• The username and password are assumed to be the result of a call to encodeURIComponent(). Special characters like @ and : in the username and/or the password must be escaped.

  Returns

  This method returns a Promise that will resolve once the configuration has been applied.

  Parameters

  Parameter	Data Type	Description
  proxyURL | proxyUrlParsed	String or Object	The URL to connect to the proxy server. A string containing a proxyURL (for example, http://proxy_host:8888) or a plain object in the same format as defined by Node's url.parse(urlString) method.

  Examples

  An example of setting a proxy server with HTTP protocol on port 1234 with no authentication:

  $network.setProxyForHttp('http://host.com:1234')

  Copy

  An example of setting a proxy server with HTTP protocol with authentication credentials.

  $network.setProxyForHttp('http://proxyUsername:proxyPassword@proxyHost:1234')

  Copy

Sets a proxy server to be used for all HTTPS requests.

Additional notes:

• The port is optional. If not provided, it will be derived from the scheme. For example, for HTTP the default port would be 443.

• The username and password are assumed to be the result of a call to encodeURIComponent(). Special characters like @ and : in the username and/or the password must be escaped.

  Returns

  This method returns a Promise that will resolve once the configuration has been applied.

  Parameters

  Parameter	Data Type	Description
  proxyURL | proxyUrlParsed	String or Object	The URL to connect to the proxy server. A string containing a proxyURL (for example, http://proxy_host:8888) or a plain object in the same format as defined by Node's url.parse(urlString) method.

  Examples

  An example of setting a proxy server with HTTPS protocol on port 1234 with no authentication:

  $network.setProxyForHttps('https://host.com:1234')

  Copy

  An example of setting a proxy server with HTTPS protocol with authentication credentials.

  $network.setProxyForHttps('https://proxyUsername:proxyPassword@proxyHost:1234')

  Copy

Sets a proxy server via a proxy auto-config (PAC) script and returns a promise. This function is only available for scripted browser monitors.

var authCredentialsMap = {
  "example.com": { username: "authUsername", password: "authPassword" },
};

var authCredentialsMap = {
  "example.com": { username: "authUsername", password: "authPassword" },
  "anotherExample.com": { username: "authUsername", password: "authPassword" },
};

$network.setProxyPAC("https://www.example.com/pacScript", authCredentialsMap);

Sets the proxy configuration using the format supported by Chrome Extension API for Proxying. The input is a ProxyRules object, as defined by the Chrome Extension API to configures proxies. You can add authCredentials for proxies that need it. See Parameters for more details.

var proxyRules = {
  singleProxy: {
    host: "example.com",
    authCredentials: {
      username: "authUsername",
      password: "authPassword",
    },
  },
};

var proxyRules = {
  singleProxy: { host: "entproxy.mycompany.com", port: 8888, scheme: "http" },
  bypassList: ["s3.amazonaws.com", "*.localcdn.com"],
};
$network.setProxyAdvanced(proxyRules);

Clears/removes the current proxy configuration.

This method returns the current proxy configuration. It must be synchronized in a promise callback.

var assert = require("assert");

$network
  .setProxy("http://user:password@myproxyurl.com")
  .then(function () {
    console.log("Proxy configuration applied");

    // Note: $network.getProxy() is not synchronized with the webdriver Control Flow.
    // To make sure we get the proxy configuration after the call to setProxy() above
    // succeeds we need to use a promise callback
    var proxyData = $network.getProxy();
    console.log(proxyData);
  })
  .then(function () {
    // Again: getProxy() is not synchronized with the Webdriver Control Flow: we
    // need this promise callback otherwise clearProxy() might be called before the call
    // to getProxy() above returns
    return $network.clearProxy();
  })
  .then(function () {
    console.log("Proxy configuration cleared");

    // We need this promise callback for reasons explained above
    var proxyData = $network.getProxy();
    assert.equal(proxyData.rules, null);
  });