Skip to main content

ProxySettings class

An object used to set and retrieve the details of the proxy server used to interact with the Eyes server.

To set a proxy server, create an object of this type and pass it to the setProxy method.

ProxySettings method

Syntax

let proxySettings = new ProxySettings(proxy);

let proxySettings = new ProxySettings(url, username, password, isHttpOnly);

let proxySettings = new ProxySettings(url, username, password);

let proxySettings = new ProxySettings(url, username);

let proxySettings = new ProxySettings(url);

Parameters

proxy

Type: ProxySettingsPlain

url

Type: string

The proxy's server URI.

username

Type: string [Optional ]

The username to be sent to the proxy (default null).

password

Type: string [Optional ]

The password to be sent to the proxy (default null).

isHttpOnly

Type: boolean [Optional ]

A value of true specifies that the SDK should communicate with the server using an http tunnel. Use this if your http proxy blocks https communication.

Return value

Type: ProxySettings

getIsHttpOnly method

Syntax

let value = proxySettings.getIsHttpOnly();
value = proxySettings.getIsHttpOnly;

Note that this feature is available as both a method and a property.

Parameters

This method does not take any parameters.

Return value

Type: boolean

getPassword method

Syntax

let value = proxySettings.getPassword();
value = proxySettings.password;

Note that this feature is available as both a method and a property.

Parameters

This method does not take any parameters.

Return value

Type: string

getUri method

Syntax

let value = proxySettings.getUri();

Parameters

This method does not take any parameters.

Return value

Type: string

getUrl method

Syntax

let value = proxySettings.getUrl();
value = proxySettings.url;

Note that this feature is available as both a method and a property.

Parameters

This method does not take any parameters.

Return value

Type: string

getUsername method

Syntax

let value = proxySettings.getUsername();
value = proxySettings.username;

Note that this feature is available as both a method and a property.

Parameters

This method does not take any parameters.

Return value

Type: string