ConnectionSettings( regmethod, server, port, server, user, activationcode, protocol, password, urlsuffix ) method

Represents the connection settings for connecting to the SUP Server.

Used in hwc.loadSettings and hwc.saveSettings.

Syntax

<static> ConnectionSettings( regmethod, server, port, server, user, activationcode, protocol, password, urlsuffix )

Parameters

Name Type Description
regmethod number A number representing the registration method (must be one of hwc.REGISTRATION_METHOD_NO_PREFERENCE, hwc.REGISTRATION_METHOD_MANUAL, hwc.REGISTRATION_METHOD_AUTOMATIC, hwc.REGISTRATION_METHOD_AFARIA, hwc.REGISTRATION_METHOD_CERTIFICATE).
server string The SUP/Relay server name.
port number The SUP/Relay server port number.
server string The farm id.
user string The user name.
activationcode string The activation code.
protocol string The protocol to use.Must be "HTTP" or "HTTPS".
password string The password for automatic registration.
urlsuffix string The url suffix (used only when connecting to a relay server).

Example

// Create a new ConnectionSettings object.
var connectionSettings = new hwc.ConnectionSettings( hwc.REGISTRATION_METHOD_MANUAL,
                                           "999.999.999.999",
                                           5001,
                                           0,
                                           "sampleUsername",
                                           123,
                                           "HTTP",
                                           "samplePassword",
                                           "/" );
// Use the ConnectionSettings object we just created to set the connection settings.
hwc.saveSettings( connectionSettings );

Source

hwc-api.js, line 79.