Class: ServerInfo

Constructor

new ServerInfo(hostName, port, isSecure, path, credentials, query)

Represents a generic server to communicate with.

Parameters:
Name Type Argument Description
hostName string
port number
isSecure boolean
path string <optional>
credentials string <optional>
query string <optional>

Members

credentials :string

User credentials for Basic Authentication username:password

Type:
  • string

hostName :string

The server's host name. This may by a fully qualified domain name or an IP address.

Type:
  • string

isSecure :boolean

Used to determine if security is to be used for the connection to the server. Returns true is the connection is secured, otherwise false.

Type:
  • boolean

path :string

The server's path.

Type:
  • string

port :number

The server port to connect to.

Type:
  • number

query :string

Query parameters string.

Type:
  • string

Methods

getUrl(isSocket) → {string}

Builds the url from available resources and returns it.

Parameters:
Name Type Description
isSocket boolean
Returns:
{ string }
©2016 Avaya Inc. All Rights Reserved.