WCAP speedDIAL Class: speedDIAL

new speedDIAL(port, smsVendor, commProtocol, host) → {Object}

This is used to communicate with speedDIAL.

Parameters:

Name	Type	Description
`port`	Number	Required. Browser-based listening port on speedDIAL.
`smsVendor`	String	Required. Name of SMS vendor
`commProtocol`	String	Optional. "HTTP" or "HTTPS" communication protocol
`host`	String	Optional. Host or IP Address where speedDIAL resides.

Returns:

API's to that are used to communicate with speeedDIAL.

Type: Object

Methods

<static> connect()

Connect to speedDIAL's browser-based sms socket.

<static> createOrder(comment, orderRequest, function)

Send a create order request to speedDIAL. Usage: createOrder('Browser-base SMS', orderLines);

Parameters:

Name	Type	Description
`comment`	String	Comment for the order
`orderRequest`	OrderRequest	Order request consisting of order lines.
`function`	Object	Callback function

<static> disconnect()

Disconnect from speedDIAL browser-based sms socket.

<static> getProductQuote(productQuoteRequest, function)

Send a product quote request to speedDIAL.

Parameters:

Name	Type	Description
`productQuoteRequest`	WCAP.ProductQuoteRequest	The product to quote.
`function`	Object	Callback function

<static> isConnectedToSD() → {boolean}

Check connection to speedDIAL.

Returns:

Returns true if socket is connected to speedDIAL.

Type: boolean

<static> launchSD()

Launch speedDIAL.

<static> on()

<static> setClientProperties()

Send a set client request to speedDIAL to set the SMS caption. Usage: setClientProperties()

<static> showCatalogUsingAAIANum(showCatalogUsingAAIANumRequest)

Send a show catalog request to speedDIAL for AAIA number and category IDs.

Parameters:

Name	Type	Description
`showCatalogUsingAAIANumRequest`	WCAP.ShowCatalogUsingAAIANumRequest	The ShowCatalogUsingAAIANumRequest object containing the AAIA number and categoryID's to display in speedDIAL.

Throws:

WCAP.InvalidShowCatalogParameterException

<static> showCatalogUsingACESVehicle(acesVehicle)

Send a show catalog request to speedDIAL for ACES vehicle and categories. Usage: showCatalogUsingAcesVehicle(acesVehicle, ['B1000', 'N6'])

Parameters:

Name	Type	Description
`acesVehicle`	WCAP.ShowCatalogUsingACESVehicleRequest

Throws:

Error indicates ACES vehicle property is not set properly.
Type WCAP.InvalidShowCatalogParameterException

<static> showCatalogUsingVin(showCatalogUsingVINRequest)

Send a show catalog request to speedDIAL for specific vehicle and categories.

Parameters:

Name	Type	Description
`showCatalogUsingVINRequest`	WCAP.ShowCatalogUsingVINRequest	The ShowCatalogUsingVINRequest object containing the vehicle identification number and categoryID's to display in speedDIAL.

Throws:

WCAP.InvalidShowCatalogParameterException

<static> showPna(showPnARequest)

Send a show PNA request to speedDIAL. Usage: showPna(showPnARequest);

Parameters:

Name	Type	Description
`showPnARequest`	Object	The ShowPnARequest object that will be used to show the requested product on the PnA screen.