setProxy method

Class: EyesPlatform: ImagesLanguage: JavaScript SDK:

Use this method to configure Eyes so that it will interact with the Eyes server via a proxy.

By default, the SDK interacts directly with the Eyes server. If necessary, you can define a proxy server so that the SDK will interact with the proxy server, and the proxy server will relay the interaction to the Eyes server.

Syntax

eyes.setProxy(proxySettings);
eyes.setProxy(isEnabled);
eyes.setProxy(url, username, password);
eyes.setProxy(url, username);
eyes.setProxy(url);

Parameters

proxySettings: Type:ProxySettings; An object that defines how to connect to the proxy server by providing the user name, password, URI and port. This is an instance of the ProxySettings class.
isEnabled: Type:boolean; If this parameter is provided, then it must have a value of false, and it means that use of the proxy is disabled.
url: Type:string; The proxy URL to be used by the serverConnector. If it has a value of then no proxy is set.
username: Type:string [Optional ]; The string to pass as the username.
password: Type:string [Optional ]; The string to pass as the password.

Return value

Type: