Apryse Node SDK

Class: Proxy

PDFNet.HTML2PDF. Proxy

new Proxy()

Proxy settings to be used when loading content from web pages. Note: These Proxy settings will only be used if type is not e_default.

Extends

Members

<static> Type

Type:
  • number
Properties:
Name Type Description
e_default number
e_none number
e_http number
e_socks5 number

Methods

<static> create()

Constructor
Returns:
A promise that resolves to an object of type: "PDFNet.HTML2PDF.Proxy"
Type
Promise.<PDFNet.HTML2PDF.Proxy>

destroy()

Destructor
Inherited From:
Returns:
Type
Promise.<void>

setHost(host)

Set the proxy host to use.
Parameters:
Name Type Description
host string String defining the host name, e.g. "myserver" or "www.xxx.yyy.zzz"
Returns:
Type
Promise.<void>

setPassword(password)

Set the password to use when logging into the proxy with username
Parameters:
Name Type Description
password string The password to use, e.g. "bart".
Returns:
Type
Promise.<void>

setPort(port)

Set the port number to use
Parameters:
Name Type Description
port number A valid port number, e.g. 3128.
Returns:
Type
Promise.<void>

setType(type)

Parameters:
Name Type Description
type number 
PDFNet.HTML2PDF.Proxy.Type = {
	e_default : 0
	e_none : 1
	e_http : 2
	e_socks5 : 3
}
Returns:
Type
Promise.<void>

setUsername(username)

Set the username to use when logging into the proxy
Parameters:
Name Type Description
username string The login name, e.g. "elbarto".
Returns:
Type
Promise.<void>

takeOwnership()

Take the ownership of this object, so that PDFNet.runWithCleanup won't destroy this object.
Inherited From:
Returns:
Type
void