The information in this topic may be out of date. The current SDK reference guide has moved here.

ProxySettings method

Class: ProxySettingsPlatform: ImagesLanguage: JavaScript SDK:
Latest
other languages

This is the constructor for the ProxySettings class.

To initiate the use of a proxy server, create a ProxySettings object with this constructor and then pass the object to the setProxy method.

Syntax

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

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

let proxySettings = new ProxySettings(uri, username);

let proxySettings = new ProxySettings(uri);

Parameters

uri
Type:
string|boolean
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