Module: settings/js/widgets/aci-widget

settings/js/widgets/aci-widget

Classes

AciWidget

Methods

<inner> displayValidationMessage()

Handles the results of server side validation

Source:

<inner> updateConfig(config)

Populates the widget with the given config

Parameters:
Name Type Description
config AciWidgetConfig

The new config for the widget

Source:

<protected, inner> updateInputValidation($input, isValid, message)

Updates the formatting of the given input

If isValid is true, removes errorClass from the input and hides elements with the class
settings-client-validation

If isValid is false, adds errorClass to the input and shows elements with the class
settings-client-validation

Parameters:
Name Type Description
$input jQuery

The input to apply the classes to

isValid boolean

True if the input is valid; false otherwise

message string

Validation message to display

Source:

Type Definitions

AciWidgetConfig

Properties:
Name Type Argument Description
host string

The host the server is located on

port number

The ACI port of the server

protocol string

The protocol used to communicate with the server (http or https)

productType string

The expected ProductTypeCSV of the server

indexErrorMessage string <optional>

The error message to expect when running a test index command. May be
missing if the ACI server type does not have an index port

Source:

AciWidgetOptions

Extends ServerWidgetOptions

Properties:
Name Type Description
strings AciWidgetStrings

Strings for the widget

Source:

AciWidgetStrings

Extends ServerWidgetStrings

Properties:
Name Type Description
validateHostBlank string

String which indicates that the entered host is blank

validatePortInvalid string

String which indicates that the entered port is blank, or is <= 0 or
> 65535

Source:

AciWidgetTemplateParameters

Properties:
Name Type Description
strings AciWidgetStrings

Strings for the widget

Source:

Module: settings/js/widgets/aci-widget

settings/js/widgets/aci-widget

Classes

AciWidget

Methods

<inner> displayValidationMessage()

Handles the results of server side validation

Source:

<inner> updateConfig(config)

Populates the widget with the given config

Parameters:
Name Type Description
config AciWidgetConfig

The new config for the widget

Source:

<protected, inner> updateInputValidation($input, isValid, message)

Updates the formatting of the given input

If isValid is true, removes errorClass from the input and hides elements with the class
settings-client-validation

If isValid is false, adds errorClass to the input and shows elements with the class
settings-client-validation

Parameters:
Name Type Description
$input jQuery

The input to apply the classes to

isValid boolean

True if the input is valid; false otherwise

message string

Validation message to display

Source:

Type Definitions

AciWidgetConfig

Properties:
Name Type Argument Description
host string

The host the server is located on

port number

The ACI port of the server

protocol string

The protocol used to communicate with the server (http or https)

productType string

The expected ProductTypeCSV of the server

indexErrorMessage string <optional>

The error message to expect when running a test index command. May be
missing if the ACI server type does not have an index port

Source:

AciWidgetOptions

Extends ServerWidgetOptions

Properties:
Name Type Description
strings AciWidgetStrings

Strings for the widget

Source:

AciWidgetStrings

Extends ServerWidgetStrings

Properties:
Name Type Description
validateHostBlank string

String which indicates that the entered host is blank

validatePortInvalid string

String which indicates that the entered port is blank, or is <= 0 or
> 65535

Source:

AciWidgetTemplateParameters

Properties:
Name Type Description
strings AciWidgetStrings

Strings for the widget

Source:
Copyright 2013--2018 Micro Focus International plc. Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
Documentation generated by JSDoc 3.4.3 on Fri Jun 22nd 14:40 2018 using the DocStrap template.